Microsoft Azure Search Management Client

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://<name>.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:
   

# --- truncated at 32 KB (92 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/searchmanagementclient-openapi-original.yml