swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector SharedPrivateLinkResources API schemes: - https tags: - name: SharedPrivateLinkResources paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/sharedPrivateLinkResources : get: operationId: microsoftAzureSharedprivatelinkresourcesListbywatcher tags: - SharedPrivateLinkResources description: List SharedPrivateLinkResource resources by Watcher parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: watcherName in: path description: The database watcher name. required: true type: string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/SharedPrivateLinkResourceListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: SharedPrivateLinkResources_ListByWatcher: $ref: ./examples/SharedPrivateLinkResources_ListByWatcher_200.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databasewatcher Watchers Watchername Sharedprivatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} : get: operationId: microsoftAzureSharedprivatelinkresourcesGet tags: - SharedPrivateLinkResources description: Get a SharedPrivateLinkResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: watcherName in: path description: The database watcher name. required: true type: string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$ - name: sharedPrivateLinkResourceName in: path description: The Shared Private Link resource name. required: true type: string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_.]{0,62}[a-zA-Z0-9_]{1}$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/SharedPrivateLinkResource' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: SharedPrivateLinkResources_Get: $ref: ./examples/SharedPrivateLinkResources_Get_200.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databasewatcher Watchers Watchername Sharedprivatelinkresources Sharedprivatelinkresourcename put: operationId: microsoftAzureSharedprivatelinkresourcesCreate tags: - SharedPrivateLinkResources description: Create a SharedPrivateLinkResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: watcherName in: path description: The database watcher name. required: true type: string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$ - name: sharedPrivateLinkResourceName in: path description: The Shared Private Link resource name. required: true type: string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_.]{0,62}[a-zA-Z0-9_]{1}$ - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/SharedPrivateLinkResource' responses: '200': description: Resource 'SharedPrivateLinkResource' update operation succeeded schema: $ref: '#/definitions/SharedPrivateLinkResource' '201': description: Resource 'SharedPrivateLinkResource' create operation succeeded schema: $ref: '#/definitions/SharedPrivateLinkResource' headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: SharedPrivateLinkResources_Create: $ref: ./examples/SharedPrivateLinkResources_Create_200.json x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databasewatcher Watchers Watchername Sharedprivatelinkresources Sharedprivatelinkresourcename delete: operationId: microsoftAzureSharedprivatelinkresourcesDelete tags: - SharedPrivateLinkResources description: Delete a SharedPrivateLinkResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: watcherName in: path description: The database watcher name. required: true type: string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$ - name: sharedPrivateLinkResourceName in: path description: The Shared Private Link resource name. required: true type: string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_.]{0,62}[a-zA-Z0-9_]{1}$ responses: '202': description: Resource deletion accepted. headers: Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. '204': description: Resource does not exist. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: SharedPrivateLinkResources_Delete: $ref: ./examples/SharedPrivateLinkResources_Delete_200.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databasewatcher Watchers Watchername Sharedprivatelinkresources Sharedprivatelinkresourcename ? /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_2' 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_2' '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_2' 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_2' 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 definitions: SharedPrivateLinkResourceListResult_2: properties: value: readOnly: true type: array items: $ref: '#/definitions/SharedPrivateLinkResource_2' 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 SharedPrivateLinkResource: type: object description: Concrete proxy resource types can be created by aliasing this type using a specific property type. properties: properties: $ref: '#/definitions/SharedPrivateLinkResourceProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource Azure.ResourceManager.ResourceProvisioningState: type: string description: The provisioning state of a resource type. enum: - Succeeded - Failed - Canceled x-ms-enum: name: ResourceProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. readOnly: true SharedPrivateLinkResourceProperties: type: object description: The generic properties of a Shared Private Link resource. properties: privateLinkResourceId: type: string format: arm-id 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. dnsZone: type: string description: The DNS zone to be included in the DNS name of the shared private link. Value is service-specific. status: $ref: '#/definitions/SharedPrivateLinkResourceStatus' description: Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. readOnly: true provisioningState: $ref: '#/definitions/Azure.ResourceManager.ResourceProvisioningState' description: The provisioning state of the resource. readOnly: true required: - privateLinkResourceId - groupId - requestMessage 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 SharedPrivateLinkResourceStatus: type: string description: Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. enum: - Pending - Approved - Rejected - Disconnected x-ms-enum: name: SharedPrivateLinkResourceStatus modelAsString: true values: - name: Pending value: Pending description: The shared private link connection request was not yet authorized by the resource owner. - name: Approved value: Approved description: The shared private link connection request was approved by the resource owner. - name: Rejected value: Rejected description: The shared private link connection request was rejected by the resource owner. - name: Disconnected value: Disconnected description: The shared private link connection request was disconnected by the resource owner. SharedPrivateLinkResource_2: properties: properties: $ref: '#/definitions/SharedPrivateLinkResourceProperties_2' 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. SharedPrivateLinkResourceListResult: type: object description: The response of a SharedPrivateLinkResource list operation. properties: value: type: array description: The SharedPrivateLinkResource items on this page items: $ref: '#/definitions/SharedPrivateLinkResource' nextLink: type: string format: uri description: The link to the next page of items required: - value SharedPrivateLinkResourceProperties_2: 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. 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 parameters: 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 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 ApiVersionParameter: name: api-version in: query required: true type: string description: The API version to use for each request. 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 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. 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 x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'