openapi: 3.2.0 info: title: Microsoft Azure Private Endpoint Connections API x-refined-note: - x-ms-code-generation-settings differs across the merged source definitions and was not carried version: '1.0' description: 'Operations tagged PrivateEndpointConnections across 18 of this provider''s published API definitions: appconfigurationmanagementclient-openapi-original.yml, attestationmanagementclient-openapi-original.yml, azure-agfoodplatform-rp-service-openapi-original.yml, azure-bot-service-openapi-original.yml, azure-cosmos-db-for-postgresql-openapi-original.yml, azure-maps-resource-provider-openapi-original.yml, azuredatabricksmanagementclient-openapi-original.yml, deviceupdate-openapi-original.yml…' servers: - url: https://management.azure.com tags: - name: Private Endpoint Connections paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections : get: tags: - Private Endpoint Connections operationId: microsoftAzurePrivateendpointconnectionsListbyconfigurationstore description: Lists all private endpoint connections for a configuration store. parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ConfigStoreNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: The request was successful; the request was well-formed and received properly. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionListResult' default: description: Error response describing why the operation failed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-ms-examples: PrivateEndpointConnection_List: $ref: ./examples/ConfigurationStoresListPrivateEndpointConnections.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections operationId: microsoftAzurePrivateendpointconnectionsGet description: Gets the specified private endpoint connection associated with the configuration store. parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ConfigStoreNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' - name: privateEndpointConnectionName in: path description: Private endpoint connection name required: true schema: type: string responses: '200': description: The request was successful; the request was well-formed and received properly. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection' default: description: Error response describing why the operation failed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-ms-examples: PrivateEndpointConnection_GetConnection: $ref: ./examples/ConfigurationStoresGetPrivateEndpointConnection.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation put: tags: - Private Endpoint Connections operationId: microsoftAzurePrivateendpointconnectionsCreateorupdate description: Update the state of the specified private endpoint connection associated with the configuration store. parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ConfigStoreNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' - name: privateEndpointConnectionName in: path description: Private endpoint connection name required: true schema: type: string responses: '200': description: The request was successful; the request was well-formed and received properly. content: application/json: schema: $ref: '#/components/schemas/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. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection' default: description: Error response describing why the operation failed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-ms-examples: PrivateEndpointConnection_CreateOrUpdate: $ref: ./examples/ConfigurationStoresCreatePrivateEndpointConnection.json x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups… requestBody: content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection' description: The private endpoint connection properties. required: true security: - azure_auth: - user_impersonation delete: tags: - Private Endpoint Connections description: Deletes a private endpoint connection. operationId: microsoftAzurePrivateendpointconnectionsDelete parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ConfigStoreNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' - name: privateEndpointConnectionName in: path description: Private endpoint connection name required: true schema: 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 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-ms-examples: PrivateEndpointConnections_Delete: $ref: ./examples/ConfigurationStoresDeletePrivateEndpointConnection.json x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections : get: tags: - Private Endpoint Connections 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: '#/components/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. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Error result from Attestation service content: application/json: schema: $ref: '#/components/schemas/CloudError' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftAttestationAttestationProvidersByProviderNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/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. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections 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: '#/components/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 -- Update the private endpoint connection properties successfully. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups… requestBody: content: application/json: schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. required: true delete: tags: - Private Endpoint Connections operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftAttestationAttestationProvidersByProviderNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/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. content: application/json: schema: $ref: '#/components/schemas/CloudError' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups… x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/privateEndpointConnections/{privateEndpointConnectionName} : put: tags: - Private Endpoint Connections description: Approves or Rejects a Private endpoint connection request. operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftAgFoodPlatformFarmBeatsByDataManagerForAgricultureResourceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/DataManagerForAgricultureResourceNameParameter' - in: path name: privateEndpointConnectionName description: Private endpoint connection name. required: true schema: type: string - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: Success content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection '400': description: Bad Request x-ms-error-response: true content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse default: description: Error content: application/json: 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… requestBody: content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection description: Request object. required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsCreateorupdate get: tags: - Private Endpoint Connections description: Get Private endpoint connection object. operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftAgFoodPlatformFarmBeatsByDataManagerForAgricultureResourceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/DataManagerForAgricultureResourceNameParameter' - in: path name: privateEndpointConnectionName description: Private endpoint connection name. required: true schema: type: string - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: Success content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection '404': description: Not Found x-ms-error-response: true content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse default: description: Error content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet delete: tags: - Private Endpoint Connections description: Delete Private endpoint connection request. operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftAgFoodPlatformFarmBeatsByDataManagerForAgricultureResourceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/DataManagerForAgricultureResourceNameParameter' - in: path name: privateEndpointConnectionName description: Private endpoint connection name. required: true schema: type: string - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: Success '202': description: accepted headers: Location: schema: type: string '204': description: No Content default: description: Error content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/privateEndpointConnections : get: tags: - Private Endpoint Connections description: Get list of Private endpoint connections. operationId: microsoftAzurePrivateendpointconnectionsListbyresource parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/DataManagerForAgricultureResourceNameParameter' - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: Success content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Error content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections : get: tags: - Private Endpoint Connections operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftBotServiceBotServicesByResourceNamePrivateEndpointConnections description: List all the private endpoint connections associated with the Bot. x-ms-examples: List Private Endpoint Connections: $ref: ./examples/ListPrivateEndpointConnections.json parameters: - $ref: '#/components/parameters/resourceGroupNameParameter' - $ref: '#/components/parameters/resourceNameParameter' - $ref: '#/components/parameters/apiVersionParameter' - $ref: '#/components/parameters/subscriptionIdParameter' responses: '200': description: OK -- Successfully retrieved private endpoint connections. content: application/json: schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Default error response x-ms-error-response: true content: application/json: schema: $ref: '#/components/schemas/Error' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsList servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftBotServiceBotServicesByResourceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName description: Gets the specified private endpoint connection associated with the Bot. x-ms-examples: Get Private Endpoint Connection: $ref: ./examples/GetPrivateEndpointConnection.json parameters: - $ref: '#/components/parameters/resourceGroupNameParameter' - $ref: '#/components/parameters/resourceNameParameter' - $ref: '#/components/parameters/apiVersionParameter' - $ref: '#/components/parameters/subscriptionIdParameter' - $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Get the private endpoint connection properties successfully. content: application/json: schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. x-ms-error-response: true content: application/json: schema: $ref: '#/components/schemas/Error' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftBotServiceBotServicesByResourceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/resourceGroupNameParameter' - $ref: '#/components/parameters/resourceNameParameter' - $ref: '#/components/parameters/apiVersionParameter' - $ref: '#/components/parameters/subscriptionIdParameter' - $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Update the private endpoint connection properties successfully. content: application/json: schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. x-ms-error-response: true content: application/json: schema: $ref: '#/components/schemas/Error' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups… requestBody: content: application/json: schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. required: true x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsCreate delete: tags: - Private Endpoint Connections operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftBotServiceBotServicesByResourceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName description: Deletes the specified private endpoint connection associated with the Bot. x-ms-examples: Delete Private Endpoint Connection: $ref: ./examples/DeletePrivateEndpointConnection.json parameters: - $ref: '#/components/parameters/resourceGroupNameParameter' - $ref: '#/components/parameters/resourceNameParameter' - $ref: '#/components/parameters/apiVersionParameter' - $ref: '#/components/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 content: application/json: schema: $ref: '#/components/schemas/Error' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups… x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateEndpointConnections : get: description: Gets list of private endpoint connections on a cluster. tags: - Private Endpoint Connections 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: '#/components/parameters/ClusterNameParameter' responses: '200': description: Successfully retrieved private endpoint connections. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionListResult_2' default: description: Error response describing why the operation failed. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName} : get: description: Gets private endpoint connection. tags: - Private Endpoint Connections operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftDBforPostgreSQLServerGroupsv2ByClusterNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/ClusterNameParameter' - $ref: '#/components/parameters/PrivateEndpointConnectionNameParameter' responses: '200': description: Successfully retrieved a specified private endpoint connection. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: description: Approves or Rejects a private endpoint connection with a given name. tags: - Private Endpoint Connections operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftDBforPostgreSQLServerGroupsv2ByClusterNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/ClusterNameParameter' - $ref: '#/components/parameters/PrivateEndpointConnectionNameParameter' responses: '200': description: OK content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection '201': description: Accepted headers: location: schema: type: string azure-async-operation: schema: type: string content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups… requestBody: content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpointConnection description: The required parameters for approving a private endpoint connection. required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsCreateorupdate delete: description: Deletes a private endpoint connection with a given name. tags: - Private Endpoint Connections operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftDBforPostgreSQLServerGroupsv2ByClusterNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/ClusterNameParameter' - $ref: '#/components/parameters/PrivateEndpointConnectionNameParameter' responses: '202': description: Accepted headers: location: schema: type: string azure-async-operation: schema: type: string '204': description: Private endpoint connection does not exist. default: description: Error response describing why the operation failed. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftMapsAccountsByAccountNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/AccountNameParameter' - $ref: '#/components/parameters/PrivateEndpointConnectionName' responses: '200': description: OK -- Get the private endpoint connection properties successfully. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftMapsAccountsByAccountNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/AccountNameParameter' - $ref: '#/components/parameters/PrivateEndpointConnectionName' responses: '200': description: Updated the private endpoint connection properties successfully. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection '201': description: Created the private endpoint connection properties successfully. headers: Azure-AsyncOperation: description: Operation Status Location URI schema: type: string content: application/json: schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups… requestBody: content: application/json: schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsCreate delete: tags: - Private Endpoint Connections operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftMapsAccountsByAccountNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/AccountNameParameter' - $ref: '#/components/parameters/PrivateEndpointConnectionName' responses: '202': description: Asynchronous Operation Status Location headers: Azure-AsyncOperation: description: Operation Status Location URI schema: type: string Location: description: Operation Status Location URI schema: type: string Retry-After: description: Retry After schema: type: string '204': description: No Content -- The private endpoint connection does not exist. default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /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: '#/components/parameters/AccountNameParameter' tags: - Private Endpoint Connections 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 content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionList' default: description: Error message indicating why the operation failed. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections : get: tags: - Private Endpoint Connections summary: Microsoft Azure List Private Endpoint Connections description: List private endpoint connections of the workspace operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftDatabricksWorkspacesByWorkspaceNamePrivateEndpointConnections x-ms-examples: List private endpoint connections: $ref: ./examples/ListPrivateEndpointConnections.json parameters: - $ref: '#/components/parameters/ResourceGroupName' - $ref: '#/components/parameters/WorkspaceName' - $ref: '#/components/parameters/ApiVersionParameter_2' - $ref: '#/components/parameters/SubscriptionIdParameter_2' responses: '200': description: OK - Returns list of private endpoint connections for a workspace content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionsList' default: description: DefaultErrorResponse content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_2' x-ms-pageable: nextLinkName: nextLink security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsList servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections summary: Microsoft Azure Get Private Endpoint Connection description: Get a private endpoint connection properties for a workspace operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftDatabricksWorkspacesByWorkspaceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName x-ms-examples: Get a private endpoint connection: $ref: ./examples/PrivateEndpointConnectionsGet.json parameters: - $ref: '#/components/parameters/ResourceGroupName' - $ref: '#/components/parameters/WorkspaceName' - $ref: '#/components/parameters/ApiVersionParameter_2' - $ref: '#/components/parameters/SubscriptionIdParameter_2' - $ref: '#/components/parameters/PrivateEndpointConnectionName_2' responses: '200': description: OK - Returns the private endpoint connection properties of a workspace content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_2' default: description: DefaultErrorResponse content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_2' security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections summary: Microsoft Azure Update Private Endpoint Connection Status description: Update the status of a private endpoint connection with the specified name operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftDatabricksWorkspacesByWorkspaceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName x-ms-examples: Update a private endpoint connection: $ref: ./examples/PrivateEndpointConnectionsUpdate.json x-ms-long-running-operation: true parameters: - $ref: '#/components/parameters/ResourceGroupName' - $ref: '#/components/parameters/WorkspaceName' - $ref: '#/components/parameters/ApiVersionParameter_2' - $ref: '#/components/parameters/SubscriptionIdParameter_2' - $ref: '#/components/parameters/PrivateEndpointConnectionName_2' responses: '200': description: OK -- Update the private endpoint connection properties successfully. content: application/json: schema: $ref: '#/components/schemas/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. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_2' default: description: DefaultErrorResponse content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_2' description: The private endpoint connection with updated properties required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsCreate delete: tags: - Private Endpoint Connections summary: Microsoft Azure Remove Private Endpoint Connection description: Remove private endpoint connection with the specified name operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftDatabricksWorkspacesByWorkspaceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName x-ms-examples: Remove a private endpoint connection: $ref: ./examples/PrivateEndpointConnectionsDelete.json x-ms-long-running-operation: true parameters: - $ref: '#/components/parameters/ResourceGroupName' - $ref: '#/components/parameters/WorkspaceName' - $ref: '#/components/parameters/ApiVersionParameter_2' - $ref: '#/components/parameters/SubscriptionIdParameter_2' - $ref: '#/components/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 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_2' security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnections : get: tags: - Private Endpoint Connections description: List all private endpoint connections in a device update account. operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftDeviceUpdateAccountsByAccountNamePrivateEndpointConnections parameters: - $ref: '#/components/parameters/ApiVersionParameter_3' - $ref: '#/components/parameters/SubscriptionIdParameter_3' - $ref: '#/components/parameters/ResourceGroupNameParameter_2' - $ref: '#/components/parameters/AccountNameParameter_2' responses: '200': description: The request was successful; the request was well-formed and received properly. content: application/json: schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Error response describing the reason for operation failure. content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsListbyaccount servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections description: Get the specified private endpoint connection associated with the device update account. operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftDeviceUpdateAccountsByAccountNamePrivateEndpointConnectionsByPrivateEndpointConnectionName parameters: - $ref: '#/components/parameters/ApiVersionParameter_3' - $ref: '#/components/parameters/SubscriptionIdParameter_3' - $ref: '#/components/parameters/ResourceGroupNameParameter_2' - $ref: '#/components/parameters/AccountNameParameter_2' - $ref: ./privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: The request was successful; the request was well-formed and received properly. content: application/json: schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing the reason for operation failure. content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections description: Update the state of specified private endpoint connection associated with the device update account. operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftDeviceUpdateAccountsByAccountNamePrivateEndpointConnectionsByPrivateEndpointConnectionName parameters: - $ref: '#/components/parameters/ApiVersionParameter_3' - $ref: '#/components/parameters/SubscriptionIdParameter_3' - $ref: '#/components/parameters/ResourceGroupNameParameter_2' - $ref: '#/components/parameters/AccountNameParameter_2' - $ref: ./privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '201': description: The request was successful; the operation will complete asynchronously. content: application/json: schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing the reason for operation failure. content: application/json: 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… requestBody: content: application/json: schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection description: The parameters for creating a private endpoint connection. required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsCreateorupdate delete: tags: - Private Endpoint Connections description: Deletes the specified private endpoint connection associated with the device update account. operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftDeviceUpdateAccountsByAccountNamePrivateEndpointConnectionsByPrivateEndpointConnectionName parameters: - $ref: '#/components/parameters/ApiVersionParameter_3' - $ref: '#/components/parameters/SubscriptionIdParameter_3' - $ref: '#/components/parameters/ResourceGroupNameParameter_2' - $ref: '#/components/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. content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyId} : get: tags: - Private Endpoint Connections description: (INTERNAL - DO NOT USE) Get the specified private endpoint connection proxy associated with the device update account. operationId: microsoftAzurePrivateendpointconnectionproxiesGet parameters: - $ref: '#/components/parameters/ApiVersionParameter_3' - $ref: '#/components/parameters/SubscriptionIdParameter_3' - $ref: '#/components/parameters/ResourceGroupNameParameter_2' - $ref: '#/components/parameters/AccountNameParameter_2' - $ref: '#/components/parameters/PrivateEndpointConnectionProxyIdParameter' responses: '200': description: The request was successful; the request was well-formed and received properly. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionProxy' default: description: Error response describing the reason for operation failure. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections summary: Microsoft Azure Get A Specific Private Endpoint Connection description: Get a specific private endpoint connection under a topic, domain, or partner namespace. operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftEventGridByParentTypeByParentNamePrivateEndpointConnectionsByPrivateEndpointConnectionName parameters: - $ref: '#/components/parameters/SubscriptionIdParameter_4' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true schema: type: string - name: parentType in: path description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'. required: true x-ms-enum: name: ParentType modelAsString: true schema: type: string enum: - topics - domains - partnerNamespaces - name: parentName in: path description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). required: true schema: type: string - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection connection. required: true schema: type: string - $ref: '#/components/parameters/ApiVersionParameter_4' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/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 x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections 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 parameters: - $ref: '#/components/parameters/SubscriptionIdParameter_4' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true schema: type: string - name: parentType in: path description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'. required: true x-ms-enum: name: ParentType modelAsString: true schema: type: string enum: - topics - domains - partnerNamespaces - name: parentName in: path description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). required: true schema: type: string - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection connection. required: true schema: type: string - $ref: '#/components/parameters/ApiVersionParameter_4' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_3' '201': description: Created content: application/json: schema: $ref: '#/components/schemas/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 requestBody: content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_3' description: The private endpoint connection object to update. required: true delete: tags: - Private Endpoint Connections summary: Microsoft Azure Delete A Specific Private Endpoint Connection description: Delete a specific private endpoint connection under a topic, domain, or partner namespace. operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftEventGridByParentTypeByParentNamePrivateEndpointConnectionsByPrivateEndpointConnectionName parameters: - $ref: '#/components/parameters/SubscriptionIdParameter_4' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true schema: type: string - name: parentType in: path description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'. required: true x-ms-enum: name: ParentType modelAsString: true schema: type: string enum: - topics - domains - partnerNamespaces - name: parentName in: path description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). required: true schema: type: string - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection connection. required: true schema: type: string - $ref: '#/components/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 x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections : get: tags: - Private Endpoint Connections 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: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftEventGridByParentTypeByParentNamePrivateEndpointConnections parameters: - $ref: '#/components/parameters/SubscriptionIdParameter_4' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true schema: type: string - name: parentType in: path description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'. required: true x-ms-enum: name: ParentType modelAsString: true schema: type: string enum: - topics - domains - partnerNamespaces - name: parentName in: path description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). required: true schema: type: string - $ref: '#/components/parameters/ApiVersionParameter_4' - $ref: '#/components/parameters/FilterParameter' - $ref: '#/components/parameters/TopParameter' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/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 x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsListbyresource servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections description: Gets a private endpoint connection. operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftHybridComputePrivateLinkScopesByScopeNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/PrivateLinkScopeName' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true schema: type: string responses: '200': description: Successfully retrieved a specified private endpoint connection. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_4' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections description: Approve or reject a private endpoint connection with a given name. operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftHybridComputePrivateLinkScopesByScopeNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/PrivateLinkScopeName' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true schema: type: string responses: '200': description: Successfully approved or rejected private endpoint connection. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_4' '202': description: Accepted default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_4' required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsCreateorupdate delete: tags: - Private Endpoint Connections description: Deletes a private endpoint connection with a given name. operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftHybridComputePrivateLinkScopesByScopeNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/PrivateLinkScopeName' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true schema: 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. schema: type: string Retry-After: description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. schema: type: integer format: int32 Azure-AsyncOperation: description: The URI to poll for completion status. schema: type: string '204': description: Private endpoint connection does not exist. default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections : get: tags: - Private Endpoint Connections 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: '#/components/parameters/PrivateLinkScopeName' responses: '200': description: Successfully retrieved private endpoint connections. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionListResult_4' default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateEndpointConnections : get: tags: - Private Endpoint Connections 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. content: application/json: schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnectionListResult default: description: DefaultErrorResponse content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections 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. content: application/json: schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection default: description: DefaultErrorResponse content: application/json: schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateEndpointConnection_GetConnection: $ref: ./examples/SCCPowershellServiceGetPrivateEndpointConnection.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation put: tags: - Private Endpoint Connections 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 responses: '200': description: OK. The request was successful; the request was well-formed and received properly. content: application/json: schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection '201': description: Created. The request was successful; the request was well-formed and received properly. content: application/json: schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection default: description: DefaultErrorResponse content: application/json: 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… requestBody: content: application/json: schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. required: true security: - azure_auth: - user_impersonation delete: tags: - Private Endpoint Connections 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 content: application/json: 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… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftStorageSyncStorageSyncServicesByStorageSyncServiceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/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. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/StorageSyncError' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftStorageSyncStorageSyncServicesByStorageSyncServiceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/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 -- Update the private endpoint connection properties successfully. content: application/json: 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 schema: type: string Location: description: Operation Status Location URI schema: type: string Retry-After: description: Retry After schema: type: string x-ms-request-id: description: Request id schema: type: string x-ms-correlation-request-id: description: correlation request id schema: type: string default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/StorageSyncError' x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups… requestBody: content: application/json: schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsCreate delete: tags: - Private Endpoint Connections operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftStorageSyncStorageSyncServicesByStorageSyncServiceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/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 schema: type: string Location: description: Operation Status Location URI schema: type: string Retry-After: description: Retry After schema: type: string x-ms-request-id: description: Request id schema: type: string x-ms-correlation-request-id: description: correlation request id schema: type: string '204': description: No Content -- The private endpoint connection does not exist. default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/StorageSyncError' x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections description: Gets a private endpoint connection. operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftKubernetesConfigurationPrivateLinkScopesByScopeNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/PrivateLinkScopeName' - $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: Successfully retrieved a specified private endpoint connection. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections description: Approve or reject a private endpoint connection with a given name. operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftKubernetesConfigurationPrivateLinkScopesByScopeNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/PrivateLinkScopeName' - $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: Successfully approved or rejected private endpoint connection. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection '202': description: Accepted default: description: Error response describing why the operation failed. content: application/json: 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… requestBody: content: application/json: schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsCreateorupdate delete: tags: - Private Endpoint Connections description: Deletes a private endpoint connection with a given name. operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftKubernetesConfigurationPrivateLinkScopesByScopeNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/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. content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/{scopeName}/privateEndpointConnections : get: tags: - Private Endpoint Connections description: Gets all private endpoint connections on a private link scope. operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftKubernetesConfigurationPrivateLinkScopesByScopeNamePrivateEndpointConnections 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: '#/components/parameters/PrivateLinkScopeName' responses: '200': description: Successfully retrieved private endpoint connections. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Error response describing why the operation failed. content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsListbyprivatelinkscope servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections description: Gets a private endpoint connection. operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftInsightsPrivateLinkScopesByScopeNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/PrivateLinkScopeName_2' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true schema: type: string responses: '200': description: Successfully retrieved a specified private endpoint connection. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection default: description: An error occurred. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Gets private endpoint connection.: $ref: ./examples/PrivateEndpointConnectionGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections description: Approve or reject a private endpoint connection with a given name. operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftInsightsPrivateLinkScopesByScopeNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/PrivateLinkScopeName_2' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true schema: type: string responses: '200': description: Successfully approved or rejected private endpoint connection. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection '202': description: Accepted default: description: An error occurred. content: application/json: schema: $ref: '#/components/schemas/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… requestBody: content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsCreateorupdate delete: tags: - Private Endpoint Connections description: Deletes a private endpoint connection with a given name. operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftInsightsPrivateLinkScopesByScopeNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/PrivateLinkScopeName_2' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections : get: tags: - Private Endpoint Connections description: Gets all private endpoint connections on a private link scope. operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftInsightsPrivateLinkScopesByScopeNamePrivateEndpointConnections 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: '#/components/parameters/PrivateLinkScopeName_2' responses: '200': description: Successfully retrieved private endpoint connections. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: An error occurred. content: application/json: schema: $ref: '#/components/schemas/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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsListbyprivatelinkscope servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}/privateEndpointConnections : get: tags: - Private Endpoint Connections summary: Microsoft Azure Lists All Private Endpoint Connections Under A Resource description: Gets private endpoint connection for Power BI. operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftPowerBIPrivateLinkServicesForPowerBIByAzureResourceNamePrivateEndpointConnections parameters: - $ref: '#/components/parameters/SubscriptionIdParameter_5' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true schema: type: string - name: azureResourceName in: path description: The name of the powerbi resource. required: true schema: type: string - $ref: '#/components/parameters/ApiVersionParameter_5' responses: '200': description: Success. The response describes the list of private endpoint connections in the private endpoint resource. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionListResult_5' default: description: An error response received from Power BI service. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets private endpoint connections: $ref: ./examples/PrivateEndpointConnections_ListByResource.json security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsListbyresource servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}/privateEndpointConnections/{privateEndpointName} : get: tags: - Private Endpoint Connections summary: Microsoft Azure Get A Specific Private Endpoint Connection operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftPowerBIPrivateLinkServicesForPowerBIByAzureResourceNamePrivateEndpointConnectionsByPrivateEndpointName description: Get a specific private endpoint connection for Power BI by private endpoint name. parameters: - $ref: '#/components/parameters/SubscriptionIdParameter_5' - $ref: '#/components/parameters/ResourceGroupNameParameter_3' - $ref: '#/components/parameters/AzureResourceNameParameter' - $ref: '#/components/parameters/PrivateEndpointNameParameter' - $ref: '#/components/parameters/ApiVersionParameter_5' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_5' default: description: An error response received from Power BI service. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Gets private endpoint connection: $ref: ./examples/PrivateEndpointConnections_Get.json security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections 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: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftPowerBIPrivateLinkServicesForPowerBIByAzureResourceNamePrivateEndpointConnectionsByPrivateEndpointName parameters: - $ref: '#/components/parameters/SubscriptionIdParameter_5' - $ref: '#/components/parameters/ResourceGroupNameParameter_3' - $ref: '#/components/parameters/AzureResourceNameParameter' - $ref: '#/components/parameters/PrivateEndpointNameParameter' - $ref: '#/components/parameters/ApiVersionParameter_5' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_5' '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_5' default: description: An error response received from Power BI service. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Updates status of private endpoint connection: $ref: ./examples/PrivateEndpointConnections_Create.json requestBody: content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_5' description: Private endpoint connection object to update. required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsCreate delete: tags: - Private Endpoint Connections 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… operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftPowerBIPrivateLinkServicesForPowerBIByAzureResourceNamePrivateEndpointConnectionsByPrivateEndpointName parameters: - $ref: '#/components/parameters/SubscriptionIdParameter_5' - $ref: '#/components/parameters/ResourceGroupNameParameter_3' - $ref: '#/components/parameters/AzureResourceNameParameter' - $ref: '#/components/parameters/PrivateEndpointNameParameter' - $ref: '#/components/parameters/ApiVersionParameter_5' responses: '200': description: OK. The operation completed successfully. '202': description: Accepted headers: Azure-AsyncOperation: description: The Azure async operation id to poll on result. schema: type: string '204': description: No Content. default: description: An error response received from Power BI service. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse 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 security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections : get: tags: - Private Endpoint Connections operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftCacheRedisEnterpriseByClusterNamePrivateEndpointConnections description: Lists all the private endpoint connections associated with the RedisEnterprise cluster. x-ms-examples: RedisEnterpriseListPrivateEndpointConnections: $ref: ./examples/RedisEnterpriseListPrivateEndpointConnections.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ClusterNameParameter_2' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK -- Successfully retrieved private endpoint connections. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Error response describing why the operation failed. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsList servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftCacheRedisEnterpriseByClusterNamePrivateEndpointConnectionsByPrivateEndpointConnectionName description: Gets the specified private endpoint connection associated with the RedisEnterprise cluster. x-ms-examples: RedisEnterpriseGetPrivateEndpointConnection: $ref: ./examples/RedisEnterpriseGetPrivateEndpointConnection.json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ClusterNameParameter_2' - $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK -- Get the private endpoint connection properties successfully. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet put: tags: - Private Endpoint Connections 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: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ClusterNameParameter_2' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '201': description: OK -- Update the private endpoint connection properties successfully. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups… requestBody: content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. required: true security: - azure_auth: - user_impersonation delete: tags: - Private Endpoint Connections operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftCacheRedisEnterpriseByClusterNamePrivateEndpointConnectionsByPrivateEndpointConnectionName description: Deletes the specified private endpoint connection associated with the RedisEnterprise cluster. x-ms-examples: RedisEnterpriseDeletePrivateEndpointConnection: $ref: ./examples/RedisEnterpriseDeletePrivateEndpointConnection.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/components/parameters/ClusterNameParameter_2' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Delete the private endpoint connection successfully. '202': description: Deletion of specified private endpoint connection was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status. headers: Location: description: Location URI to poll for result schema: type: string Azure-AsyncOperation: description: URI to poll for the operation status schema: type: string '204': description: No Content -- The private endpoint connection does not exist. default: description: Error response describing why the operation failed. content: application/json: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName} : put: tags: - Private Endpoint Connections operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftSearchSearchServicesBySearchServiceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/ResourceGroupNameParameter_4' - $ref: '#/components/parameters/SearchServiceNameParameter' - $ref: '#/components/parameters/PrivateEndpointConnectionNameParameter_2' - $ref: '#/components/parameters/ClientRequestIdParameter' - $ref: '#/components/parameters/ApiVersionParameter_6' - $ref: '#/components/parameters/SubscriptionIdParameter_6' responses: '200': description: The existing private endpoint connection definition was successfully updated. content: application/json: schema: $ref: '#/components/schemas/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.' content: application/json: schema: $ref: '#/components/schemas/CloudError_2' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups… requestBody: content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_6' description: The definition of the private endpoint connection to update. required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsUpdate get: tags: - Private Endpoint Connections operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftSearchSearchServicesBySearchServiceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/ResourceGroupNameParameter_4' - $ref: '#/components/parameters/SearchServiceNameParameter' - $ref: '#/components/parameters/PrivateEndpointConnectionNameParameter_2' - $ref: '#/components/parameters/ClientRequestIdParameter' - $ref: '#/components/parameters/ApiVersionParameter_6' - $ref: '#/components/parameters/SubscriptionIdParameter_6' responses: '200': description: The definition of the private endpoint connection was successfully retrieved and is in the response. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnection_6' default: description: 'HTTP 404 (Not Found): The subscription, resource group, search service or private endpoint connection could not be found.' content: application/json: schema: $ref: '#/components/schemas/CloudError_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsGet delete: tags: - Private Endpoint Connections operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftSearchSearchServicesBySearchServiceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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: '#/components/parameters/ResourceGroupNameParameter_4' - $ref: '#/components/parameters/SearchServiceNameParameter' - $ref: '#/components/parameters/PrivateEndpointConnectionNameParameter_2' - $ref: '#/components/parameters/ClientRequestIdParameter' - $ref: '#/components/parameters/ApiVersionParameter_6' - $ref: '#/components/parameters/SubscriptionIdParameter_6' 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. content: application/json: schema: $ref: '#/components/schemas/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. content: application/json: schema: $ref: '#/components/schemas/CloudError_2' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsDelete servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections : get: tags: - Private Endpoint Connections 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: '#/components/parameters/ClientRequestIdParameter' - $ref: '#/components/parameters/ApiVersionParameter_6' - $ref: '#/components/parameters/SubscriptionIdParameter_6' - $ref: '#/components/parameters/ResourceGroupNameParameter_4' - $ref: '#/components/parameters/SearchServiceNameParameter' responses: '200': description: The operation succeeded. The response contains the list of all private endpoint connections for the given service. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionListResult_6' default: description: An unexpected error occurred during the operation. content: application/json: schema: $ref: '#/components/schemas/CloudError_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateEndpointConnections : get: tags: - Private Endpoint Connections operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftSecurityAndCompliancePrivateLinkServicesForSCCPowershellByResourceNamePrivateEndpointConnections 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. content: application/json: schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnectionListResult default: description: DefaultErrorResponse content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsforsccpowershellListbyservice servers: - url: https://management.azure.com ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - Private Endpoint Connections operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftSecurityAndCompliancePrivateLinkServicesForSCCPowershellByResourceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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. content: application/json: schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection default: description: DefaultErrorResponse content: application/json: schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateEndpointConnection_GetConnection: $ref: ./examples/SCCPowershellServiceGetPrivateEndpointConnection.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsforsccpowershellGet put: tags: - Private Endpoint Connections operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftSecurityAndCompliancePrivateLinkServicesForSCCPowershellByResourceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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 responses: '200': description: OK. The request was successful; the request was well-formed and received properly. content: application/json: schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection '201': description: Created. The request was successful; the request was well-formed and received properly. content: application/json: schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection default: description: DefaultErrorResponse content: application/json: 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… requestBody: content: application/json: schema: $ref: ./common-types.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. required: true security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsforsccpowershellCreateorupdate delete: tags: - Private Endpoint Connections description: Deletes a private endpoint connection. operationId: deleteSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftSecurityAndCompliancePrivateLinkServicesForSCCPowershellByResourceNamePrivateEndpointConnectionsByPrivateEndpointConnectionName 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 content: application/json: 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… security: - azure_auth: - user_impersonation x-operation-id-source: normalized x-operation-id-original: microsoftAzurePrivateendpointconnectionsforsccpowershellDelete servers: - url: https://management.azure.com components: parameters: ApiVersionParameter: name: api-version in: query description: The client API version. required: true schema: type: string ResourceGroupNameParameter: name: resourceGroupName in: path description: The name of the resource group to which the container registry belongs. required: true x-ms-parameter-location: method schema: type: string SubscriptionIdParameter: name: subscriptionId in: path description: The Microsoft Azure subscription ID. required: true schema: type: string ConfigStoreNameParameter: name: configStoreName in: path description: The name of the configuration store. required: true x-ms-parameter-location: method schema: type: string maxLength: 50 minLength: 5 pattern: ^[a-zA-Z0-9_-]*$ ProviderName: name: providerName in: path required: true description: The name of the attestation provider. x-ms-parameter-location: method schema: type: string pattern: ^[a-zA-Z0-9-]{3,24}$ DataManagerForAgricultureResourceNameParameter: in: path name: dataManagerForAgricultureResourceName description: DataManagerForAgriculture resource name. required: true x-ms-parameter-location: method schema: type: string maxLength: 63 minLength: 1 pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ resourceGroupNameParameter: name: resourceGroupName x-ms-parameter-location: method in: path required: true description: The name of the Bot resource group in the user subscription. schema: type: string maxLength: 64 minLength: 2 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ apiVersionParameter: name: api-version in: query required: true description: Version of the API to be used with the client request. schema: type: string subscriptionIdParameter: name: subscriptionId in: path description: Azure Subscription ID. required: true schema: type: string resourceNameParameter: name: resourceName x-ms-parameter-location: method in: path required: true description: The name of the Bot resource. schema: type: string maxLength: 64 minLength: 2 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ PrivateEndpointConnectionNameParameter: name: privateEndpointConnectionName in: path required: true description: The name of the private endpoint connection associated with the cluster. x-ms-parameter-location: method schema: type: string pattern: ^[-\w\._]+$ ClusterNameParameter: name: clusterName in: path required: true description: The name of the cluster. x-ms-parameter-location: method schema: type: string maxLength: 40 minLength: 3 pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?