swagger: '2.0'
info:
version: 2020-08-01-preview
title: Microsoft Azure AccessControlClient AccessConnector PrivateLink API
schemes:
- https
tags:
- name: PrivateLink
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections
: get:
tags:
- PrivateLink
operationId: microsoftAzurePrivateendpointconnectionsListbyworkspace
description: List private endpoint connections.
x-ms-examples:
PrivateEndpointConnection_ListByWorkspace:
$ref: ./examples/PrivateEndpointConnection_ListByWorkspace.json
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/WorkspaceNameParameter'
responses:
'200':
description: Successfully retrieved connection list.
schema:
$ref: '#/definitions/PrivateEndpointConnectionListResultWithSystemData'
default:
description: Automation error response describing why the operation failed.
x-ms-error-response: true
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Workspaces Workspacename Privateendpointconnections
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
: get:
tags:
- PrivateLink
operationId: microsoftAzurePrivateendpointconnectionsGetbyworkspace
description: Get a private endpoint connection.
x-ms-examples:
PrivateEndpointConnection_GetByWorkspace:
$ref: ./examples/PrivateEndpointConnection_GetByWorkspace.json
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/WorkspaceNameParameter'
- $ref: ../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName
responses:
'200':
description: Successfully retrieved the connection.
schema:
$ref: '#/definitions/PrivateEndpointConnectionWithSystemData'
default:
description: Automation error response describing why the operation failed.
x-ms-error-response: true
schema:
$ref: '#/definitions/CloudError'
summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Workspaces Workspacename Privateendpointconnections Privateendpointconnectionname
delete:
tags:
- PrivateLink
operationId: microsoftAzurePrivateendpointconnectionsDeletebyworkspace
description: Remove a connection.
x-ms-examples:
PrivateEndpointConnection_DeleteByWorkspace:
$ref: ./examples/PrivateEndpointConnection_DeleteByWorkspace.json
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/WorkspaceNameParameter'
- $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName
responses:
'200':
description: Successfully removed.
'204':
description: Connection does not exist.
default:
description: Automation error response describing why the operation failed.
x-ms-error-response: true
schema:
$ref: '#/definitions/CloudError'
summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Workspaces Workspacename Privateendpointconnections Privateendpointconnectionname
put:
tags:
- PrivateLink
operationId: microsoftAzurePrivateendpointconnectionsUpdatebyworkspace
description: Approve or reject a private endpoint connection.
x-ms-examples:
PrivateEndpointConnection_UpdateByWorkspace:
$ref: ./examples/PrivateEndpointConnection_UpdateByWorkspace.json
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/WorkspaceNameParameter'
- $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName
- name: connection
description: Object containing the updated connection.
in: body
required: true
schema:
$ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection
responses:
'200':
description: Successfully updated.
schema:
$ref: '#/definitions/PrivateEndpointConnectionWithSystemData'
default:
description: Automation error response describing why the operation failed.
x-ms-error-response: true
schema:
$ref: '#/definitions/CloudError'
summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Workspaces Workspacename Privateendpointconnections Privateendpointconnectionname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateLinkResources
: get:
tags:
- PrivateLink
operationId: microsoftAzurePrivatelinkresourcesListbyworkspace
description: List the private link resources available for this workspace.
x-ms-examples:
PrivateLinkResources_ListByWorkspace:
$ref: ./examples/PrivateLinkResources_ListByWorkspace.json
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/WorkspaceNameParameter'
- name: pageSize
in: query
required: false
type: integer
format: int32
description: Number of items per page.
- name: isDescending
in: query
required: false
type: boolean
description: Indicates whether the collection is descending.
- name: initialSkip
in: query
required: false
type: integer
format: int32
description: Initial number of items to skip.
responses:
'200':
description: Successfully retrieved the list of resources.
schema:
$ref: '#/definitions/PrivateLinkResourceListResult'
default:
description: Automation error response describing why the operation failed.
x-ms-error-response: true
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Workspaces Workspacename Privatelinkresources
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateLinkResources
: get:
tags:
- PrivateLink
operationId: microsoftAzurePrivatelinkresourcesListbyhostpool
description: List the private link resources available for this hostpool.
x-ms-examples:
PrivateLinkResources_ListByHostPool:
$ref: ./examples/PrivateLinkResources_ListByHostPool.json
parameters:
- $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/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/HostPoolNameParameter'
- name: pageSize
in: query
required: false
type: integer
format: int32
description: Number of items per page.
- name: isDescending
in: query
required: false
type: boolean
description: Indicates whether the collection is descending.
- name: initialSkip
in: query
required: false
type: integer
format: int32
description: Initial number of items to skip.
responses:
'200':
description: Successfully retrieved the list of resources.
schema:
$ref: '#/definitions/PrivateLinkResourceListResult'
default:
description: Automation error response describing why the operation failed.
x-ms-error-response: true
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Privatelinkresources
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections
: get:
tags:
- PrivateLink
operationId: microsoftAzurePrivateendpointconnectionsListbyhostpool
description: List private endpoint connections associated with hostpool.
x-ms-examples:
PrivateEndpointConnection_ListByHostPool:
$ref: ./examples/PrivateEndpointConnection_ListByHostPool.json
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/HostPoolNameParameter'
- name: pageSize
in: query
required: false
type: integer
format: int32
description: Number of items per page.
- name: isDescending
in: query
required: false
type: boolean
description: Indicates whether the collection is descending.
- name: initialSkip
in: query
required: false
type: integer
format: int32
description: Initial number of items to skip.
responses:
'200':
description: Successfully retrieved connection list.
schema:
$ref: '#/definitions/PrivateEndpointConnectionListResultWithSystemData'
default:
description: Automation error response describing why the operation failed.
x-ms-error-response: true
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Privateendpointconnections
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}
: get:
tags:
- PrivateLink
operationId: microsoftAzurePrivateendpointconnectionsGetbyhostpool
description: Get a private endpoint connection.
x-ms-examples:
PrivateEndpointConnection_GetByHostPool:
$ref: ./examples/PrivateEndpointConnection_GetByHostPool.json
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/HostPoolNameParameter'
- $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName
responses:
'200':
description: Successfully retrieved the connection.
schema:
$ref: '#/definitions/PrivateEndpointConnectionWithSystemData'
default:
description: Automation error response describing why the operation failed.
x-ms-error-response: true
schema:
$ref: '#/definitions/CloudError'
summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Privateendpointconnections Privateendpointconnectionname
delete:
tags:
- PrivateLink
operationId: microsoftAzurePrivateendpointconnectionsDeletebyhostpool
description: Remove a connection.
x-ms-examples:
PrivateEndpointConnection_DeleteByHostPool:
$ref: ./examples/PrivateEndpointConnection_DeleteByHostPool.json
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/HostPoolNameParameter'
- $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName
responses:
'200':
description: Successfully removed.
'204':
description: Connection does not exist.
default:
description: Automation error response describing why the operation failed.
x-ms-error-response: true
schema:
$ref: '#/definitions/CloudError'
summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Privateendpointconnections Privateendpointconnectionname
put:
tags:
- PrivateLink
operationId: microsoftAzurePrivateendpointconnectionsUpdatebyhostpool
description: Approve or reject a private endpoint connection.
x-ms-examples:
PrivateEndpointConnection_UpdateByHostPool:
$ref: ./examples/PrivateEndpointConnection_UpdateByHostPool.json
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/HostPoolNameParameter'
- $ref: ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName
- name: connection
description: Object containing the updated connection.
in: body
required: true
schema:
$ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection
responses:
'200':
description: Successfully updated.
schema:
$ref: '#/definitions/PrivateEndpointConnectionWithSystemData'
default:
description: Automation error response describing why the operation failed.
x-ms-error-response: true
schema:
$ref: '#/definitions/CloudError'
summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Hostpools Hostpoolname Privateendpointconnections Privateendpointconnectionname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
: put:
tags:
- PrivateLink
summary: "Microsoft Azure Approves Or Rejects Private Endpoint Connection \r\nthis Is A Public Api That Can Be Called Directly By Notification Hubs Users"
operationId: microsoftAzurePrivateendpointconnectionsUpdate
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/PrivateEndpointConnectionName'
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- in: body
name: parameters
description: Description of the Private Endpoint Connection resource.
required: true
schema:
$ref: '#/definitions/PrivateEndpointConnectionResource'
responses:
'200':
description: Updated
schema:
$ref: '#/definitions/PrivateEndpointConnectionResource'
'201':
description: Created
schema:
$ref: '#/definitions/PrivateEndpointConnectionResource'
default:
description: Error code with reason.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
PrivateEndpointConnections_Update:
$ref: ./examples/Namespaces/PrivateEndpointConnectionUpdate.json
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
description: Needs a more full description created.
delete:
tags:
- PrivateLink
summary: "Microsoft Azure Deletes The Private Endpoint Connection \r\nthis Is A Public Api That Can Be Called Directly By Notification Hubs Users"
operationId: microsoftAzurePrivateendpointconnectionsDelete
produces:
- application/json
parameters:
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/PrivateEndpointConnectionName'
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: Accepted
headers:
Location:
type: string
'204':
description: No Content
default:
description: Error code with reason.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
PrivateEndpointConnections_Delete:
$ref: ./examples/Namespaces/PrivateEndpointConnectionDelete.json
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
description: Needs a more full description created.
get:
tags:
- PrivateLink
summary: "Microsoft Azure Returns A Private Endpoint Connection With A Given Name \r\nthis Is A Public Api That Can Be Called Directly By Notification Hubs Users"
operationId: microsoftAzurePrivateendpointconnectionsGet
produces:
- application/json
parameters:
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: '#/parameters/PrivateEndpointConnectionName'
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/PrivateEndpointConnectionResource'
default:
description: Error code with reason.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
PrivateEndpointConnections_Get:
$ref: ./examples/Namespaces/PrivateEndpointConnectionGet.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections
: get:
tags:
- PrivateLink
summary: "Microsoft Azure Returns All Private Endpoint Connections That Belong To The Given Notification Hubs Namespace \r\nthis Is A Public Api That Can Be Called Directly By Notification Hubs Users"
operationId: microsoftAzurePrivateendpointconnectionsList
produces:
- application/json
parameters:
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/PrivateEndpointConnectionResourceListResult'
default:
description: Error code with reason.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
itemName: value
nextLinkName: null
x-ms-examples:
PrivateEndpointConnections_List:
$ref: ./examples/Namespaces/PrivateEndpointConnectionList.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources/{subResourceName}
: get:
tags:
- PrivateLink
summary: "Microsoft Azure Returns Group Id Response \r\nthis Is A Public Api Required By The Networking Rp Contract It Can Be Used Directly By Notification Hubs Users"
description: Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called.
That's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.
operationId: microsoftAzurePrivateendpointconnectionsGetgroupid
produces:
- application/json
parameters:
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- in: path
name: subResourceName
description: Name of the Private Link sub-resource. The only supported sub-resource is "namespace"
required: true
type: string
pattern: ^namespace$
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/PrivateLinkResource_2'
default:
description: Error code with reason.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
PrivateEndpointConnections_GetGroupId:
$ref: ./examples/Namespaces/PrivateLinkResourceGet.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources
: get:
tags:
- PrivateLink
summary: "Microsoft Azure Returns All Group Ids Supported By The Notification Hubs Rp \r\nthis Is A Public Api Required By The Networking Rp Contract It Can Be Used Directly By Notification Hubs Users"
description: Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called.
That's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.
operationId: microsoftAzurePrivateendpointconnectionsListgroupids
produces:
- application/json
parameters:
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/NamespaceName'
- $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/PrivateLinkResourceListResult_2'
default:
description: Error code with reason.
schema:
$ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
itemName: value
nextLinkName: null
x-ms-examples:
PrivateEndpointConnections_ListGroupIds:
$ref: ./examples/Namespaces/PrivateLinkResourceList.json
definitions:
PrivateLinkConnectionStatus:
description: State of Private Link Connection.
enum:
- Disconnected
- Pending
- Approved
- Rejected
type: string
x-ms-enum:
name: PrivateLinkConnectionStatus
modelAsString: true
PrivateEndpointConnectionWithSystemData:
type: object
properties:
systemData:
$ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
allOf:
- $ref: ../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection
description: The Private Endpoint Connection resource.
CloudErrorProperties:
description: Cloud error object properties.
type: object
properties:
code:
description: Error code
type: string
message:
description: Error message indicating why the operation failed.
type: string
PrivateLinkResourceProperties_2:
description: Represents properties of Private Link Resource.
type: object
properties:
groupId:
description: A Group Id for Private Link. For Notification Hubs, it is always set to "namespace".
type: string
readOnly: true
requiredMembers:
description: Required members. For Notification Hubs, it's always a collection with a single "namespace" item.
type: array
items:
type: string
readOnly: true
requiredZoneNames:
description: Required DNS zone names. For Notification Hubs, it contains two CNames for Service Bus and Notification Hubs zones.
type: array
items:
type: string
readOnly: true
RemotePrivateEndpointConnection:
description: Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection.
type: object
properties:
id:
description: ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace.
type: string
readOnly: true
PrivateEndpointConnectionProperties:
description: Private Endpoint Connection properties.
type: object
properties:
provisioningState:
$ref: '#/definitions/PrivateEndpointConnectionProvisioningState'
privateEndpoint:
$ref: '#/definitions/RemotePrivateEndpointConnection'
groupIds:
description: List of group ids. For Notification Hubs, it always contains a single "namespace" element.
type: array
items:
type: string
readOnly: true
privateLinkServiceConnectionState:
$ref: '#/definitions/RemotePrivateLinkServiceConnectionState'
PrivateLinkResource_2:
description: A Private Link Arm Resource.
type: object
allOf:
- $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
properties:
properties:
$ref: '#/definitions/PrivateLinkResourceProperties_2'
RemotePrivateLinkServiceConnectionState:
description: State of the Private Link Service connection.
type: object
properties:
status:
$ref: '#/definitions/PrivateLinkConnectionStatus'
description:
description: Human-friendly description.
type: string
readOnly: true
actionsRequired:
description: Human-friendly description of required actions.
type: string
readOnly: true
PrivateLinkResource:
type: object
properties:
properties:
$ref: '#/definitions/PrivateLinkResourceProperties'
description: Resource properties.
x-ms-client-flatten: true
allOf:
- $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource
description: A private link resource
PrivateEndpointConnectionProvisioningState:
description: State of Private Endpoint Connection.
enum:
- Unknown
- Succeeded
- Creating
- Updating
- UpdatingByProxy
- Deleting
- DeletingByProxy
- Deleted
type: string
x-ms-enum:
name: PrivateEndpointConnectionProvisioningState
modelAsString: true
PrivateEndpointConnectionListResultWithSystemData:
type: object
properties:
value:
type: array
description: Array of private endpoint connections
items:
$ref: '#/definitions/PrivateEndpointConnectionWithSystemData'
nextLink:
type: string
readOnly: true
description: Link to the next page of results.
description: List of private endpoint connection associated with the specified storage account
CloudError:
description: Cloud error object.
type: object
x-ms-external: true
properties:
error:
$ref: '#/definitions/CloudErrorProperties'
PrivateLinkResourceListResult_2:
description: The response of the List Private Link Resources operation.
type: object
properties:
value:
description: Gets or sets result of the List AuthorizationRules operation.
type: array
items:
$ref: '#/definitions/PrivateLinkResource_2'
readOnly: true
nextLink:
description: Gets or sets link to the next set of results.
type: string
readOnly: true
PrivateLinkResourceListResult:
type: object
properties:
value:
type: array
description: Array of private link resources
items:
$ref: '#/definitions/PrivateLinkResource'
nextLink:
type: string
readOnly: true
description: Link to the next page of results.
description: A list of private link resources
PrivateEndpointConnectionResourceListResult:
description: The response of the List Private Endpoint Connections operation.
type: object
properties:
value:
description: Gets or sets result of the List AuthorizationRules operation.
type: array
items:
$ref: '#/definitions/PrivateEndpointConnectionResource'
readOnly: true
nextLink:
description: Gets or sets link to the next set of results.
type: string
readOnly: true
PrivateEndpointConnectionResource:
description: Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace.
type: object
allOf:
- $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
properties:
properties:
$ref: '#/definitions/PrivateEndpointConnectionProperties'
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
description: The private link resource Private link DNS zone name.
description: Properties of a private link resource.
parameters:
PrivateEndpointConnectionName:
in: path
name: privateEndpointConnectionName
description: Private Endpoint Connection Name
required: true
maxLength: 87
minLength: 1
pattern: ^[a-zA-Z][a-zA-Z0-9-]*\.[a-fA-F0-9\-]+$
type: string
x-ms-parameter-location: method
HostPoolNameParameter:
name: hostPoolName
in: path
required: true
type: string
description: The name of the host pool within the specified resource group
maxLength: 64
minLength: 3
x-ms-parameter-location: method
WorkspaceNameParameter:
name: workspaceName
in: path
required: true
type: string
description: The name of the workspace
maxLength: 64
minLength: 3
x-ms-parameter-location: method
NamespaceName:
in: path
name: namespaceName
description: Namespace name
required: true
maxLength: 50
minLength: 1
pattern: ^[a-zA-Z][a-zA-Z0-9-]*$
type: string
x-ms-parameter-location: method
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'