swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector PrivateEndpointConnections API schemes: - https tags: - name: PrivateEndpointConnections paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsListbyconfigurationstore description: Lists all private endpoint connections for a configuration store. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ConfigStoreNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/PrivateEndpointConnectionListResult' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: PrivateEndpointConnection_List: $ref: ./examples/ConfigurationStoresListPrivateEndpointConnections.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsGet description: Gets the specified private endpoint connection associated with the configuration store. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ConfigStoreNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: privateEndpointConnectionName in: path description: Private endpoint connection name required: true type: string responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/PrivateEndpointConnection' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: PrivateEndpointConnection_GetConnection: $ref: ./examples/ConfigurationStoresGetPrivateEndpointConnection.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsCreateorupdate description: Update the state of the specified private endpoint connection associated with the configuration store. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ConfigStoreNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: privateEndpointConnectionName in: path description: Private endpoint connection name required: true type: string - name: privateEndpointConnection in: body description: The private endpoint connection properties. required: true schema: $ref: '#/definitions/PrivateEndpointConnection' responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/PrivateEndpointConnection' '201': description: The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource. schema: $ref: '#/definitions/PrivateEndpointConnection' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: PrivateEndpointConnection_CreateOrUpdate: $ref: ./examples/ConfigurationStoresCreatePrivateEndpointConnection.json x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections description: Deletes a private endpoint connection. operationId: microsoftAzurePrivateendpointconnectionsDelete parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ConfigStoreNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: privateEndpointConnectionName in: path description: Private endpoint connection name required: true type: string responses: '200': description: The request was successful; the request was well-formed and received properly. '202': description: The request was successful; the operation will complete asynchronously. '204': description: No Content - the specified resource was not found. default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: PrivateEndpointConnections_Delete: $ref: ./examples/ConfigurationStoresDeletePrivateEndpointConnection.json x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsList description: List all the private endpoint connections associated with the attestation provider. x-ms-examples: AttestationProviderListPrivateEndpointConnections: $ref: ./examples/AttestationProviderListPrivateEndpointConnections.json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ProviderName' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK -- Successfully retrieved private endpoint connections. schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Error result from Attestation service schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsGet description: Gets the specified private endpoint connection associated with the attestation provider. x-ms-examples: AttestationProviderGetPrivateEndpointConnection: $ref: ./examples/AttestationProviderGetPrivateEndpointConnection.json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ProviderName' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Get the private endpoint connection properties successfully. schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsCreate description: Update the state of specified private endpoint connection associated with the attestation provider. x-ms-examples: AttestationProviderPutPrivateEndpointConnection: $ref: ./examples/AttestationProviderPutPrivateEndpointConnection.json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ProviderName' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName - name: properties in: body required: true schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. responses: '200': description: OK -- Update the private endpoint connection properties successfully. schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsDelete description: Deletes the specified private endpoint connection associated with the attestation provider. x-ms-examples: AttestationProviderDeletePrivateEndpointConnection: $ref: ./examples/AttestationProviderDeletePrivateEndpointConnection.json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ProviderName' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Delete the private endpoint connection successfully. '204': description: No Content -- The private endpoint connection does not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/privateEndpointConnections/{privateEndpointConnectionName} : put: tags: - PrivateEndpointConnections description: Approves or Rejects a Private endpoint connection request. operationId: microsoftAzurePrivateendpointconnectionsCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter' - in: path name: privateEndpointConnectionName description: Private endpoint connection name. required: true type: string - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - in: body name: request description: Request object. required: true schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection responses: '200': description: Success schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection '400': description: Bad Request x-ms-error-response: true schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse default: description: Error schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnections_CreateOrUpdate: $ref: ./examples/PrivateEndpointConnections_CreateOrUpdate.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Privateendpointconnections Privateendpointconnectionname get: tags: - PrivateEndpointConnections description: Get Private endpoint connection object. operationId: microsoftAzurePrivateendpointconnectionsGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter' - in: path name: privateEndpointConnectionName description: Private endpoint connection name. required: true type: string - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection '404': description: Not Found x-ms-error-response: true schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse default: description: Error schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnections_Get: $ref: ./examples/PrivateEndpointConnections_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections description: Delete Private endpoint connection request. operationId: microsoftAzurePrivateendpointconnectionsDelete produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter' - in: path name: privateEndpointConnectionName description: Private endpoint connection name. required: true type: string - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: Success '202': description: accepted headers: Location: type: string '204': description: No Content default: description: Error schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: PrivateEndpointConnections_Delete: $ref: ./examples/PrivateEndpointConnections_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections description: Get list of Private endpoint connections. operationId: microsoftAzurePrivateendpointconnectionsListbyresource produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter' - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Error schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnections_ListByResource: $ref: ./examples/PrivateEndpointConnections_ListByResource.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsList description: List all the private endpoint connections associated with the Bot. x-ms-examples: List Private Endpoint Connections: $ref: ./examples/ListPrivateEndpointConnections.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter' - $ref: '#/parameters/subscriptionIdParameter' responses: '200': description: OK -- Successfully retrieved private endpoint connections. schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Default error response x-ms-error-response: true schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsGet description: Gets the specified private endpoint connection associated with the Bot. x-ms-examples: Get Private Endpoint Connection: $ref: ./examples/GetPrivateEndpointConnection.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Get the private endpoint connection properties successfully. schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. x-ms-error-response: true schema: $ref: '#/definitions/Error' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsCreate description: Update the state of specified private endpoint connection associated with the Bot. x-ms-examples: Put Private Endpoint Connection: $ref: ./examples/PutPrivateEndpointConnection.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName - name: properties in: body required: true schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. responses: '200': description: OK -- Update the private endpoint connection properties successfully. schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. x-ms-error-response: true schema: $ref: '#/definitions/Error' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsDelete description: Deletes the specified private endpoint connection associated with the Bot. x-ms-examples: Delete Private Endpoint Connection: $ref: ./examples/DeletePrivateEndpointConnection.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Delete the private endpoint connection successfully. '204': description: No Content -- The private endpoint connection does not exist. default: description: Error response describing why the operation failed. x-ms-error-response: true schema: $ref: '#/definitions/Error' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateEndpointConnections : get: description: Gets list of private endpoint connections on a cluster. tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsListbycluster x-ms-examples: Gets list of private endpoint connections on a cluster.: $ref: ./examples/PrivateEndpointConnectionsListByCluster.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' responses: '200': description: Successfully retrieved private endpoint connections. schema: $ref: '#/definitions/PrivateEndpointConnectionListResult_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName} : get: description: Gets private endpoint connection. tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsGet x-ms-examples: Gets private endpoint connection.: $ref: ./examples/PrivateEndpointConnectionsGet.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter' responses: '200': description: Successfully retrieved a specified private endpoint connection. schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Privateendpointconnections Privateendpointconnectionname put: description: Approves or Rejects a private endpoint connection with a given name. tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsCreateorupdate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: Approves or Rejects a Private Endpoint Connection with a given name.: $ref: ./examples/PrivateEndpointConnectionCreateOrUpdate.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter' - name: parameters in: body required: true schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection description: The required parameters for approving a private endpoint connection. responses: '200': description: OK schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection '201': description: Accepted schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection headers: location: type: string azure-async-operation: type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Privateendpointconnections Privateendpointconnectionname delete: description: Deletes a private endpoint connection with a given name. tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsDelete x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Deletes a private endpoint connection with a given name.: $ref: ./examples/PrivateEndpointConnectionsDelete.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter' responses: '202': description: Accepted headers: location: type: string azure-async-operation: type: string '204': description: Private endpoint connection does not exist. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsGet description: Gets the specified private endpoint connection associated with the Maps Account. x-ms-examples: PrivateEndpointConnections_Get: $ref: ./examples/PrivateEndpointConnections_Get.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionName' responses: '200': description: OK -- Get the private endpoint connection properties successfully. schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsCreate description: Create or update the state of specified private endpoint connection associated with the Maps account. x-ms-examples: PrivateEndpointConnections_Create: $ref: ./examples/PrivateEndpointConnections_Create.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionName' - name: properties in: body required: true schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. responses: '200': description: Updated the private endpoint connection properties successfully. schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection '201': description: Created the private endpoint connection properties successfully. schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection headers: Azure-AsyncOperation: description: Operation Status Location URI type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsDelete description: Deletes the specified private endpoint connection associated with the Maps Account. x-ms-examples: PrivateEndpointConnections_Delete: $ref: ./examples/PrivateEndpointConnections_Delete.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionName' responses: '202': description: Asynchronous Operation Status Location headers: Azure-AsyncOperation: description: Operation Status Location URI type: string Location: description: Operation Status Location URI type: string Retry-After: description: Retry After type: string '204': description: No Content -- The private endpoint connection does not exist. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/privateEndpointConnections : get: parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter' tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsListbyaccount description: Get a private endpoint connections on the Maps Account. x-ms-examples: PrivateEndpointConnections_ListByAccount: $ref: ./examples/PrivateEndpointConnections_ListByAccount.json responses: '200': description: Array of private endpoint resources in Maps Account schema: $ref: '#/definitions/PrivateEndpointConnectionList' default: description: Error message indicating why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections summary: Microsoft Azure List Private Endpoint Connections description: List private endpoint connections of the workspace operationId: microsoftAzurePrivateendpointconnectionsList x-ms-examples: List private endpoint connections: $ref: ./examples/ListPrivateEndpointConnections.json parameters: - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/WorkspaceName' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' responses: '200': description: OK - Returns list of private endpoint connections for a workspace schema: $ref: '#/definitions/PrivateEndpointConnectionsList' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorResponse_2' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections summary: Microsoft Azure Get Private Endpoint Connection description: Get a private endpoint connection properties for a workspace operationId: microsoftAzurePrivateendpointconnectionsGet x-ms-examples: Get a private endpoint connection: $ref: ./examples/PrivateEndpointConnectionsGet.json parameters: - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/WorkspaceName' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/PrivateEndpointConnectionName_2' responses: '200': description: OK - Returns the private endpoint connection properties of a workspace schema: $ref: '#/definitions/PrivateEndpointConnection_2' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorResponse_2' put: tags: - PrivateEndpointConnections summary: Microsoft Azure Update Private Endpoint Connection Status description: Update the status of a private endpoint connection with the specified name operationId: microsoftAzurePrivateendpointconnectionsCreate x-ms-examples: Update a private endpoint connection: $ref: ./examples/PrivateEndpointConnectionsUpdate.json x-ms-long-running-operation: true parameters: - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/WorkspaceName' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/PrivateEndpointConnectionName_2' - name: privateEndpointConnection in: body description: The private endpoint connection with updated properties required: true schema: $ref: '#/definitions/PrivateEndpointConnection_2' responses: '200': description: OK -- Update the private endpoint connection properties successfully. schema: $ref: '#/definitions/PrivateEndpointConnection_2' '202': description: Accepted - This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. schema: $ref: '#/definitions/PrivateEndpointConnection_2' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorResponse_2' delete: tags: - PrivateEndpointConnections summary: Microsoft Azure Remove Private Endpoint Connection description: Remove private endpoint connection with the specified name operationId: microsoftAzurePrivateendpointconnectionsDelete x-ms-examples: Remove a private endpoint connection: $ref: ./examples/PrivateEndpointConnectionsDelete.json x-ms-long-running-operation: true parameters: - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/WorkspaceName' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/PrivateEndpointConnectionName_2' responses: '200': description: OK - Returns the status of polling request for the delete operation. '202': description: Accepted - This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. '204': description: No Content - PrivateEndpoint does not exist. default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorResponse_2' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections description: List all private endpoint connections in a device update account. operationId: microsoftAzurePrivateendpointconnectionsListbyaccount parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_2' responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnectionList: $ref: ./examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections description: Get the specified private endpoint connection associated with the device update account. operationId: microsoftAzurePrivateendpointconnectionsGet parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_2' - $ref: ./privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnectionGet: $ref: ./examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections description: Update the state of specified private endpoint connection associated with the device update account. operationId: microsoftAzurePrivateendpointconnectionsCreateorupdate parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_2' - $ref: ./privatelinks.json#/parameters/PrivateEndpointConnectionName - name: privateEndpointConnection in: body description: The parameters for creating a private endpoint connection. required: true schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection responses: '201': description: The request was successful; the operation will complete asynchronously. schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnectionCreateOrUpdate: $ref: ./examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections description: Deletes the specified private endpoint connection associated with the device update account. operationId: microsoftAzurePrivateendpointconnectionsDelete parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_2' - $ref: ./privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: The request was successful; the operation completed synchronously. '202': description: The request was successful; the operation will complete asynchronously. '204': description: The private endpoint connection does not exist in the subscription. default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnectionDelete: $ref: ./examples/PrivateEndpointConnections/PrivateEndpointConnection_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyId} : get: tags: - PrivateEndpointConnections description: (INTERNAL - DO NOT USE) Get the specified private endpoint connection proxy associated with the device update account. operationId: microsoftAzurePrivateendpointconnectionproxiesGet parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_2' - $ref: '#/parameters/PrivateEndpointConnectionProxyIdParameter' responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/PrivateEndpointConnectionProxy' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateEndpointConnectionProxyGet: $ref: ./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privateendpointconnectionproxies Privateendpointconnectionproxyid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections summary: Microsoft Azure Get A Specific Private Endpoint Connection description: Get a specific private endpoint connection under a topic, domain, or partner namespace. operationId: microsoftAzurePrivateendpointconnectionsGet consumes: [] produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter_4' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true type: string - name: parentType in: path description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'. required: true type: string enum: - topics - domains - partnerNamespaces x-ms-enum: name: ParentType modelAsString: true - name: parentName in: path description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). required: true type: string - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection connection. required: true type: string - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/PrivateEndpointConnection_3' default: description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." x-ms-examples: PrivateEndpointConnections_Get: $ref: ./examples/PrivateEndpointConnections_Get.json put: tags: - PrivateEndpointConnections summary: Microsoft Azure Update A Specific Private Endpoint Connection description: Update a specific private endpoint connection under a topic, domain or partner namespace. operationId: microsoftAzurePrivateendpointconnectionsUpdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter_4' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true type: string - name: parentType in: path description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'. required: true type: string enum: - topics - domains - partnerNamespaces x-ms-enum: name: ParentType modelAsString: true - name: parentName in: path description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). required: true type: string - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection connection. required: true type: string - name: privateEndpointConnection in: body description: The private endpoint connection object to update. required: true schema: $ref: '#/definitions/PrivateEndpointConnection_3' - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/PrivateEndpointConnection_3' '201': description: Created schema: $ref: '#/definitions/PrivateEndpointConnection_3' default: description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." x-ms-examples: PrivateEndpointConnections_Update: $ref: ./examples/PrivateEndpointConnections_Update.json x-ms-long-running-operation: true delete: tags: - PrivateEndpointConnections summary: Microsoft Azure Delete A Specific Private Endpoint Connection description: Delete a specific private endpoint connection under a topic, domain, or partner namespace. operationId: microsoftAzurePrivateendpointconnectionsDelete consumes: [] produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter_4' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true type: string - name: parentType in: path description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'. required: true type: string enum: - topics - domains - partnerNamespaces x-ms-enum: name: ParentType modelAsString: true - name: parentName in: path description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). required: true type: string - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection connection. required: true type: string - $ref: '#/parameters/ApiVersionParameter_4' responses: '202': description: Accepted '204': description: NoContent default: description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." x-ms-examples: PrivateEndpointConnections_Delete: $ref: ./examples/PrivateEndpointConnections_Delete.json x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections summary: Microsoft Azure Lists All Private Endpoint Connections Under A Resource description: Get all private endpoint connections under a topic, domain, or partner namespace. operationId: microsoftAzurePrivateendpointconnectionsListbyresource consumes: [] produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter_4' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true type: string - name: parentType in: path description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'. required: true type: string enum: - topics - domains - partnerNamespaces x-ms-enum: name: ParentType modelAsString: true - name: parentName in: path description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). required: true type: string - $ref: '#/parameters/ApiVersionParameter_4' - $ref: '#/parameters/FilterParameter' - $ref: '#/parameters/TopParameter' responses: '200': description: OK schema: $ref: '#/definitions/PrivateEndpointConnectionListResult_3' default: description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." x-ms-examples: PrivateEndpointConnections_ListByResource: $ref: ./examples/PrivateEndpointConnections_ListByResource.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections description: Gets a private endpoint connection. operationId: microsoftAzurePrivateendpointconnectionsGet parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true type: string responses: '200': description: Successfully retrieved a specified private endpoint connection. schema: $ref: '#/definitions/PrivateEndpointConnection_4' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Gets private endpoint connection.: $ref: ./examples/privateEndpoint/PrivateEndpointConnection_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Privatelinkscopes Scopename Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections description: Approve or reject a private endpoint connection with a given name. operationId: microsoftAzurePrivateendpointconnectionsCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true type: string - name: parameters in: body required: true schema: $ref: '#/definitions/PrivateEndpointConnection_4' responses: '200': description: Successfully approved or rejected private endpoint connection. schema: $ref: '#/definitions/PrivateEndpointConnection_4' '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: Approve or reject a private endpoint connection with a given name.: $ref: ./examples/privateEndpoint/PrivateEndpointConnection_Update.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Privatelinkscopes Scopename Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections description: Deletes a private endpoint connection with a given name. operationId: microsoftAzurePrivateendpointconnectionsDelete parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true type: string responses: '200': description: Successfully deleted private endpoint connection. '202': description: Accepted headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. type: integer format: int32 Azure-AsyncOperation: description: The URI to poll for completion status. type: string '204': description: Private endpoint connection does not exist. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: Deletes a private endpoint connection with a given name.: $ref: ./examples/privateEndpoint/PrivateEndpointConnection_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Privatelinkscopes Scopename Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections description: Gets all private endpoint connections on a private link scope. operationId: microsoftAzurePrivateendpointconnectionsListbyprivatelinkscope parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' responses: '200': description: Successfully retrieved private endpoint connections. schema: $ref: '#/definitions/PrivateEndpointConnectionListResult_4' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets list of private endpoint connections on a private link scope.: $ref: ./examples/privateEndpoint/PrivateEndpointConnection_List.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Privatelinkscopes Scopename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsforsccpowershellListbyservice description: Lists all private endpoint connections for a service. parameters: - $ref: ./common-types.json#/parameters/subscriptionId - $ref: ./common-types.json#/parameters/resourceGroupName - $ref: ./common-types.json#/parameters/resourceName - $ref: ./common-types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnectionListResult default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateEndpointConnection_List: $ref: ./examples/SCCPowershellServiceListPrivateEndpointConnections.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft M365securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsforsccpowershellGet description: Gets the specified private endpoint connection associated with the service. parameters: - $ref: ./common-types.json#/parameters/subscriptionId - $ref: ./common-types.json#/parameters/resourceGroupName - $ref: ./common-types.json#/parameters/resourceName - $ref: ./common-types.json#/parameters/ApiVersionParameter - $ref: ./common-types.json#/parameters/PrivateEndpointConnectionName responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateEndpointConnection_GetConnection: $ref: ./examples/SCCPowershellServiceGetPrivateEndpointConnection.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft M365securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsforsccpowershellCreateorupdate description: Update the state of the specified private endpoint connection associated with the service. parameters: - $ref: ./common-types.json#/parameters/subscriptionId - $ref: ./common-types.json#/parameters/resourceGroupName - $ref: ./common-types.json#/parameters/resourceName - $ref: ./common-types.json#/parameters/ApiVersionParameter - $ref: ./common-types.json#/parameters/PrivateEndpointConnectionName - name: properties in: body required: true schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. responses: '200': description: OK. The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection '201': description: Created. The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateEndpointConnection_CreateOrUpdate: $ref: ./examples/SCCPowershellServiceCreatePrivateEndpointConnection.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft M365securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections description: Deletes a private endpoint connection. operationId: microsoftAzurePrivateendpointconnectionsforsccpowershellDelete parameters: - $ref: ./common-types.json#/parameters/subscriptionId - $ref: ./common-types.json#/parameters/resourceGroupName - $ref: ./common-types.json#/parameters/resourceName - $ref: ./common-types.json#/parameters/ApiVersionParameter - $ref: ./common-types.json#/parameters/PrivateEndpointConnectionName responses: '200': description: The request was successful; the request was well-formed and received properly. '202': description: The request was successful; the operation will complete asynchronously. '204': description: No Content - The private endpoint connection does not exist. default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateEndpointConnections_Delete: $ref: ./examples/SCCPowershellServiceDeletePrivateEndpointConnection.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft M365securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsGet description: Gets the specified private endpoint connection associated with the storage sync service. x-ms-examples: PrivateEndpointConnections_Get: $ref: ./examples/PrivateEndpointConnections_Get.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageSyncServiceNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Get the private endpoint connection properties successfully. schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/StorageSyncError' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsCreate description: Update the state of specified private endpoint connection associated with the storage sync service. x-ms-examples: PrivateEndpointConnections_Create: $ref: ./examples/PrivateEndpointConnections_Create.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageSyncServiceNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName - name: properties in: body required: true schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. responses: '200': description: OK -- Update the private endpoint connection properties successfully. schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection '202': description: Asynchronous Operation Status Location headers: Azure-AsyncOperation: description: Operation Status Location URI type: string Location: description: Operation Status Location URI type: string Retry-After: description: Retry After type: string x-ms-request-id: description: Request id type: string x-ms-correlation-request-id: description: correlation request id type: string default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/StorageSyncError' x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsDelete description: Deletes the specified private endpoint connection associated with the storage sync service. x-ms-examples: PrivateEndpointConnections_Delete: $ref: ./examples/PrivateEndpointConnections_Delete.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageSyncServiceNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Delete the private endpoint connection successfully. '202': description: Asynchronous Operation Status Location headers: Azure-AsyncOperation: description: Operation Status Location URI type: string Location: description: Operation Status Location URI type: string Retry-After: description: Retry After type: string x-ms-request-id: description: Request id type: string x-ms-correlation-request-id: description: correlation request id type: string '204': description: No Content -- The private endpoint connection does not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/StorageSyncError' x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections description: Gets a private endpoint connection. operationId: microsoftAzurePrivateendpointconnectionsGet parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' - $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: Successfully retrieved a specified private endpoint connection. schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Gets private endpoint connection.: $ref: ./examples/PrivateEndpointConnectionGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kubernetesconfiguration Privatelinkscopes Scopename Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections description: Approve or reject a private endpoint connection with a given name. operationId: microsoftAzurePrivateendpointconnectionsCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' - $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName - name: properties in: body required: true schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. responses: '200': description: Successfully approved or rejected private endpoint connection. schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: Approve or reject a private endpoint connection with a given name.: $ref: ./examples/PrivateEndpointConnectionUpdate.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kubernetesconfiguration Privatelinkscopes Scopename Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections description: Deletes a private endpoint connection with a given name. operationId: microsoftAzurePrivateendpointconnectionsDelete parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' - $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: Successfully deleted private endpoint connection. '202': description: Accepted '204': description: Private endpoint connection does not exist. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-examples: Deletes a private endpoint connection with a given name.: $ref: ./examples/PrivateEndpointConnectionDelete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kubernetesconfiguration Privatelinkscopes Scopename Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/{scopeName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections description: Gets all private endpoint connections on a private link scope. operationId: microsoftAzurePrivateendpointconnectionsListbyprivatelinkscope parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' responses: '200': description: Successfully retrieved private endpoint connections. schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Gets list of private endpoint connections on a private link scope.: $ref: ./examples/PrivateEndpointConnectionList.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kubernetesconfiguration Privatelinkscopes Scopename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections description: Gets a private endpoint connection. operationId: microsoftAzurePrivateendpointconnectionsGet parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName_2' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true type: string responses: '200': description: Successfully retrieved a specified private endpoint connection. schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Gets private endpoint connection.: $ref: ./examples/PrivateEndpointConnectionGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Privatelinkscopes Scopename Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections description: Approve or reject a private endpoint connection with a given name. operationId: microsoftAzurePrivateendpointconnectionsCreateorupdate parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName_2' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true type: string - name: parameters in: body required: true schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection responses: '200': description: Successfully approved or rejected private endpoint connection. schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection '202': description: Accepted default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-long-running-operation: true x-ms-examples: Approve or reject a private endpoint connection with a given name.: $ref: ./examples/PrivateEndpointConnectionUpdate.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Privatelinkscopes Scopename Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections description: Deletes a private endpoint connection with a given name. operationId: microsoftAzurePrivateendpointconnectionsDelete parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName_2' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true type: string responses: '200': description: Successfully deleted private endpoint connection. '202': description: Accepted '204': description: Private endpoint connection does not exist. default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-long-running-operation: true x-ms-examples: Deletes a private endpoint connection with a given name.: $ref: ./examples/PrivateEndpointConnectionDelete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Privatelinkscopes Scopename Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections description: Gets all private endpoint connections on a private link scope. operationId: microsoftAzurePrivateendpointconnectionsListbyprivatelinkscope parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName_2' responses: '200': description: Successfully retrieved private endpoint connections. schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Gets list of private endpoint connections on a private link scope.: $ref: ./examples/PrivateEndpointConnectionList.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Privatelinkscopes Scopename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections summary: Microsoft Azure Lists All Private Endpoint Connections Under A Resource description: Gets private endpoint connection for Power BI. operationId: microsoftAzurePrivateendpointconnectionsListbyresource consumes: [] produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter_5' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true type: string - name: azureResourceName in: path description: The name of the powerbi resource. required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: Success. The response describes the list of private endpoint connections in the private endpoint resource. schema: $ref: '#/definitions/PrivateEndpointConnectionListResult_5' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: An error response received from Power BI service. x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets private endpoint connections: $ref: ./examples/PrivateEndpointConnections_ListByResource.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}/privateEndpointConnections/{privateEndpointName} : get: tags: - PrivateEndpointConnections summary: Microsoft Azure Get A Specific Private Endpoint Connection operationId: microsoftAzurePrivateendpointconnectionsGet description: Get a specific private endpoint connection for Power BI by private endpoint name. parameters: - $ref: '#/parameters/SubscriptionIdParameter_5' - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/AzureResourceNameParameter' - $ref: '#/parameters/PrivateEndpointNameParameter' - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: OK schema: $ref: '#/definitions/PrivateEndpointConnection_5' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: An error response received from Power BI service. x-ms-examples: Gets private endpoint connection: $ref: ./examples/PrivateEndpointConnections_Get.json put: tags: - PrivateEndpointConnections summary: Microsoft Azure Update A Specific Private Endpoint Connection description: Updates the status of Private Endpoint Connection object. Used to approve or reject a connection. operationId: microsoftAzurePrivateendpointconnectionsCreate parameters: - $ref: '#/parameters/SubscriptionIdParameter_5' - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/AzureResourceNameParameter' - $ref: '#/parameters/PrivateEndpointNameParameter' - name: privateEndpointConnection in: body required: true description: Private endpoint connection object to update. schema: $ref: '#/definitions/PrivateEndpointConnection_5' - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: OK schema: $ref: '#/definitions/PrivateEndpointConnection_5' '201': description: Created schema: $ref: '#/definitions/PrivateEndpointConnection_5' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: An error response received from Power BI service. x-ms-examples: Updates status of private endpoint connection: $ref: ./examples/PrivateEndpointConnections_Create.json delete: tags: - PrivateEndpointConnections description: Deletes a private endpoint connection for Power BI by private endpoint name. summary: Microsoft Azure Asynchronous Api To Delete A Private Endpoint Connection For Power Bi By Private Endpoint Name operationId: microsoftAzurePrivateendpointconnectionsDelete parameters: - $ref: '#/parameters/SubscriptionIdParameter_5' - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/AzureResourceNameParameter' - $ref: '#/parameters/PrivateEndpointNameParameter' - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: OK. The operation completed successfully. '202': description: Accepted headers: Azure-AsyncOperation: type: string description: The Azure async operation id to poll on result. '204': description: No Content. default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: An error response received from Power BI service. x-ms-examples: Deletes private endpoint connection: $ref: ./examples/PrivateEndpointConnections_Delete.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsList description: Lists all the private endpoint connections associated with the RedisEnterprise cluster. x-ms-examples: RedisEnterpriseListPrivateEndpointConnections: $ref: ./examples/RedisEnterpriseListPrivateEndpointConnections.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ClusterNameParameter_2' - $ref: '#/parameters/ApiVersionParameter_6' - $ref: '#/parameters/SubscriptionIdParameter_6' responses: '200': description: OK -- Successfully retrieved private endpoint connections. schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsGet description: Gets the specified private endpoint connection associated with the RedisEnterprise cluster. x-ms-examples: RedisEnterpriseGetPrivateEndpointConnection: $ref: ./examples/RedisEnterpriseGetPrivateEndpointConnection.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ClusterNameParameter_2' - $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName - $ref: '#/parameters/ApiVersionParameter_6' - $ref: '#/parameters/SubscriptionIdParameter_6' responses: '200': description: OK -- Get the private endpoint connection properties successfully. schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsPut description: Updates the state of the specified private endpoint connection associated with the RedisEnterprise cluster. x-ms-examples: RedisEnterprisePutPrivateEndpointConnection: $ref: ./examples/RedisEnterprisePutPrivateEndpointConnection.json x-ms-long-running-operation: true parameters: - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ClusterNameParameter_2' - $ref: '#/parameters/ApiVersionParameter_6' - $ref: '#/parameters/SubscriptionIdParameter_6' - $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName - name: properties in: body required: true schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. responses: '201': description: OK -- Update the private endpoint connection properties successfully. schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsDelete description: Deletes the specified private endpoint connection associated with the RedisEnterprise cluster. x-ms-examples: RedisEnterpriseDeletePrivateEndpointConnection: $ref: ./examples/RedisEnterpriseDeletePrivateEndpointConnection.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ClusterNameParameter_2' - $ref: '#/parameters/ApiVersionParameter_6' - $ref: '#/parameters/SubscriptionIdParameter_6' - $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Delete the private endpoint connection successfully. '204': description: No Content -- The private endpoint connection does not exist. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Privateendpointconnections Privateendpointconnectionname ? /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_5' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter_2' - name: privateEndpointConnection in: body required: true schema: $ref: '#/definitions/PrivateEndpointConnection_6' description: The definition of the private endpoint connection to update. - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/SubscriptionIdParameter_7' responses: '200': description: The existing private endpoint connection definition was successfully updated. schema: $ref: '#/definitions/PrivateEndpointConnection_6' 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_2' 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_5' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter_2' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/SubscriptionIdParameter_7' responses: '200': description: The definition of the private endpoint connection was successfully retrieved and is in the response. schema: $ref: '#/definitions/PrivateEndpointConnection_6' default: description: 'HTTP 404 (Not Found): The subscription, resource group, search service or private endpoint connection could not be found.' schema: $ref: '#/definitions/CloudError_2' 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_5' - $ref: '#/parameters/SearchServiceNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter_2' - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/SubscriptionIdParameter_7' 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_6' '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_2' 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_7' - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter_5' - $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_6' default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsforsccpowershellListbyservice description: Lists all private endpoint connections for a service. parameters: - $ref: ./common-types.json#/parameters/subscriptionId - $ref: ./common-types.json#/parameters/resourceGroupName - $ref: ./common-types.json#/parameters/resourceName - $ref: ./common-types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnectionListResult default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateEndpointConnection_List: $ref: ./examples/SCCPowershellServiceListPrivateEndpointConnections.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsforsccpowershellGet description: Gets the specified private endpoint connection associated with the service. parameters: - $ref: ./common-types.json#/parameters/subscriptionId - $ref: ./common-types.json#/parameters/resourceGroupName - $ref: ./common-types.json#/parameters/resourceName - $ref: ./common-types.json#/parameters/ApiVersionParameter - $ref: ./common-types.json#/parameters/PrivateEndpointConnectionName responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateEndpointConnection_GetConnection: $ref: ./examples/SCCPowershellServiceGetPrivateEndpointConnection.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsforsccpowershellCreateorupdate description: Update the state of the specified private endpoint connection associated with the service. parameters: - $ref: ./common-types.json#/parameters/subscriptionId - $ref: ./common-types.json#/parameters/resourceGroupName - $ref: ./common-types.json#/parameters/resourceName - $ref: ./common-types.json#/parameters/ApiVersionParameter - $ref: ./common-types.json#/parameters/PrivateEndpointConnectionName - name: properties in: body required: true schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. responses: '200': description: OK. The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection '201': description: Created. The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateEndpointConnection_CreateOrUpdate: $ref: ./examples/SCCPowershellServiceCreatePrivateEndpointConnection.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections description: Deletes a private endpoint connection. operationId: microsoftAzurePrivateendpointconnectionsforsccpowershellDelete parameters: - $ref: ./common-types.json#/parameters/subscriptionId - $ref: ./common-types.json#/parameters/resourceGroupName - $ref: ./common-types.json#/parameters/resourceName - $ref: ./common-types.json#/parameters/ApiVersionParameter - $ref: ./common-types.json#/parameters/PrivateEndpointConnectionName responses: '200': description: The request was successful; the request was well-formed and received properly. '202': description: The request was successful; the operation will complete asynchronously. '204': description: No Content - The private endpoint connection does not exist. default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateEndpointConnections_Delete: $ref: ./examples/SCCPowershellServiceDeletePrivateEndpointConnection.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privateendpointconnections Privateendpointconnectionname definitions: ErrorDetail: title: Error details. type: object properties: code: description: The error's code. type: string message: description: A human readable error message. type: string target: description: Indicates which property in the request is responsible for the error. type: string required: - code - message PrivateEndpointConnection_5: title: PrivateEndpointConnection type: object properties: id: type: string readOnly: true description: Specifies the id of the resource. name: type: string readOnly: true description: Specifies the name of the resource. type: type: string readOnly: true description: Specifies the type of the resource. systemData: readOnly: true description: The system meta data relating to this resource. $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData properties: x-ms-client-flatten: true $ref: '#/definitions/PrivateEndpointConnectionProperties_5' description: Specifies the properties of the private endpoint connection. x-ms-azure-resource: true PrivateEndpointConnectionProperties_6: 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. PrivateLinkServiceConnectionStateProperty: type: object description: State of the private endpoint connection. required: - status - description properties: status: description: The private link service connection status. type: string description: description: The private link service connection description. type: string actionsRequired: description: The actions required for private link service connection. type: string readOnly: true PrivateEndpointConnectionProxyProperties: description: Private endpoint connection proxy object properties. type: object x-ms-client-flatten: true properties: eTag: description: ETag from NRP. type: string readOnly: true remotePrivateEndpoint: description: Remote private endpoint details. $ref: '#/definitions/RemotePrivateEndpoint' status: description: Operation status. type: string PrivateEndpointConnectionProperties_4: type: object description: Properties of a private endpoint connection. properties: privateEndpoint: $ref: '#/definitions/PrivateEndpointProperty' description: Private endpoint which the connection belongs to. privateLinkServiceConnectionState: $ref: '#/definitions/PrivateLinkServiceConnectionStateProperty' description: Connection state of the private endpoint connection. provisioningState: description: State of the private endpoint connection. type: string readOnly: true groupIds: description: List of group IDs. type: array items: type: string readOnly: true PrivateEndpointConnection: description: A private endpoint connection type: object properties: id: description: The resource ID. type: string readOnly: true name: description: The name of the resource. type: string readOnly: true type: description: The type of the resource. type: string readOnly: true properties: $ref: '#/definitions/PrivateEndpointConnectionProperties' description: The properties of a private endpoint. x-ms-client-flatten: true x-ms-azure-resource: true PrivateEndpoint_4: title: PrivateEndpoint type: object properties: id: type: string description: Specifies the id of private endpoint. PrivateLinkServiceConnectionState_2: description: The current state of a private endpoint connection type: object properties: status: description: The status of a private endpoint connection enum: - Pending - Approved - Rejected - Disconnected type: string x-ms-enum: name: PrivateLinkServiceConnectionStatus modelAsString: true description: type: string description: The description for the current state of a private endpoint connection actionsRequired: type: string description: Actions required for a private endpoint connection required: - status Error: properties: error: $ref: '#/definitions/ErrorBody' description: The error body. description: Bot Service error object. StorageSyncError: type: object description: Error type properties: error: $ref: '#/definitions/StorageSyncApiError' description: Error details of the given entry. innererror: $ref: '#/definitions/StorageSyncApiError' description: Error details of the given entry. PrivateEndpointConnectionProperties_2: description: The properties of a private endpoint connection type: object properties: privateEndpoint: title: Private endpoint description: Private endpoint $ref: '#/definitions/PrivateEndpoint_2' groupIds: type: array description: GroupIds from the private link service resource. items: type: string privateLinkServiceConnectionState: title: Private link service service connection state description: Private endpoint connection state $ref: '#/definitions/PrivateLinkServiceConnectionState_2' provisioningState: $ref: '#/definitions/PrivateEndpointConnectionProvisioningState' description: Provisioning state of the private endpoint connection. required: - privateLinkServiceConnectionState PrivateEndpointConnectionProperties_3: description: Properties of the private endpoint connection resource. type: object properties: privateEndpoint: $ref: '#/definitions/PrivateEndpoint_3' description: The Private Endpoint resource for this Connection. groupIds: description: GroupIds from the private link service resource. type: array items: type: string privateLinkServiceConnectionState: $ref: '#/definitions/ConnectionState' description: Details about the state of the connection. provisioningState: description: Provisioning state of the Private Endpoint Connection. enum: - Creating - Updating - Deleting - Succeeded - Canceled - Failed type: string x-ms-enum: name: ResourceProvisioningState modelAsString: true PrivateEndpoint: type: object description: Private endpoint which a connection belongs to. properties: id: description: The resource Id for private endpoint type: string ErrorDetails: description: The details of the error. properties: code: description: Error code. type: string readOnly: true message: description: Error message indicating why the operation failed. type: string readOnly: true additionalInfo: readOnly: true type: array items: $ref: '#/definitions/ErrorAdditionalInfo' x-ms-identifiers: [] description: The error additional info. CloudErrorBody: x-ms-external: true properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the error, intended to be suitable for displaying in a user interface. description: An error response from Attestation. RemotePrivateEndpointConnection: description: Remote private endpoint connection details. type: object properties: id: description: Remote private endpoint connection ID. type: string readOnly: true PrivateEndpointConnectionProxy: description: Private endpoint connection proxy details. type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource - $ref: '#/definitions/PrivateEndpointConnectionProxyProperties' properties: properties: description: Private endpoint connection proxy object property bag. type: object x-ms-client-flatten: true properties: provisioningState: $ref: '#/definitions/PrivateEndpointConnectionProxyProvisioningState' description: The provisioning state of the private endpoint connection proxy resource. ConnectionState: description: ConnectionState information. type: object properties: status: description: Status of the connection. enum: - Pending - Approved - Rejected - Disconnected type: string x-ms-enum: name: PersistedConnectionStatus modelAsString: true description: description: Description of the connection state. type: string actionsRequired: description: Actions required (if any). type: string PrivateEndpointConnectionProperties: type: object description: Properties of a private endpoint connection. properties: provisioningState: enum: - Creating - Updating - Deleting - Succeeded - Failed - Canceled type: string readOnly: true description: The provisioning status of the private endpoint connection. x-ms-enum: name: ProvisioningState modelAsString: true privateEndpoint: $ref: '#/definitions/PrivateEndpoint' description: The resource of private endpoint. privateLinkServiceConnectionState: $ref: '#/definitions/PrivateLinkServiceConnectionState' description: A collection of information about the state of the connection between service consumer and provider. required: - privateLinkServiceConnectionState ErrorBody: properties: code: type: string description: error code message: type: string description: error message description: Bot Service error body. required: - code - message PrivateEndpointConnection_3: type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/PrivateEndpointConnectionProperties_3' description: Properties of the PrivateEndpointConnection. x-ms-client-flatten: true CloudErrorBody_2: 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_2' description: Contains nested errors that are related to this error. x-ms-external: true PrivateEndpoint_2: description: The private endpoint property of a private endpoint connection type: object properties: id: readOnly: true type: string description: The resource identifier. ErrorResponse: description: Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. type: object properties: error: description: The details of the error. $ref: '#/definitions/ErrorDetails' PrivateLinkServiceProxy: description: Private link service proxy details. type: object properties: id: description: NRP resource ID. type: string remotePrivateLinkServiceConnectionState: description: Remote private link service connection state $ref: ./privatelinks.json#/definitions/PrivateLinkServiceConnectionState remotePrivateEndpointConnection: description: Remote private endpoint connection details. allOf: - $ref: '#/definitions/RemotePrivateEndpointConnection' groupConnectivityInformation: description: Group connectivity information. type: array items: $ref: '#/definitions/GroupConnectivityInformation' PrivateEndpointConnectionListResult_6: properties: value: readOnly: true type: array items: $ref: '#/definitions/PrivateEndpointConnection_6' 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 PrivateEndpointConnection_2: description: The private endpoint connection of a workspace x-ms-azure-resource: true type: object properties: id: readOnly: true type: string description: The resource identifier. name: readOnly: true type: string description: The resource name. type: readOnly: true type: string description: The resource type. properties: type: object description: The private endpoint connection properties. x-ms-client-flatten: false $ref: '#/definitions/PrivateEndpointConnectionProperties_2' required: - properties PrivateEndpointConnectionsList: description: List of private link connections. type: object properties: value: type: array items: $ref: '#/definitions/PrivateEndpointConnection_2' description: The list of returned private endpoint connection. nextLink: type: string description: The URL to get the next set of endpoint connections. PrivateEndpointConnectionListResult_5: title: PrivateEndpointConnections description: List of private endpoint connections. type: object properties: value: title: PrivateEndpointConnection description: Specifies the name of the private endpoint connection. type: array items: $ref: '#/definitions/PrivateEndpointConnection_5' nextLink: type: string description: URL to get the next set of operation list results (if there are any). readOnly: true ErrorInfo: title: The code and message for an error. type: object properties: code: description: A machine readable error code. type: string message: description: A human readable error message. type: string details: description: error details. type: array items: $ref: '#/definitions/ErrorDetail' innererror: description: Inner error details if they exist. type: string required: - code - message StorageSyncErrorDetails: type: object description: Error Details object. properties: code: type: string description: Error code of the given entry. message: type: string description: Error message of the given entry. target: type: string description: Target of the given entry. requestUri: type: string description: Request URI of the given entry. exceptionType: type: string description: Exception type of the given entry. httpMethod: type: string description: HTTP method of the given entry. hashedMessage: type: string description: Hashed message of the given entry. httpErrorCode: type: string description: HTTP error code of the given entry. PrivateEndpointConnectionListResult_3: description: Result of the list of all private endpoint connections operation. type: object properties: value: description: A collection of private endpoint connection resources. type: array items: $ref: '#/definitions/PrivateEndpointConnection_3' nextLink: description: A link for the next page of private endpoint connection resources. type: string Resource: description: Definition of a Resource type: object properties: id: description: Fully qualified identifier of the resource. type: string readOnly: true name: description: Name of the resource. type: string readOnly: true type: description: Type of the resource. type: string readOnly: true x-ms-azure-resource: true DefaultErrorResponse: title: Default error response description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). type: object properties: error: description: The error object. $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail PrivateEndpointConnection_4: type: object description: A private endpoint connection allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/PrivateEndpointConnectionProperties_4' description: Resource properties. systemData: readOnly: true description: The system meta data relating to this resource. $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData PrivateEndpointConnectionProperties_5: title: PrivateEndpointConnectionProperties type: object properties: privateEndpoint: $ref: '#/definitions/PrivateEndpoint_4' description: Specifies the private endpoint. privateLinkServiceConnectionState: $ref: '#/definitions/ConnectionState' description: Specifies the connection state. provisioningState: description: Provisioning state of the Private Endpoint Connection. enum: - Creating - Updating - Deleting - Succeeded - Canceled - Failed type: string x-ms-enum: name: ResourceProvisioningState modelAsString: true PrivateEndpointConnectionListResult: type: object description: A list of private endpoint connections properties: value: description: The collection value. type: array items: $ref: '#/definitions/PrivateEndpointConnection' nextLink: description: The URI that can be used to request the next set of paged results. type: string PrivateEndpointConnectionListResult_4: type: object description: A list of private endpoint connections. properties: value: description: Array of results. type: array items: $ref: '#/definitions/PrivateEndpointConnection_4' readOnly: true nextLink: description: Link to retrieve next page of results. type: string readOnly: true PrivateEndpointConnectionProvisioningState: type: string readOnly: true description: The current provisioning state. enum: - Succeeded - Creating - Updating - Deleting - Failed x-ms-enum: name: PrivateEndpointConnectionProvisioningState modelAsString: true StorageSyncApiError: type: object description: Error type properties: code: type: string description: Error code of the given entry. message: type: string description: Error message of the given entry. target: type: string description: Target of the given error entry. details: $ref: '#/definitions/StorageSyncErrorDetails' description: Error details of the given entry. innererror: $ref: '#/definitions/StorageSyncInnerErrorDetails' description: Inner error details of the given entry. GroupConnectivityInformation: description: Group connectivity details. type: object properties: groupId: description: Group ID. type: string readOnly: true memberName: description: Member name. type: string readOnly: true customerVisibleFqdns: description: List of customer visible FQDNs. type: array items: type: string internalFqdn: description: Internal FQDN. type: string readOnly: true redirectMapId: description: Redirect map ID. type: string privateLinkServiceArmRegion: description: PrivateLinkService ARM region. type: string RemotePrivateEndpoint: description: Remote private endpoint details. type: object properties: id: description: Remote endpoint resource ID. type: string location: description: ARM location of the remote private endpoint. type: string immutableSubscriptionId: description: Original subscription ID needed by Microsoft.Network. type: string immutableResourceId: description: Original resource ID needed by Microsoft.Network. type: string vnetTrafficTag: description: Virtual network traffic tag. type: string manualPrivateLinkServiceConnections: description: List of private link service connections that need manual approval. type: array items: $ref: '#/definitions/PrivateLinkServiceConnection' privateLinkServiceConnections: description: List of automatically approved private link service connections. type: array items: $ref: '#/definitions/PrivateLinkServiceConnection' privateLinkServiceProxies: description: List of private link service proxies. type: array items: $ref: '#/definitions/PrivateLinkServiceProxy' connectionDetails: description: List of connection details. type: array items: $ref: '#/definitions/ConnectionDetails' CloudError_2: type: object properties: error: $ref: '#/definitions/CloudErrorBody_2' 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 PrivateEndpointConnectionListResult_2: type: object properties: value: type: array description: Array of private endpoint connections. items: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection description: List of private endpoint connections associated with the specified resource. PrivateEndpointConnectionProxyProvisioningState: type: string readOnly: true description: The current provisioning state. enum: - Succeeded - Creating - Deleting - Failed x-ms-enum: name: PrivateEndpointConnectionProxyProvisioningState modelAsString: true StorageSyncInnerErrorDetails: type: object description: Error Details object. properties: callStack: type: string description: Call stack of the error. message: type: string description: Error message of the error. innerException: type: string description: Exception of the inner error. innerExceptionCallStack: type: string description: Call stack of the inner error. ErrorAdditionalInfo: properties: type: readOnly: true type: string description: The additional info type. info: readOnly: true type: object description: The additional info. description: The resource management error additional info. PrivateLinkServiceConnectionState: description: The state of a private link service connection. type: object properties: status: enum: - Pending - Approved - Rejected - Disconnected type: string description: The private link service connection status. x-ms-enum: name: ConnectionStatus modelAsString: true description: type: string description: The private link service connection description. actionsRequired: enum: - None - Recreate type: string readOnly: true description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) x-ms-enum: name: ActionsRequired modelAsString: true ErrorResponse_2: title: Error response. description: Contains details when the response code indicates an error. type: object properties: error: description: The error details. $ref: '#/definitions/ErrorInfo' required: - error PrivateEndpoint_3: description: PrivateEndpoint information. type: object properties: id: description: The ARM identifier for Private Endpoint. type: string PrivateLinkServiceConnection: description: Private link service connection details. type: object properties: name: description: Private link service connection name. type: string groupIds: description: List of group IDs. type: array items: type: string requestMessage: description: Request message. type: string ConnectionDetails: description: Private endpoint connection proxy object properties. type: object properties: id: description: Connection details ID. type: string readOnly: true privateIpAddress: description: Private IP address. type: string readOnly: true linkIdentifier: description: Link ID. type: string readOnly: true groupId: description: Group ID. type: string readOnly: true memberName: description: Member name. type: string readOnly: true PrivateEndpointConnectionList: description: A list of private endpoint connections type: object properties: value: description: The list of the private endpoint connections type: array items: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection x-ms-identifiers: [] nextLink: 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. type: string format: uri readOnly: true x-nullable: true PrivateEndpointConnection_6: properties: properties: $ref: '#/definitions/PrivateEndpointConnectionProperties_6' 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. PrivateEndpointProperty: type: object description: Private endpoint which the connection belongs to. properties: id: description: Resource id of the private endpoint. type: string CloudError: x-ms-external: true properties: error: $ref: '#/definitions/CloudErrorBody' description: An error response from Attestation. parameters: ApiVersionParameter_5: name: api-version in: query required: true type: string description: The API version to be used with the HTTP request. ApiVersionParameter_6: name: api-version in: query required: true type: string description: Client Api Version. ResourceGroupNameParameter: name: resourceGroupName in: path description: The name of the resource group to which the container registry belongs. required: true type: string x-ms-parameter-location: method ResourceGroupName: name: resourceGroupName in: path required: true type: string description: The name of the resource group. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 x-ms-parameter-location: method ApiVersionParameter_4: name: api-version in: query description: Version of the API to be used with the client request. required: true type: string AzureResourceNameParameter: name: azureResourceName in: path required: true type: string description: The name of the Azure resource. x-ms-parameter-location: client PrivateEndpointConnectionProxyIdParameter: name: privateEndpointConnectionProxyId in: path required: true type: string description: The ID of the private endpoint connection proxy object. x-ms-parameter-location: method PrivateLinkScopeName_2: name: scopeName in: path required: true type: string description: The name of the Azure Monitor PrivateLinkScope resource. x-ms-parameter-location: method ResourceGroupNameParameter_4: name: resourceGroupName in: path required: true type: string description: The name of the resource group. x-ms-parameter-location: method ClusterNameParameter: name: clusterName in: path required: true type: string description: The name of the cluster. pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?