swagger: '2.0' info: title: Microsoft Azure SearchManagementClient description: >- Client that can be used to manage Azure Cognitive Search services and API keys. version: 2021-04-01-preview host: management.azure.com schemes: - https consumes: - application/json produces: - application/json security: - azure_auth: - user_impersonation securityDefinitions: azure_auth: type: oauth2 authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize flow: implicit description: Azure Active Directory OAuth2 Flow scopes: user_impersonation: impersonate your user account paths: /providers/Microsoft.Search/operations: get: tags: - Operations description: >- Lists all of the available REST API operations of the Microsoft.Search provider. operationId: microsoftAzureOperationsList x-ms-examples: SearchListOperations: $ref: ./examples/SearchListOperations.json parameters: - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success. The response describes the list of operations. schema: $ref: '#/definitions/OperationListResult' default: description: Operations API failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: summary: Microsoft Azure Get Providers Microsoft Search Operations ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys : post: tags: - AdminKeys operationId: microsoftAzureAdminkeysGet x-ms-examples: SearchGetAdminKeys: $ref: ./examples/SearchGetAdminKeys.json description: >- Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The admin keys were successfully retrieved and are in the response. You can use either the primary or secondary key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform any operations on your search service, including privileged operations. Privileged operations include managing resources like indexes and data sources as well as uploading, modifying, or deleting data in your indexes. schema: $ref: '#/definitions/AdminKeyResult' default: description: >- HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Listadminkeys ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind} : post: tags: - AdminKeys operationId: microsoftAzureAdminkeysRegenerate x-ms-examples: SearchRegenerateAdminKey: $ref: ./examples/SearchRegenerateAdminKey.json description: >- Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - name: keyKind in: path required: true type: string enum: - primary - secondary x-ms-enum: name: AdminKeyKind modelAsString: false values: - value: primary name: Primary description: The primary API key for the search service. - value: secondary name: Secondary description: The secondary API key for the search service. description: >- Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The specified admin key was successfully regenerated. Both admin keys are included in the response, including the newly-regenerated key. schema: $ref: '#/definitions/AdminKeyResult' default: description: >- HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Regenerateadminkey Keykind ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name} : post: tags: - QueryKeys operationId: microsoftAzureQuerykeysCreate x-ms-examples: SearchCreateQueryKey: $ref: ./examples/SearchCreateQueryKey.json description: >- Generates a new query key for the specified search service. You can create up to 50 query keys per service. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - name: name in: path required: true type: string description: The name of the new query API key. - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The query key was successfully created and is in the response. You can use the query key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID. schema: $ref: '#/definitions/QueryKey' default: description: >- HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Createquerykey Name ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys : post: tags: - QueryKeys x-ms-pageable: nextLinkName: nextLink operationId: microsoftAzureQuerykeysListbysearchservice x-ms-examples: SearchListQueryKeysBySearchService: $ref: ./examples/SearchListQueryKeysBySearchService.json description: >- Returns the list of query API keys for the given Azure Cognitive Search service. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- All query keys for the given search service were successfully retrieved and are in the response. You can use any of the query keys as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID. schema: $ref: '#/definitions/ListQueryKeysResult' default: description: >- HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Listquerykeys ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key} : delete: tags: - QueryKeys operationId: microsoftAzureQuerykeysDelete x-ms-examples: SearchDeleteQueryKey: $ref: ./examples/SearchDeleteQueryKey.json description: >- Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - name: key in: path required: true type: string description: >- The query key to be deleted. Query keys are identified by value, not by name. - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: The query key was successfully deleted. '204': description: The query key was successfully deleted. '404': description: >- The subscription, resource group, search service, or query key could not be found. default: description: 'HTTP 409 (Conflict): The specified subscription is disabled.' schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Deletequerykey Key ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName} : put: tags: [] operationId: microsoftAzureServicesCreateorupdate x-ms-examples: SearchCreateOrUpdateService: $ref: ./examples/SearchCreateOrUpdateService.json SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs: $ref: >- ./examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass: $ref: >- ./examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass.json SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints: $ref: >- ./examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json SearchCreateOrUpdateServiceWithIdentity: $ref: ./examples/SearchCreateOrUpdateServiceWithIdentity.json SearchCreateOrUpdateServiceAuthOptions: $ref: ./examples/SearchCreateOrUpdateServiceAuthOptions.json SearchCreateOrUpdateServiceDisableLocalAuth: $ref: ./examples/SearchCreateOrUpdateServiceDisableLocalAuth.json SearchCreateOrUpdateServiceWithCmkEnforcement: $ref: ./examples/SearchCreateOrUpdateServiceWithCmkEnforcement.json SearchCreateOrUpdateServiceWithDataExfiltration: $ref: ./examples/SearchCreateOrUpdateServiceWithDataExfiltration.json SearchCreateOrUpdateWithSemanticSearch: $ref: ./examples/SearchCreateOrUpdateWithSemanticSearch.json description: >- 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. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - name: searchServiceName in: path required: true type: string description: >- 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://.search.windows.net). You cannot change the service name after the service is created. - name: service in: body required: true schema: $ref: '#/definitions/SearchService' description: The definition of the search service to create or update. - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- 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. schema: $ref: '#/definitions/SearchService' '201': description: >- If you requested creation of a free search service, the service is now provisioned and ready to use, subject to DNS propagation delay. For other SKU types, provisioning happens asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property. schema: $ref: '#/definitions/SearchService' default: description: >- HTTP 400 (Bad Request): The given service name or service definition is invalid; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription or resource group could not be found. HTTP 409 (Conflict): The specified subscription is disabled. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename patch: tags: [] operationId: microsoftAzureServicesUpdate x-ms-examples: SearchUpdateService: $ref: ./examples/SearchUpdateService.json SearchUpdateServiceToRemoveIdentity: $ref: ./examples/SearchUpdateServiceToRemoveIdentity.json SearchUpdateServiceToAllowAccessFromPublicCustomIPs: $ref: ./examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass: $ref: >- ./examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass.json SearchUpdateServiceToAllowAccessFromPrivateEndpoints: $ref: ./examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json SearchUpdateServiceAuthOptions: $ref: ./examples/SearchUpdateServiceAuthOptions.json SearchUpdateServiceDisableLocalAuth: $ref: ./examples/SearchUpdateServiceDisableLocalAuth.json SearchUpdateServiceWithCmkEnforcement: $ref: ./examples/SearchUpdateServiceWithCmkEnforcement.json SearchUpdateServiceWithDataExfiltration: $ref: ./examples/SearchUpdateServiceWithDataExfiltration.json SearchUpdateServiceWithSemanticSearch: $ref: ./examples/SearchUpdateServiceWithSemanticSearch.json description: Updates an existing search service in the given resource group. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - name: searchServiceName in: path required: true type: string description: The name of the Azure Cognitive Search service to update. - name: service in: body required: true schema: $ref: '#/definitions/SearchServiceUpdate' description: The definition of the search service to update. - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- 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. schema: $ref: '#/definitions/SearchService' default: description: >- HTTP 400 (Bad Request): The given service definition is invalid or you attempted to change a property that is immutable; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription or resource group could not be found. HTTP 409 (Conflict): The specified subscription is disabled. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename get: tags: [] operationId: microsoftAzureServicesGet x-ms-examples: SearchGetService: $ref: ./examples/SearchGetService.json description: Gets the search service with the given name in the given resource group. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The search service definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property. schema: $ref: '#/definitions/SearchService' default: description: >- HTTP 404 (Not Found): The subscription, resource group, or search service name could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename delete: tags: [] operationId: microsoftAzureServicesDelete x-ms-examples: SearchDeleteService: $ref: ./examples/SearchDeleteService.json description: >- Deletes a search service in the given resource group, along with its associated resources. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: The search service was successfully deleted. '204': description: The search service was successfully deleted. '404': description: >- The subscription, resource group, or search service could not be found. default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices: get: tags: [] x-ms-pageable: nextLinkName: nextLink operationId: microsoftAzureServicesListbyresourcegroup x-ms-examples: SearchListServicesByResourceGroup: $ref: ./examples/SearchListServicesByResourceGroup.json description: Gets a list of all Search services in the given resource group. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The operation succeeded. The response contains the list of all search service definitions for the given resource group. schema: $ref: '#/definitions/SearchServiceListResult' default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources : get: tags: - PrivateLinkResources x-ms-pageable: nextLinkName: operationId: microsoftAzurePrivatelinkresourcesListsupported x-ms-examples: ListSupportedPrivateLinkResources: $ref: ./examples/ListSupportedPrivateLinkResources.json description: >- Gets a list of all supported private link resource types for the given service. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' responses: '200': description: >- The operation succeeded. The response contains the list of all supported private link resource types for the given service. schema: $ref: '#/definitions/PrivateLinkResourcesResult' default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName} : put: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsUpdate x-ms-examples: PrivateEndpointConnectionUpdate: $ref: ./examples/UpdatePrivateEndpointConnection.json description: >- Updates a Private Endpoint connection to the search service in the given resource group. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter' - name: privateEndpointConnection in: body required: true schema: $ref: '#/definitions/PrivateEndpointConnection' description: The definition of the private endpoint connection to update. - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The existing private endpoint connection definition was successfully updated. schema: $ref: '#/definitions/PrivateEndpointConnection' default: description: >- HTTP 400 (Bad Request): The given private endpoint connection name or the private endpoint connection definition is invalid; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription, resource group, search service or private endpoint connection could not be found. HTTP 409 (Conflict): The specified subscription is disabled. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Privateendpointconnections Privateendpointconnectionname get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsGet x-ms-examples: PrivateEndpointConnectionGet: $ref: ./examples/GetPrivateEndpointConnection.json description: >- Gets the details of the private endpoint connection to the search service in the given resource group. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The definition of the private endpoint connection was successfully retrieved and is in the response. schema: $ref: '#/definitions/PrivateEndpointConnection' default: description: >- HTTP 404 (Not Found): The subscription, resource group, search service or private endpoint connection could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsDelete x-ms-examples: PrivateEndpointConnectionDelete: $ref: ./examples/DeletePrivateEndpointConnection.json description: >- Disconnects the private endpoint connection and deletes it from the search service. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The private endpoint connection was successfully disconnected and removed from the search service. The response will contain the updated definition of the private endpoint connection. schema: $ref: '#/definitions/PrivateEndpointConnection' '404': description: >- The subscription, resource group, search service or private endpoint connection could not be found. default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections x-ms-pageable: nextLinkName: nextLink operationId: microsoftAzurePrivateendpointconnectionsListbyservice x-ms-examples: ListPrivateEndpointConnectionsByService: $ref: ./examples/ListPrivateEndpointConnectionsByService.json description: Gets a list of all private endpoint connections in the given service. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' responses: '200': description: >- The operation succeeded. The response contains the list of all private endpoint connections for the given service. schema: $ref: '#/definitions/PrivateEndpointConnectionListResult' default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} : put: tags: - SharedPrivateLinkResources operationId: microsoftAzureSharedprivatelinkresourcesCreateorupdate x-ms-examples: SharedPrivateLinkResourceCreateOrUpdate: $ref: ./examples/CreateOrUpdateSharedPrivateLinkResource.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation description: >- Initiates the creation or update of a shared private link resource managed by the search service in the given resource group. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/SharedPrivateLinkResourceNameParameter' - name: sharedPrivateLinkResource in: body required: true schema: $ref: '#/definitions/SharedPrivateLinkResource' description: >- The definition of the shared private link resource to create or update. - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The details of the shared private link resource that was created or updated. schema: $ref: '#/definitions/SharedPrivateLinkResource' '202': description: >- The shared private link resource create or update operation has been accepted and will complete asynchronously. default: description: >- HTTP 400 (Bad Request): The given shared private link resource name or the shared private link resource definition is invalid; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription, resource group, search service or shared private link resource could not be found. HTTP 409 (Conflict): The specified subscription is disabled. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Sharedprivatelinkresources Sharedprivatelinkresourcename get: tags: - SharedPrivateLinkResources operationId: microsoftAzureSharedprivatelinkresourcesGet x-ms-examples: SharedPrivateLinkResourceGet: $ref: ./examples/GetSharedPrivateLinkResource.json description: >- Gets the details of the shared private link resource managed by the search service in the given resource group. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/SharedPrivateLinkResourceNameParameter' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The definition of the shared private link resource was successfully retrieved and is in the response. schema: $ref: '#/definitions/SharedPrivateLinkResource' default: description: >- HTTP 404 (Not Found): The subscription, resource group, search service or shared private link resource could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Sharedprivatelinkresources Sharedprivatelinkresourcename delete: tags: - SharedPrivateLinkResources operationId: microsoftAzureSharedprivatelinkresourcesDelete x-ms-examples: SharedPrivateLinkResourceDelete: $ref: ./examples/DeleteSharedPrivateLinkResource.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation description: >- Initiates the deletion of the shared private link resource from the search service. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/SharedPrivateLinkResourceNameParameter' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '202': description: >- The shared private link resource deletion operation was accepted and will complete asynchronously. '204': description: >- The backing private endpoint for the shared private link resource could not be found. '404': description: >- The subscription, resource group, search service or shared private link resource could not be found. default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Sharedprivatelinkresources Sharedprivatelinkresourcename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources : get: tags: - SharedPrivateLinkResources x-ms-pageable: nextLinkName: nextLink operationId: microsoftAzureSharedprivatelinkresourcesListbyservice x-ms-examples: ListSharedPrivateLinkResourcesByService: $ref: ./examples/ListSharedPrivateLinkResourcesByService.json description: >- Gets a list of all shared private link resources managed by the given service. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/SearchServiceNameParameter' responses: '200': description: >- The operation succeeded. The response contains the list of all shared private link resources managed by the given service. schema: $ref: '#/definitions/SharedPrivateLinkResourceListResult' default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Sharedprivatelinkresources /subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices: get: tags: [] x-ms-pageable: nextLinkName: nextLink operationId: microsoftAzureServicesListbysubscription x-ms-examples: SearchListServicesBySubscription: $ref: ./examples/SearchListServicesBySubscription.json description: Gets a list of all Search services in the given subscription. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The operation succeeded. The response contains the list of all search service definitions for the given subscription. schema: $ref: '#/definitions/SearchServiceListResult' default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Search Searchservices /subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability: post: tags: [] description: >- Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). externalDocs: url: https://aka.ms/search-manage operationId: microsoftAzureServicesChecknameavailability x-ms-examples: SearchCheckNameAvailability: $ref: ./examples/SearchCheckNameAvailability.json parameters: - name: checkNameAvailabilityInput in: body description: The resource name and type to check. x-ms-client-flatten: true required: true schema: $ref: '#/definitions/CheckNameAvailabilityInput' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: >- The name check completed. The response contains details of whether the name is valid and available. If the name is invalid, the response also contains a message explaining why not. schema: $ref: '#/definitions/CheckNameAvailabilityOutput' default: description: >- HTTP 400 (Bad Request): The given resource type is not 'searchServices'. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Search Checknameavailability definitions: CheckNameAvailabilityInput: type: object required: - name - type properties: name: description: >- The search service name to validate. 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. type: string type: description: >- The type of the resource whose name is to be validated. This value must always be 'searchServices'. type: string enum: - searchServices x-ms-enum: name: ResourceType modelAsString: false values: - value: searchServices name: SearchServices description: >- 'searchServices' is the only resource type whose name can be validated. description: Input of check name availability API. CheckNameAvailabilityOutput: type: object properties: nameAvailable: x-ms-client-name: IsNameAvailable description: A value indicating whether the name is available. type: boolean readOnly: true reason: description: >- The reason why the name is not available. 'Invalid' indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). 'AlreadyExists' indicates that the name is already in use and is therefore unavailable. type: string readOnly: true enum: - Invalid - AlreadyExists x-ms-enum: name: UnavailableNameReason modelAsString: true values: - value: Invalid name: Invalid description: The search service name does not match naming requirements. - value: AlreadyExists name: AlreadyExists description: >- The search service name is already assigned to a different search service. message: description: >- A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property. type: string readOnly: true description: Output of check name availability API. AdminKeyResult: properties: primaryKey: readOnly: true type: string description: The primary admin API key of the search service. secondaryKey: readOnly: true type: string description: The secondary admin API key of the search service. description: >- Response containing the primary and secondary admin API keys for a given Azure Cognitive Search service. QueryKey: properties: name: readOnly: true type: string description: The name of the query API key; may be empty. key: readOnly: true type: string description: The value of the query API key. description: >- Describes an API key for a given Azure Cognitive Search service that has permissions for query operations only. ListQueryKeysResult: properties: value: readOnly: true type: array items: $ref: '#/definitions/QueryKey' description: The query keys for the Azure Cognitive Search service. nextLink: readOnly: true type: string description: >- Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. description: >- Response containing the query API keys for a given Azure Cognitive Search service. x-ms-external: true Sku: properties: name: type: string description: >- The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.' enum: - free - basic - standard - standard2 - standard3 - storage_optimized_l1 - storage_optimized_l2 x-ms-enum: name: SkuName modelAsString: true values: - value: free name: Free description: >- Free tier, with no SLA guarantees and a subset of features offered to paid tiers. - value: basic name: Basic description: Paid tier dedicated service with up to 3 replicas. - value: standard name: Standard description: >- Paid tier dedicated service with up to 12 partitions and 12 replicas. - value: standard2 name: Standard2 description: Similar to 'standard', but with more capacity per search unit. - value: standard3 name: Standard3 description: ' The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to ''highDensity'').' - value: storage_optimized_l1 name: StorageOptimizedL1 description: >- Paid tier dedicated service that supports 1TB per partition, up to 12 partitions. - value: storage_optimized_l2 name: StorageOptimizedL2 description: >- Paid tier dedicated service that supports 2TB per partition, up to 12 partitions. description: >- Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits. externalDocs: url: https://azure.microsoft.com/documentation/articles/search-sku-tier/ DataPlaneAuthOptions: properties: apiKeyOnly: type: object properties: {} description: Indicates that only the API key needs to be used for authentication. aadOrApiKey: $ref: '#/definitions/DataPlaneAadOrApiKeyAuthOption' description: >- Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. description: >- Defines the options for how the data plane API of a Search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. DataPlaneAadOrApiKeyAuthOption: properties: aadAuthFailureMode: type: string description: >- Describes what response the data plane API of a Search service would send for requests that failed authentication. enum: - http403 - http401WithBearerChallenge x-ms-enum: name: AadAuthFailureMode modelAsString: false values: - value: http403 name: Http403 description: >- Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden). - value: http401WithBearerChallenge name: Http401WithBearerChallenge description: >- Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge. description: >- Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. DisabledDataExfiltrationOption: type: string enum: - All x-ms-enum: name: SearchDisabledDataExfiltrationOption modelAsString: true values: - value: All name: All description: Indicates that all data exfiltration scenarios are disabled. description: A specific data exfiltration scenario that is disabled for the service. EncryptionWithCmk: type: object properties: enforcement: description: >- Describes how a search service should enforce having one or more non customer encrypted resources. type: string enum: - Disabled - Enabled - Unspecified x-ms-enum: name: SearchEncryptionWithCmk modelAsString: false values: - value: Disabled name: Disabled description: >- No enforcement will be made and the search service can have non customer encrypted resources. - value: Enabled name: Enabled description: >- Search service will be marked as non-compliant if there are one or more non customer encrypted resources. - value: Unspecified name: Unspecified description: >- Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'. encryptionComplianceStatus: readOnly: true description: >- Describes whether the search service is compliant or not with respect to having non customer encrypted resources. If a service has more than one non customer encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'. type: string enum: - Compliant - NonCompliant x-ms-enum: name: SearchEncryptionComplianceStatus modelAsString: false values: - value: Compliant name: Compliant description: >- Indicates that the search service is compliant, either because number of non customer encrypted resources is zero or enforcement is disabled. - value: NonCompliant name: NonCompliant description: >- Indicates that the search service has more than 1 non customer encrypted resources. description: >- Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys. PrivateEndpointConnection: properties: properties: $ref: '#/definitions/PrivateEndpointConnectionProperties' description: >- Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. allOf: - $ref: >- ../../../../../common-types/resource-management/v2/types.json#/definitions/Resource description: >- Describes an existing Private Endpoint connection to the Azure Cognitive Search service. NetworkRuleSet: properties: ipRules: type: array description: >- A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. items: $ref: '#/definitions/IpRule' bypass: type: string enum: - None - AzurePortal x-ms-enum: name: SearchBypass modelAsString: true values: - value: None name: None description: >- Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. - value: AzurePortal name: AzurePortal description: >- Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. description: >- Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. description: >- Network specific rules that determine how the Azure Cognitive Search service may be reached. IpRule: properties: value: type: string description: >- Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed. description: The IP restriction rule of the Azure Cognitive Search service. PrivateEndpointConnectionProperties: properties: privateEndpoint: properties: id: type: string description: >- The resource id of the private endpoint resource from Microsoft.Network provider. description: The private endpoint resource from Microsoft.Network provider. privateLinkServiceConnectionState: type: object properties: status: type: string description: >- Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. enum: - Pending - Approved - Rejected - Disconnected x-ms-enum: name: PrivateLinkServiceConnectionStatus modelAsString: false values: - value: Pending name: Pending description: >- The private endpoint connection has been created and is pending approval. - value: Approved name: Approved description: >- The private endpoint connection is approved and is ready for use. - value: Rejected name: Rejected description: >- The private endpoint connection has been rejected and cannot be used. - value: Disconnected name: Disconnected description: >- The private endpoint connection has been removed from the service. description: type: string description: The description for the private link service connection state. actionsRequired: type: string description: A description of any extra actions that may be required. default: None description: >- Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. description: >- Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. PrivateEndpointConnectionListResult: properties: value: readOnly: true type: array items: $ref: '#/definitions/PrivateEndpointConnection' description: The list of Private Endpoint connections. nextLink: readOnly: true type: string description: >- Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. description: Response containing a list of Private Endpoint connections. x-ms-external: true SemanticSearch: type: string enum: - disabled - free - standard x-ms-enum: name: SearchSemanticSearch modelAsString: true values: - value: disabled name: disabled description: >- Indicates that semantic search is disabled for the search service. This is the default. - value: free name: free description: >- Enables semantic search on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic search requests and is offered at no extra charge. - value: standard name: standard description: >- Enables semantic search on a search service as a billable feature, with higher throughput and volume of semantic search queries. description: >- Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. SharedPrivateLinkResource: properties: properties: $ref: '#/definitions/SharedPrivateLinkResourceProperties' description: >- Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service. allOf: - $ref: >- ../../../../../common-types/resource-management/v2/types.json#/definitions/Resource description: >- Describes a Shared Private Link Resource managed by the Azure Cognitive Search service. SharedPrivateLinkResourceProperties: properties: privateLinkResourceId: type: string description: >- The resource id of the resource the shared private link resource is for. groupId: type: string description: >- The group id from the provider of resource the shared private link resource is for. requestMessage: type: string description: >- The request message for requesting approval of the shared private link resource. resourceRegion: type: string description: >- Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). externalDocs: description: >- List of all Azure resources which have a regional DNS configuration requirement can be found here. url: https://docs.microsoft.com/azure/private-link/private-endpoint-dns status: type: string description: >- Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected or other yet to be documented value. enum: - Pending - Approved - Rejected - Disconnected x-ms-enum: name: SharedPrivateLinkResourceStatus modelAsString: true values: - value: Pending name: Pending description: >- The shared private link resource has been created and is pending approval. - value: Approved name: Approved description: >- The shared private link resource is approved and is ready for use. - value: Rejected name: Rejected description: >- The shared private link resource has been rejected and cannot be used. - value: Disconnected name: Disconnected description: >- The shared private link resource has been removed from the service. provisioningState: type: string description: >- The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded, Incomplete or other yet to be documented value. enum: - Updating - Deleting - Failed - Succeeded - Incomplete x-ms-enum: name: SharedPrivateLinkResourceProvisioningState modelAsString: true values: - value: Updating name: Updating description: >- The shared private link resource is in the process of being created along with other resources for it to be fully functional. - value: Deleting name: Deleting description: >- The shared private link resource is in the process of being deleted. - value: Failed name: Failed description: >- The shared private link resource has failed to be provisioned or deleted. - value: Succeeded name: Succeeded description: >- The shared private link resource has finished provisioning and is ready for approval. - value: Incomplete name: Incomplete description: >- Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. description: >- Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service. SharedPrivateLinkResourceListResult: properties: value: readOnly: true type: array items: $ref: '#/definitions/SharedPrivateLinkResource' description: The list of Shared Private Link Resources. nextLink: type: string description: >- The URL to get the next set of shared private link resources, if there are any. description: Response containing a list of Shared Private Link Resources. x-ms-external: true PrivateLinkResourcesResult: properties: value: readOnly: true type: array items: $ref: '#/definitions/PrivateLinkResource' description: The list of supported Private Link Resources. description: Response containing a list of supported Private Link Resources. x-ms-external: true PrivateLinkResource: properties: properties: $ref: '#/definitions/PrivateLinkResourceProperties' readOnly: true description: >- Describes the properties of a supported private link resource for the Azure Cognitive Search service. allOf: - $ref: >- ../../../../../common-types/resource-management/v2/types.json#/definitions/Resource description: >- Describes a supported private link resource for the Azure Cognitive Search service. PrivateLinkResourceProperties: properties: groupId: readOnly: true type: string description: The group ID of the private link resource. requiredMembers: readOnly: true type: array items: type: string description: The list of required members of the private link resource. requiredZoneNames: readOnly: true type: array items: type: string description: The list of required DNS zone names of the private link resource. shareablePrivateLinkResourceTypes: readOnly: true type: array items: $ref: '#/definitions/ShareablePrivateLinkResourceType' description: >- The list of resources that are onboarded to private link service, that are supported by Azure Cognitive Search. description: >- Describes the properties of a supported private link resource for the Azure Cognitive Search service. For a given API version, this represents the 'supported' groupIds when creating a shared private link resource. ShareablePrivateLinkResourceType: properties: name: readOnly: true type: string description: >- The name of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search. properties: $ref: '#/definitions/ShareablePrivateLinkResourceProperties' readOnly: true description: >- Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search. description: >- Describes an resource type that has been onboarded to private link service, supported by Azure Cognitive Search. ShareablePrivateLinkResourceProperties: properties: type: readOnly: true type: string description: >- The resource provider type for the resource that has been onboarded to private link service, supported by Azure Cognitive Search. groupId: readOnly: true type: string description: >- The resource provider group id for the resource that has been onboarded to private link service, supported by Azure Cognitive Search. description: readOnly: true type: string description: >- The description of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search. description: >- Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search. SearchService: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/SearchServiceProperties' description: Properties of the search service. sku: $ref: '#/definitions/Sku' description: >- The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. externalDocs: url: https://azure.microsoft.com/documentation/articles/search-sku-tier/ identity: $ref: '#/definitions/Identity' description: The identity of the resource. allOf: - $ref: >- ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource description: Describes an Azure Cognitive Search service and its current state. SearchServiceUpdate: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/SearchServiceProperties' description: Properties of the search service. sku: $ref: '#/definitions/Sku' description: >- The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. externalDocs: url: https://azure.microsoft.com/documentation/articles/search-sku-tier/ location: type: string description: >- 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. externalDocs: url: https://aka.ms/search-rp-info x-ms-mutability: - create - read tags: type: object additionalProperties: type: string description: Tags to help categorize the resource in the Azure portal. identity: $ref: '#/definitions/Identity' description: >- Details about the search service identity. A null value indicates that the search service has no identity assigned. allOf: - $ref: >- ../../../../../common-types/resource-management/v2/types.json#/definitions/Resource description: The parameters used to update an Azure Cognitive Search service. SearchServiceProperties: properties: replicaCount: type: integer format: int32 minimum: 1 maximum: 12 default: 1 description: >- The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. partitionCount: type: integer format: int32 minimum: 1 maximum: 12 default: 1 description: >- The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3. hostingMode: type: string default: default description: >- Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'. enum: - default - highDensity x-ms-enum: name: HostingMode modelAsString: false values: - value: default name: Default description: >- The limit on number of indexes is determined by the default limits for the SKU. - value: highDensity name: HighDensity description: >- Only application for standard3 SKU, where the search service can have up to 1000 indexes. publicNetworkAccess: type: string default: enabled description: >- This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. enum: - enabled - disabled x-ms-enum: name: PublicNetworkAccess modelAsString: true values: - value: enabled name: Enabled description: >- The search service is accessible from traffic originating from the public internet. - value: disabled name: Disabled description: >- The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. status: readOnly: true type: string description: >- The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. enum: - running - provisioning - deleting - degraded - disabled - error - stopped x-ms-enum: name: SearchServiceStatus modelAsString: false values: - value: running name: Running description: >- The search service is running and no provisioning operations are underway. - value: provisioning name: Provisioning description: The search service is being provisioned or scaled up or down. - value: deleting name: Deleting description: The search service is being deleted. - value: degraded name: Degraded description: >- The search service is degraded because underlying search units are not healthy. - value: disabled name: Disabled description: >- The search service is disabled and all API requests will be rejected. - value: error name: Error description: >- The search service is in error state, indicating either a failure to provision or to be deleted. - value: stopped name: Stopped description: The search service is in a subscription that's disabled. statusDetails: readOnly: true type: string description: The details of the search service status. provisioningState: readOnly: true type: string description: >- The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up. enum: - succeeded - provisioning - failed x-ms-enum: name: ProvisioningState modelAsString: false values: - value: succeeded name: Succeeded description: The last provisioning operation has completed successfully. - value: provisioning name: Provisioning description: The search service is being provisioned or scaled up or down. - value: failed name: Failed description: The last provisioning operation has failed. networkRuleSet: $ref: '#/definitions/NetworkRuleSet' description: >- Network specific rules that determine how the Azure Cognitive Search service may be reached. disabledDataExfiltrationOptions: type: array items: $ref: '#/definitions/DisabledDataExfiltrationOption' description: >- A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. encryptionWithCmk: $ref: '#/definitions/EncryptionWithCmk' description: >- Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. disableLocalAuth: type: boolean x-nullable: true description: >- When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. authOptions: $ref: '#/definitions/DataPlaneAuthOptions' description: >- Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. semanticSearch: $ref: '#/definitions/SemanticSearch' x-nullable: true description: >- Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. privateEndpointConnections: readOnly: true type: array items: $ref: '#/definitions/PrivateEndpointConnection' description: >- The list of private endpoint connections to the Azure Cognitive Search service. sharedPrivateLinkResources: readOnly: true type: array items: $ref: '#/definitions/SharedPrivateLinkResource' description: >- The list of shared private link resources managed by the Azure Cognitive Search service. eTag: readOnly: true type: string description: >- A system generated property representing the service's etag that can be for optimistic concurrency control during updates. description: Properties of the search service. SearchServiceListResult: properties: value: readOnly: true type: array items: $ref: '#/definitions/SearchService' description: The list of Search services. nextLink: readOnly: true type: string description: >- Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size. description: Response containing a list of Azure Cognitive Search services. x-ms-external: true AsyncOperationResult: type: object properties: status: type: string description: >- The current status of the long running asynchronous shared private link resource operation. enum: - Running - Succeeded - Failed x-ms-enum: name: SharedPrivateLinkResourceAsyncOperationResult modelAsString: true description: >- The details of a long running asynchronous shared private link resource operation CloudError: type: object properties: error: $ref: '#/definitions/CloudErrorBody' description: Describes a particular API error with an error code and a message. message: type: string description: >- A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). description: Contains information about an API error. x-ms-external: true CloudErrorBody: type: object description: Describes a particular API error with an error code and a message. properties: code: type: string description: >- An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. message: type: string description: >- A message that describes the error in detail and provides debugging information. target: type: string description: >- The target of the particular error (for example, the name of the property in error). details: type: array items: $ref: '#/definitions/CloudErrorBody' description: Contains nested errors that are related to this error. x-ms-external: true Operation: description: Describes a REST API operation. type: object properties: name: description: >- The name of the operation. This name is of the form {provider}/{resource}/{operation}. readOnly: true type: string display: description: The object that describes the operation. readOnly: true properties: provider: description: The friendly name of the resource provider. readOnly: true type: string operation: description: 'The operation type: read, write, delete, listKeys/action, etc.' readOnly: true type: string resource: description: The resource type on which the operation is performed. readOnly: true type: string description: description: The friendly name of the operation. readOnly: true type: string isDataAction: type: boolean x-nullable: true readOnly: true description: >- Describes if the specified operation is a data plane API operation. Operations where this value is not true are supported directly by the resource provider. origin: type: string readOnly: true description: >- Describes which originating entities are allowed to invoke this operation. properties: $ref: '#/definitions/OperationProperties' description: Describes additional properties for this operation. readOnly: true OperationProperties: description: Describes additional properties for this operation. properties: serviceSpecification: $ref: '#/definitions/OperationServiceSpecification' description: Specifications of the service for this operation. readOnly: true OperationServiceSpecification: description: Specifications of the service for this operation. properties: metricSpecifications: type: array readOnly: true items: $ref: '#/definitions/OperationMetricsSpecification' description: Specifications of metrics for this operation. logSpecifications: type: array readOnly: true items: $ref: '#/definitions/OperationLogsSpecification' description: Specifications of logs for this operation. OperationMetricsSpecification: description: Specifications of one type of metric for this operation. readOnly: true properties: name: type: string readOnly: true description: The name of the metric specification. displayName: type: string readOnly: true description: The display name of the metric specification. displayDescription: type: string readOnly: true description: The display description of the metric specification. unit: type: string readOnly: true description: The unit for the metric specification. aggregationType: type: string readOnly: true description: The type of aggregation for the metric specification. dimensions: type: array readOnly: true items: $ref: '#/definitions/OperationMetricDimension' description: Dimensions for the metric specification. availabilities: type: array readOnly: true items: $ref: '#/definitions/OperationAvailability' description: Availabilities for the metric specification. OperationMetricDimension: description: Describes a particular dimension for the metric specification. readOnly: true properties: name: type: string readOnly: true description: The name of the dimension. displayName: type: string readOnly: true description: The display name of the dimension. OperationAvailability: description: Describes a particular availability for the metric specification. readOnly: true properties: timeGrain: type: string readOnly: true description: The time grain for the dimension. blobDuration: type: string readOnly: true description: The blob duration for the dimension. OperationLogsSpecification: description: Specifications of one type of log for this operation. readOnly: true properties: name: type: string readOnly: true description: The name of the log specification. displayName: type: string readOnly: true description: The display name of the log specification. blobDuration: type: string readOnly: true description: The blob duration for the log specification. OperationListResult: description: >- The result of the request to list REST API operations. It contains a list of operations and a URL to get the next set of results. properties: value: type: array items: $ref: '#/definitions/Operation' readOnly: true description: >- The list of operations by Azure Cognitive Search, some supported by the resource provider and others by data plane APIs. nextLink: type: string readOnly: true description: The URL to get the next set of operation list results, if any. Identity: properties: principalId: readOnly: true type: string description: >- The principal ID of the system-assigned identity of the search service. tenantId: readOnly: true type: string description: The tenant ID of the system-assigned identity of the search service. type: type: string description: >- The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service. enum: - None - SystemAssigned - UserAssigned - SystemAssigned, UserAssigned x-ms-enum: name: IdentityType modelAsString: true values: - value: None name: None description: >- Indicates that any identity associated with the search service needs to be removed. - value: SystemAssigned name: SystemAssigned description: >- Indicates that system-assigned identity for the search service will be enabled. - value: UserAssigned name: UserAssigned description: >- Indicates that one or more user assigned identities will be assigned to the search service. - value: SystemAssigned, UserAssigned name: SystemAssigned, UserAssigned description: >- Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. userAssignedIdentities: $ref: '#/definitions/UserAssignedManagedIdentities' description: >- The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. required: - type description: >- Details about the search service identity. A null value indicates that the search service has no identity assigned. UserAssignedManagedIdentities: type: object description: >- The list of user identities associated with the search service. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. additionalProperties: $ref: '#/definitions/UserAssignedManagedIdentity' UserAssignedManagedIdentity: properties: principalId: readOnly: true type: string description: The principal ID of user assigned identity. clientId: readOnly: true type: string description: The client ID of user assigned identity. type: object description: >- The details of the user assigned managed identity assigned to the search service. parameters: ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string description: >- The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. x-ms-parameter-location: method SearchServiceNameParameter: name: searchServiceName in: path required: true type: string description: >- The name of the Azure Cognitive Search service associated with the specified resource group. x-ms-parameter-location: method PrivateEndpointConnectionNameParameter: name: privateEndpointConnectionName in: path required: true type: string description: >- The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group. x-ms-parameter-location: method SharedPrivateLinkResourceNameParameter: name: sharedPrivateLinkResourceName in: path required: true type: string description: >- The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group. x-ms-parameter-location: method OperationNameParameter: name: operationName in: path required: true type: string description: The name of a shared private link resource operation. x-ms-parameter-location: method ClientRequestIdParameter: name: x-ms-client-request-id x-ms-client-name: clientRequestId in: header required: false type: string format: uuid description: >- 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. x-ms-client-request-id: true x-ms-parameter-grouping: name: search-management-request-options x-ms-parameter-location: method SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: >- The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. ApiVersionParameter: name: api-version in: query required: true type: string description: The API version to use for each request. tags: - name: AdminKeys - name: Operations - name: PrivateEndpointConnections - name: PrivateLinkResources - name: QueryKeys - name: SharedPrivateLinkResources