v10

latestSwagger 2.0raw.githubusercontent.com2021-02-05141544.2 KB
Services

Creates or updates a Search service in the given resource group. If the Search service already exists, all properties will be updated with the given values.

put/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}

Path parameters

resourceGroupNamestring required

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

searchServiceNamestring required

The name of the Azure Cognitive Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net). You cannot change the service name after the service is created.

subscriptionIdstring required

The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.

Query parameters

api-versionstring required

The API version to use for each request. The current version is 2015-08-19.

Headers

x-ms-client-request-idstring uuid

A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Request body

idstring

The ID of the resource. This can be used with the Azure Resource Manager to link resources together.

namestring

The name of the resource.

typestring

The resource type.

locationstring

The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.

tagsobject

Tags to help categorize the resource in the Azure portal.

Response

The existing service definition was successfully updated. If you changed the number of replicas or partitions, the scale operation will happen asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.

idstring

The ID of the resource. This can be used with the Azure Resource Manager to link resources together.

namestring

The name of the resource.

typestring

The resource type.

locationstring

The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.

tagsobject

Tags to help categorize the resource in the Azure portal.