swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector PrivateLinkResources API schemes: - https tags: - name: PrivateLinkResources paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesListbyconfigurationstore description: Gets the private link resources that need to be created for a configuration store. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ConfigStoreNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/PrivateLinkResourceListResult' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: PrivateLinkResources_ListGroupIds: $ref: ./examples/PrivateLinkResourcesListByConfigurationStore.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources/{groupName} : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesGet description: Gets a private link resource that need to be created for a configuration store. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ConfigStoreNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: groupName in: path description: The name of the private link resource group. required: true type: string responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/PrivateLinkResource' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: PrivateLinkResources_Get: $ref: ./examples/PrivateLinkResourceGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename Privatelinkresources Groupname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateLinkResources : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesListbyprovider description: Gets the private link resources supported for the attestation provider. x-ms-examples: AttestationProviderListPrivateLinkResources: $ref: ./examples/AttestationProviderListPrivateLinkResources.json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ProviderName' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter responses: '200': description: OK - Successfully retrieved private link resources. schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/privateLinkResources : get: tags: - PrivateLinkResources description: Get list of Private link resources. operationId: microsoftAzurePrivatelinkresourcesListbyresource produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter' - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateLinkResourceListResult default: description: Error schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkResources_ListByResource: $ref: ./examples/PrivateLinkResources_ListByResource.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/privateLinkResources/{subResourceName} : get: tags: - PrivateLinkResources description: Get Private link resource object. operationId: microsoftAzurePrivatelinkresourcesGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter' - in: path name: subResourceName description: Sub resource name. required: true type: string - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateLinkResource '404': description: Not Found x-ms-error-response: true schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse default: description: Error schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkResources_Get: $ref: ./examples/PrivateLinkResources_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Privatelinkresources Subresourcename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateLinkResources : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesListbybotresource description: Gets the private link resources that need to be created for a Bot. x-ms-examples: List Private Link Resources: $ref: ./examples/ListPrivateLinkResources.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter' - $ref: '#/parameters/subscriptionIdParameter' responses: '200': description: Successfully retrieved private link resources. schema: $ref: ./privatelinks.json#/definitions/PrivateLinkResourceListResult default: description: Default error response x-ms-error-response: true schema: $ref: '#/definitions/Error' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateLinkResources : get: description: Gets the private link resources for cluster. tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesListbycluster x-ms-examples: Gets the private link resources for cluster.: $ref: ./examples/PrivateLinkResourceListByCluster.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' responses: '200': description: Successfully retrieved private link resources. schema: $ref: '#/definitions/PrivateLinkResourceListResult_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/privateLinkResources/{privateLinkResourceName} : get: description: Gets a private link resource for cluster. tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesGet x-ms-examples: Gets a private link resource for cluster.: $ref: ./examples/PrivateLinkResourcesGet.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/PrivateLinkResourceName' responses: '200': description: Successfully retrieved private link resources. schema: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateLinkResource default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Privatelinkresources Privatelinkresourcename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/privateLinkResources : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesListbyaccount description: Gets the private link resources that are available to be used for the Maps Account. x-ms-examples: PrivateLinkResources_List: $ref: ./examples/PrivateLinkResources_List.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter' responses: '200': description: Successfully retrieved private link resources. schema: $ref: '#/definitions/PrivateLinkResourceList' default: description: Error message indicating why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/privateLinkResources/{privateLinkResourceName} : get: tags: - PrivateLinkResources description: Gets a private link resource by name which can be used for the Maps Account. operationId: microsoftAzurePrivatelinkresourcesGet x-ms-examples: Get a private link resource.: $ref: ./examples/PrivateLinkResources_Get.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/PrivateLinkResourceNameParameter' responses: '200': description: Successfully retrieved a specified private link resource. schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResource default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Maps Accounts Accountname Privatelinkresources Privatelinkresourcename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.aadiam/privateLinkForAzureAd/{policyName}/privateLinkResources : get: tags: - PrivateLinkResources description: Gets the private link resources that need to be created for a policy of AzureAD. operationId: microsoftAzurePrivatelinkresourcesListbyprivatelinkpolicy x-ms-pageable: nextLinkName: nextLink parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/policyNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully retrieved private link resources. schema: $ref: '#/definitions/PrivateLinkResourceListResult_3' x-ms-examples: Gets private endpoint connection.: $ref: ./examples/AzureADPrivateLinkResourceListGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Aadiam Privatelinkforazuread Policyname Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.aadiam/privateLinkForAzureAd/{policyName}/privateLinkResources/{groupName} : get: tags: - PrivateLinkResources description: Gets the private link resources that need to be created for a policy of AzureAD. operationId: microsoftAzurePrivatelinkresourcesGet parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/policyNameParameter' - $ref: '#/parameters/groupNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully retrieved a specified private link resource. schema: $ref: '#/definitions/PrivateLinkResource_2' x-ms-examples: Gets private endpoint connection.: $ref: ./examples/AzureADPrivateLinkResourceGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Aadiam Privatelinkforazuread Policyname Privatelinkresources Groupname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources : get: tags: - PrivateLinkResources summary: Microsoft Azure List Private Link Resources description: List private link resources for a given workspace operationId: microsoftAzurePrivatelinkresourcesList x-ms-examples: List private link resources: $ref: ./examples/ListPrivateLinkResources.json parameters: - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/WorkspaceName' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' responses: '200': description: OK - Returns an array of private link resources schema: $ref: '#/definitions/PrivateLinkResourcesList' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorResponse_2' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources/{groupId} : get: tags: - PrivateLinkResources summary: Microsoft Azure Get The Specified Private Link Resource description: Get the specified private link resource for the given group id (sub-resource) operationId: microsoftAzurePrivatelinkresourcesGet x-ms-examples: Get a private link resource: $ref: ./examples/PrivateLinkResourcesGet.json parameters: - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/WorkspaceName' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/GroupId' responses: '200': description: OK - Returns the specified of private link resource schema: $ref: '#/definitions/GroupIdInformation' default: description: DefaultErrorResponse schema: $ref: '#/definitions/ErrorResponse_2' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateLinkResources : get: tags: - PrivateLinkResources description: List all private link resources in a device update account. operationId: microsoftAzurePrivatelinkresourcesListbyaccount parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_2' responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/PrivateLinkResourceListResult_4' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkResourcesList: $ref: ./examples/PrivateLinkResources/PrivateLinkResources_ListByAccount.json x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateLinkResources/{groupId} : get: tags: - PrivateLinkResources description: Get the specified private link resource associated with the device update account. operationId: microsoftAzurePrivatelinkresourcesGet parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/SubscriptionIdParameter_3' - $ref: '#/parameters/ResourceGroupNameParameter_2' - $ref: '#/parameters/AccountNameParameter_2' - $ref: '#/parameters/GroupIdParameter' responses: '200': description: The request was successful; the request was well-formed and received properly. schema: $ref: '#/definitions/GroupInformation' default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PrivateLinkResourcesGet: $ref: ./examples/PrivateLinkResources/PrivateLinkResources_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceupdate Accounts Accountname Privatelinkresources Groupid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources/{privateLinkResourceName} : get: tags: - PrivateLinkResources summary: Microsoft Azure Get A Private Link Resource description: Get properties of a private link resource. operationId: microsoftAzurePrivatelinkresourcesGet consumes: [] produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter_4' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true type: string - name: parentType in: path description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'. required: true type: string - name: parentName in: path description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). required: true type: string - name: privateLinkResourceName in: path description: The name of private link resource. required: true type: string - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/PrivateLinkResource_3' default: description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." x-ms-examples: PrivateLinkResources_Get: $ref: ./examples/PrivateLinkResources_Get.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources : get: tags: - PrivateLinkResources summary: Microsoft Azure List Private Link Resources Under Specific Topic, Domain, Or Partner Namespace description: List all the private link resources under a topic, domain, or partner namespace. operationId: microsoftAzurePrivatelinkresourcesListbyresource consumes: [] produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter_4' - name: resourceGroupName in: path description: The name of the resource group within the user's subscription. required: true type: string - name: parentType in: path description: The type of the parent resource. This can be either \'topics\', \'domains\', or \'partnerNamespaces\'. required: true type: string - name: parentName in: path description: The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name). required: true type: string - $ref: '#/parameters/ApiVersionParameter_4' - $ref: '#/parameters/FilterParameter' - $ref: '#/parameters/TopParameter' responses: '200': description: OK schema: $ref: '#/definitions/PrivateLinkResourcesListResult' default: description: "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." x-ms-examples: PrivateLinkResources_ListByResource: $ref: ./examples/PrivateLinkResources_ListByResource.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources : get: tags: - PrivateLinkResources description: Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope. operationId: microsoftAzurePrivatelinkresourcesListbyprivatelinkscope x-ms-pageable: nextLinkName: nextLink parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' responses: '200': description: Successfully retrieved private link resources. schema: $ref: '#/definitions/PrivateLinkResourceListResult_5' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Gets private endpoint connection.: $ref: ./examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_ListGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Privatelinkscopes Scopename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources/{groupName} : get: tags: - PrivateLinkResources description: Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope. operationId: microsoftAzurePrivatelinkresourcesGet parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' - $ref: '#/parameters/GroupNameParameter' responses: '200': description: Successfully retrieved a specified private link resource. schema: $ref: '#/definitions/PrivateLinkResource_4' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Gets private endpoint connection.: $ref: ./examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Privatelinkscopes Scopename Privatelinkresources Groupname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateLinkResources : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesforsccpowershellListbyservice description: Gets the private link resources that need to be created 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: The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateLinkResourceListResult default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateLinkResources_ListGroupIds: $ref: ./examples/SCCPowershellPrivateLinkResourcesListByService.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft M365securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateLinkResources/{groupName} : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesforsccpowershellGet description: Gets a private link resource that need to be created 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 - name: groupName in: path description: The name of the private link resource group. required: true type: string responses: '200': description: OK. The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateLinkResource default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateLinkResources_Get: $ref: ./examples/SCCPowershellPrivateLinkResourceGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft M365securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privatelinkresources Groupname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateLinkResources : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesListbystoragesyncservice description: Gets the private link resources that need to be created for a storage sync service. x-ms-examples: PrivateLinkResources_List: $ref: ./examples/PrivateLinkResources_List.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageSyncServiceNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Successfully retrieved private link resources. schema: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceListResult default: description: Error message indicating why the operation failed. schema: $ref: '#/definitions/StorageSyncError' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/{scopeName}/privateLinkResources : get: tags: - PrivateLinkResources description: Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope. operationId: microsoftAzurePrivatelinkresourcesListbyprivatelinkscope parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' responses: '200': description: Successfully retrieved private link resources. schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateLinkResourceListResult default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Gets private endpoint connection.: $ref: ./examples/PrivateLinkScopePrivateLinkResourceListGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kubernetesconfiguration Privatelinkscopes Scopename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/{scopeName}/privateLinkResources/{groupName} : get: tags: - PrivateLinkResources description: Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope. operationId: microsoftAzurePrivatelinkresourcesGet parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName' - $ref: '#/parameters/GroupNameParameter' responses: '200': description: Successfully retrieved a specified private link resource. schema: $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateLinkResource default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Gets private endpoint connection.: $ref: ./examples/PrivateLinkScopePrivateLinkResourceGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Kubernetesconfiguration Privatelinkscopes Scopename Privatelinkresources Groupname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateLinkResources : get: tags: - PrivateLinkResources description: Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope. operationId: microsoftAzurePrivatelinkresourcesListbyprivatelinkscope parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName_2' responses: '200': description: Successfully retrieved private link resources. schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResourceListResult default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Gets private endpoint connection.: $ref: ./examples/PrivateLinkScopePrivateLinkResourceListGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Privatelinkscopes Scopename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateLinkResources/{groupName} : get: tags: - PrivateLinkResources description: Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope. operationId: microsoftAzurePrivatelinkresourcesGet parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/PrivateLinkScopeName_2' - $ref: '#/parameters/GroupNameParameter' responses: '200': description: Successfully retrieved a specified private link resource. schema: $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResource default: description: An error occurred. schema: $ref: '#/definitions/DefaultErrorResponse' x-ms-examples: Gets private endpoint connection.: $ref: ./examples/PrivateLinkScopePrivateLinkResourceGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Insights Privatelinkscopes Scopename Privatelinkresources Groupname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/enterprisePolicies/{enterprisePolicyName}/privateLinkResources : get: tags: - PrivateLinkResources description: Gets the private link resources that need to be created for enterprisePolicy. operationId: microsoftAzurePrivatelinkresourcesListbyenterprisepolicy x-ms-pageable: nextLinkName: null 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: ../../common/v1/definitions.json#/parameters/EnterprisePolicyNameParameter responses: '200': description: Successfully retrieved private link resources. schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Gets private endpoint connection.: $ref: ./examples/PrivateLinkResourceListGet.json produces: - application/json consumes: - application/json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Powerplatform Enterprisepolicies Enterprisepolicyname Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/enterprisePolicies/{enterprisePolicyName}/privateLinkResources/{groupName} : get: tags: - PrivateLinkResources description: Gets the private link resources that need to be created for an EnterprisePolicy. operationId: microsoftAzurePrivatelinkresourcesGet 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: ../../common/v1/definitions.json#/parameters/EnterprisePolicyNameParameter - $ref: '#/parameters/GroupNameParameter' responses: '200': description: Successfully retrieved a specified private link resource. schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResource default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Gets private endpoint connection.: $ref: ./examples/PrivateLinkResourceGet.json produces: - application/json consumes: - application/json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Powerplatform Enterprisepolicies Enterprisepolicyname Privatelinkresources Groupname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}/privateLinkResources : get: tags: - PrivateLinkResources summary: Microsoft Azure List Private Link Power Bi Resource description: List private link resources under a specific Power BI resource. operationId: microsoftAzurePrivatelinkresourcesListbyresource parameters: - $ref: '#/parameters/SubscriptionIdParameter_5' - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/AzureResourceNameParameter' - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: OK schema: type: object $ref: '#/definitions/PrivateLinkResourcesListResult_2' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: An error response received from Power BI service. x-ms-examples: Gets private link resources in a Azure resource: $ref: ./examples/PrivateLinkResources_ListByResource.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/{azureResourceName}/privateLinkResources/{privateLinkResourceName} : get: tags: - PrivateLinkResources summary: Microsoft Azure Get A Private Link Resource description: Get properties of a private link resource. operationId: microsoftAzurePrivatelinkresourcesGet parameters: - $ref: '#/parameters/SubscriptionIdParameter_5' - $ref: '#/parameters/ResourceGroupNameParameter_3' - $ref: '#/parameters/AzureResourceNameParameter' - name: privateLinkResourceName in: path description: The name of private link resource. required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: OK schema: type: object $ref: '#/definitions/PrivateLinkResource_5' default: schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse description: An error response received from Power BI service. x-ms-examples: Gets a private link resource: $ref: ./examples/PrivateLinkResources_Get.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateLinkResources : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesListbyredisenterprisecache description: Gets the private link resources that need to be created for a RedisEnterprise cluster. x-ms-examples: RedisEnterpriseListPrivateLinkResources: $ref: ./examples/RedisEnterpriseListPrivateLinkResources.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter_4' - $ref: '#/parameters/ClusterNameParameter_2' - $ref: '#/parameters/ApiVersionParameter_6' - $ref: '#/parameters/SubscriptionIdParameter_6' responses: '200': description: Successfully retrieved private link resources. schema: $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateLinkResources : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesget x-ms-examples: RelayPrivateLinkResourcesList: $ref: ./examples/PrivateEndpointConnections/ListPrivateLinkResources.json description: Gets the private link resources supported for the Relay namespace parameters: - $ref: ../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter - $ref: ../../common/v1/definitions.json#/parameters/NamespaceNameParameter - $ref: ../../common/v1/definitions.json#/parameters/ApiVersionParameter - $ref: ../../common/v1/definitions.json#/parameters/SubscriptionIdParameter responses: '200': description: Successfully retrieved private link resources. schema: $ref: '#/definitions/PrivateLinkResourceListResult_6' default: description: Relay error response describing why the operation failed. schema: $ref: ../../common/v1/definitions.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Relay Namespaces Namespacename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources : get: tags: - PrivateLinkResources x-ms-pageable: nextLinkName: null operationId: microsoftAzurePrivatelinkresourcesListsupported x-ms-examples: ListSupportedPrivateLinkResources: $ref: ./examples/ListSupportedPrivateLinkResources.json description: Gets a list of all supported private link resource types for the given service. externalDocs: url: https://aka.ms/search-manage parameters: - $ref: '#/parameters/ClientRequestIdParameter' - $ref: '#/parameters/ApiVersionParameter_7' - $ref: '#/parameters/SubscriptionIdParameter_7' - $ref: '#/parameters/ResourceGroupNameParameter_5' - $ref: '#/parameters/SearchServiceNameParameter' responses: '200': description: The operation succeeded. The response contains the list of all supported private link resource types for the given service. schema: $ref: '#/definitions/PrivateLinkResourcesResult' default: description: An unexpected error occurred during the operation. schema: $ref: '#/definitions/CloudError_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Search Searchservices Searchservicename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateLinkResources : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesforsccpowershellListbyservice description: Gets the private link resources that need to be created 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: The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateLinkResourceListResult default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateLinkResources_ListGroupIds: $ref: ./examples/SCCPowershellPrivateLinkResourcesListByService.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/{resourceName}/privateLinkResources/{groupName} : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesforsccpowershellGet description: Gets a private link resource that need to be created 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 - name: groupName in: path description: The name of the private link resource group. required: true type: string responses: '200': description: OK. The request was successful; the request was well-formed and received properly. schema: $ref: ./common-types.json#/definitions/PrivateLinkResource default: description: DefaultErrorResponse schema: $ref: ./common-types.json#/definitions/ErrorDetails x-ms-examples: PrivateLinkResources_Get: $ref: ./examples/SCCPowershellPrivateLinkResourceGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securityandcompliance Privatelinkservicesforsccpowershell Resourcename Privatelinkresources Groupname definitions: PrivateLinkResourceList: description: A list of private link resources for a Maps Account resource type. type: object properties: value: description: The list of the private link resources which can be used for Maps Account. type: array items: $ref: ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResource x-ms-identifiers: [] nextLink: description: Request URL that can be used to query next page of private link resources. Returned when the total number of requested private resources exceed maximum page size. type: string format: uri readOnly: true ErrorDetail: title: Error details. type: object properties: code: description: The error's code. type: string message: description: A human readable error message. type: string target: description: Indicates which property in the request is responsible for the error. type: string required: - code - message PrivateLinkResourcesListResult_2: title: PrivateLinkResourcesListResult description: Specifies list of the private link resource. type: object properties: value: description: A collection of private endpoint connection resources. type: array items: $ref: '#/definitions/PrivateLinkResource_5' nextLink: type: string description: URL to get the next set of operation list results (if there are any). readOnly: true PrivateLinkResourceListResult_4: description: The available private link resources for an Account type: object properties: value: description: The list of available private link resources for an Account type: array items: $ref: '#/definitions/GroupInformation' nextLink: description: The URI that can be used to request the next list of private link resources. type: string PrivateLinkResourceProperties_5: type: object properties: groupId: description: The private link resource group id. type: string readOnly: true requiredMembers: description: The private link resource required member names. type: array items: type: string readOnly: true requiredZoneNames: type: array items: type: string description: The private link resource Private link DNS zone name. description: Properties of a private link resource. PrivateLinkResourceListResult_5: type: object description: A list of private link resources properties: value: description: Array of results. type: array items: $ref: '#/definitions/PrivateLinkResource_4' readOnly: true nextLink: description: Link to retrieve next page of results. type: string readOnly: true Error: properties: error: $ref: '#/definitions/ErrorBody' description: The error body. description: Bot Service error object. StorageSyncError: type: object description: Error type properties: error: $ref: '#/definitions/StorageSyncApiError' description: Error details of the given entry. innererror: $ref: '#/definitions/StorageSyncApiError' description: Error details of the given entry. ErrorDetails: description: The details of the error. properties: code: description: Error code. type: string readOnly: true message: description: Error message indicating why the operation failed. type: string readOnly: true additionalInfo: readOnly: true type: array items: $ref: '#/definitions/ErrorAdditionalInfo' x-ms-identifiers: [] description: The error additional info. CloudErrorBody: x-ms-external: true properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the error, intended to be suitable for displaying in a user interface. description: An error response from Attestation. PrivateLinkResourceProperties_3: type: object properties: groupId: type: string displayName: type: string requiredMembers: type: array items: type: string requiredZoneNames: type: array items: type: string ErrorBody: properties: code: type: string description: error code message: type: string description: error message description: Bot Service error body. required: - code - message PrivateLinkResource_7: properties: properties: $ref: '#/definitions/PrivateLinkResourceProperties_7' readOnly: true description: Describes the properties of a supported private link resource for the Azure Cognitive Search service. allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/Resource description: Describes a supported private link resource for the Azure Cognitive Search service. ARMProxyResource: type: object description: The resource model definition for a ARM proxy resource. It will have everything other than required location and tags properties: id: readOnly: true type: string description: The unique resource identifier of the Azure AD PrivateLink Policy. name: readOnly: true type: string description: The name of the Azure AD PrivateLink Policy. type: readOnly: true type: string description: The type of Azure resource. x-ms-azure-resource: true GroupInformation: description: The group information for creating a private endpoint on an Account type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: description: The properties for a group information object x-ms-client-flatten: true $ref: '#/definitions/GroupInformationProperties' required: - properties GroupIdInformation: description: The group information for creating a private endpoint on a workspace type: object properties: id: readOnly: true type: string description: The resource identifier. name: readOnly: true type: string description: The resource name. type: readOnly: true type: string description: The resource type. properties: description: The group id properties. type: object x-ms-client-flatten: false $ref: '#/definitions/GroupIdInformationProperties' allOf: - $ref: '#/definitions/Resource' required: - properties CloudErrorBody_2: type: object description: Describes a particular API error with an error code and a message. properties: code: type: string description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. message: type: string description: A message that describes the error in detail and provides debugging information. target: type: string description: The target of the particular error (for example, the name of the property in error). details: type: array items: $ref: '#/definitions/CloudErrorBody_2' description: Contains nested errors that are related to this error. x-ms-external: true PrivateLinkResource_3: description: Information of the private link resource. type: object properties: properties: $ref: '#/definitions/PrivateLinkResourceProperties_3' description: Properties of the private link resource. x-ms-client-flatten: true id: description: Fully qualified identifier of the resource. type: string name: description: Name of the resource. type: string type: description: Type of the resource. type: string ErrorResponse: description: Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. type: object properties: error: description: The details of the error. $ref: '#/definitions/ErrorDetails' ShareablePrivateLinkResourceType: properties: name: readOnly: true type: string description: The name of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search. properties: $ref: '#/definitions/ShareablePrivateLinkResourceProperties' readOnly: true description: Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search. description: Describes an resource type that has been onboarded to private link service, supported by Azure Cognitive Search. ShareablePrivateLinkResourceProperties: properties: type: readOnly: true type: string description: The resource provider type for the resource that has been onboarded to private link service, supported by Azure Cognitive Search. groupId: readOnly: true type: string description: The resource provider group id for the resource that has been onboarded to private link service, supported by Azure Cognitive Search. description: readOnly: true type: string description: The description of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search. description: Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search. GroupInformationProperties: description: The properties for a group information object type: object allOf: - $ref: ./privatelinks.json#/definitions/PrivateLinkResourceProperties properties: provisioningState: description: The provisioning state of private link group ID. enum: - Succeeded - Failed - Canceled type: string readOnly: true x-ms-enum: name: GroupIdProvisioningState modelAsString: true ErrorInfo: title: The code and message for an error. type: object properties: code: description: A machine readable error code. type: string message: description: A human readable error message. type: string details: description: error details. type: array items: $ref: '#/definitions/ErrorDetail' innererror: description: Inner error details if they exist. type: string required: - code - message PrivateLinkResourceListResult_6: properties: value: type: array description: Array of private link resources items: $ref: '#/definitions/PrivateLinkResource_6' description: A list of private link resources StorageSyncErrorDetails: type: object description: Error Details object. properties: code: type: string description: Error code of the given entry. message: type: string description: Error message of the given entry. target: type: string description: Target of the given entry. requestUri: type: string description: Request URI of the given entry. exceptionType: type: string description: Exception type of the given entry. httpMethod: type: string description: HTTP method of the given entry. hashedMessage: type: string description: Hashed message of the given entry. httpErrorCode: type: string description: HTTP error code of the given entry. PrivateLinkResource_6: properties: properties: $ref: '#/definitions/PrivateLinkResourceProperties_6' description: Resource properties. x-ms-client-flatten: true allOf: - $ref: ../../common/v1/definitions.json#/definitions/Resource description: A private link resource Resource: description: The core properties of ARM resources properties: id: readOnly: true type: string description: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} name: readOnly: true type: string description: The name of the resource type: readOnly: true type: string description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. x-ms-azure-resource: true DefaultErrorResponse: title: Default error response description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). type: object properties: error: description: The error object. $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail PrivateLinkResourcesListResult: description: Result of the List private link resources operation. type: object properties: value: description: A collection of private link resources type: array items: $ref: '#/definitions/PrivateLinkResource_3' nextLink: description: A link for the next page of private link resources. type: string PrivateLinkResource_2: description: A private link resource type: object properties: properties: $ref: '#/definitions/PrivateLinkResourceProperties_2' description: Resource properties. x-ms-client-flatten: true allOf: - $ref: '#/definitions/ARMProxyResource' PrivateLinkResource: type: object description: A resource that supports private link capabilities. properties: id: description: The resource ID. type: string readOnly: true name: description: The name of the resource. type: string readOnly: true type: description: The type of the resource. type: string readOnly: true properties: $ref: '#/definitions/PrivateLinkResourceProperties' description: Private link resource properties. x-ms-client-flatten: true PrivateLinkResourceProperties_7: properties: groupId: readOnly: true type: string description: The group ID of the private link resource. requiredMembers: readOnly: true type: array items: type: string description: The list of required members of the private link resource. requiredZoneNames: readOnly: true type: array items: type: string description: The list of required DNS zone names of the private link resource. shareablePrivateLinkResourceTypes: readOnly: true type: array items: $ref: '#/definitions/ShareablePrivateLinkResourceType' description: The list of resources that are onboarded to private link service, that are supported by Azure Cognitive Search. description: Describes the properties of a supported private link resource for the Azure Cognitive Search service. For a given API version, this represents the 'supported' groupIds when creating a shared private link resource. PrivateLinkResourceProperties_4: type: object description: Properties of a private link resource. properties: groupId: description: The private link resource group id. type: string readOnly: true requiredMembers: description: The private link resource required member names. type: array items: type: string readOnly: true requiredZoneNames: description: Required DNS zone names of the the private link resource. type: array items: type: string readOnly: true StorageSyncApiError: type: object description: Error type properties: code: type: string description: Error code of the given entry. message: type: string description: Error message of the given entry. target: type: string description: Target of the given error entry. details: $ref: '#/definitions/StorageSyncErrorDetails' description: Error details of the given entry. innererror: $ref: '#/definitions/StorageSyncInnerErrorDetails' description: Inner error details of the given entry. PrivateLinkResourcesResult: properties: value: readOnly: true type: array items: $ref: '#/definitions/PrivateLinkResource_7' description: The list of supported Private Link Resources. description: Response containing a list of supported Private Link Resources. x-ms-external: true GroupIdInformationProperties: description: The properties for a group information object type: object properties: groupId: type: string description: The group id requiredMembers: description: The required members for a specific group id type: array items: type: string requiredZoneNames: description: The required DNS zones for a specific group id type: array items: type: string PrivateLinkResourceProperties_6: properties: groupId: description: Group identifier of private link resource. type: string readOnly: true requiredMembers: description: Required member names of private link resource. type: array items: type: string readOnly: true requiredZoneNames: type: array items: type: string description: Required DNS zone names of the the private link resource. description: Properties of a private link resource. PrivateLinkResourceListResult_2: type: object properties: value: type: array description: Array of private link resources items: $ref: ../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateLinkResource description: A list of private link resources. PrivateLinkResourceListResult: type: object description: A list of private link resources. properties: value: description: The collection value. type: array items: $ref: '#/definitions/PrivateLinkResource' nextLink: description: The URI that can be used to request the next set of paged results. type: string PrivateLinkResourceProperties: type: object properties: groupId: description: The private link resource group id. type: string readOnly: true requiredMembers: description: The private link resource required member names. type: array items: type: string readOnly: true requiredZoneNames: type: array items: type: string readOnly: true description: The list of required DNS zone names of the private link resource. description: Properties of a private link resource. CloudError_2: type: object properties: error: $ref: '#/definitions/CloudErrorBody_2' description: Describes a particular API error with an error code and a message. message: type: string description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). description: Contains information about an API error. x-ms-external: true StorageSyncInnerErrorDetails: type: object description: Error Details object. properties: callStack: type: string description: Call stack of the error. message: type: string description: Error message of the error. innerException: type: string description: Exception of the inner error. innerExceptionCallStack: type: string description: Call stack of the inner error. PrivateLinkResourceProperties_2: description: Properties of a private link resource. type: object properties: groupId: description: The private link resource group id. type: string readOnly: true requiredMembers: description: The private link resource required member names. type: array items: type: string readOnly: true ErrorAdditionalInfo: properties: type: readOnly: true type: string description: The additional info type. info: readOnly: true type: object description: The additional info. description: The resource management error additional info. ErrorResponse_2: title: Error response. description: Contains details when the response code indicates an error. type: object properties: error: description: The error details. $ref: '#/definitions/ErrorInfo' required: - error PrivateLinkResourceListResult_3: description: A list of private link resources type: object properties: value: type: array description: Array of private link resources items: $ref: '#/definitions/PrivateLinkResource_2' nextLink: description: The link used to get the next page of operations. type: string PrivateLinkResource_4: type: object description: A private link resource properties: properties: $ref: '#/definitions/PrivateLinkResourceProperties_4' description: Resource properties. systemData: readOnly: true description: The system meta data relating to this resource. $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource PrivateLinkResourcesList: description: The available private link resources for a workspace type: object properties: value: description: The list of available private link resources for a workspace type: array items: $ref: '#/definitions/GroupIdInformation' nextLink: type: string description: The URL to get the next set of private link resources. PrivateLinkResource_5: description: A private link resource type: object properties: properties: $ref: '#/definitions/PrivateLinkResourceProperties_5' description: Resource properties. x-ms-client-flatten: true id: description: Fully qualified identifier of the resource. type: string name: description: Name of the resource. type: string type: description: Type of the resource. type: string CloudError: x-ms-external: true properties: error: $ref: '#/definitions/CloudErrorBody' description: An error response from Attestation. parameters: ApiVersionParameter_5: name: api-version in: query required: true type: string description: The API version to be used with the HTTP request. ApiVersionParameter_6: name: api-version in: query required: true type: string description: Client Api Version. ResourceGroupNameParameter: name: resourceGroupName in: path description: The name of the resource group to which the container registry belongs. required: true type: string x-ms-parameter-location: method ResourceGroupName: name: resourceGroupName in: path required: true type: string description: The name of the resource group. The name is case insensitive. pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 x-ms-parameter-location: method ApiVersionParameter_4: name: api-version in: query description: Version of the API to be used with the client request. required: true type: string AzureResourceNameParameter: name: azureResourceName in: path required: true type: string description: The name of the Azure resource. x-ms-parameter-location: client PrivateLinkScopeName_2: name: scopeName in: path required: true type: string description: The name of the Azure Monitor PrivateLinkScope resource. x-ms-parameter-location: method ResourceGroupNameParameter_4: name: resourceGroupName in: path required: true type: string description: The name of the resource group. x-ms-parameter-location: method ClusterNameParameter: name: clusterName in: path required: true type: string description: The name of the cluster. pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?