swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector PrivateEndpointConnection API schemes: - https tags: - name: PrivateEndpointConnection paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections : get: tags: - PrivateEndpointConnection operationId: microsoftAzurePrivateendpointconnectionListbybatchaccount description: Lists all of the private endpoint connections in the specified account. x-ms-examples: ListPrivateEndpointConnections: $ref: ./examples/PrivateEndpointConnectionsList.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: maxresults in: query required: false type: integer format: int32 description: The maximum number of items to return in the response. responses: '200': description: The operation was successful. The response contains a list of private link resources associated with the account. schema: $ref: '#/definitions/ListPrivateEndpointConnectionsResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnection operationId: microsoftAzurePrivateendpointconnectionGet description: Gets information about the specified private endpoint connection. x-ms-examples: GetPrivateEndpointConnection: $ref: ./examples/PrivateEndpointConnectionGet.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: The operation was successful. The response contains the private endpoint connection. schema: $ref: '#/definitions/PrivateEndpointConnection' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Privateendpointconnections Privateendpointconnectionname patch: tags: - PrivateEndpointConnection operationId: microsoftAzurePrivateendpointconnectionUpdate description: Updates the properties of an existing private endpoint connection. x-ms-examples: UpdatePrivateEndpointConnection: $ref: ./examples/PrivateEndpointConnectionUpdate.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/PrivateEndpointConnection' description: PrivateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged. - name: If-Match in: header required: false type: string description: The state (ETag) version of the private endpoint connection to update. This value can be omitted or set to "*" to apply the operation unconditionally. responses: '200': description: The operation was successful. The response contains the PrivateEndpointConnection. schema: $ref: '#/definitions/PrivateEndpointConnection' '202': description: The operation was accepted and will be performed in the background. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 '204': description: The operation was successful. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnection operationId: microsoftAzurePrivateendpointconnectionDelete x-ms-examples: PrivateEndpointConnectionDelete: $ref: ./examples/PrivateEndpointConnectionDelete.json description: Deletes the specified private endpoint connection. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/AccountNameParameter' - $ref: '#/parameters/PrivateEndpointConnectionNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds. type: integer format: int32 '204': description: The operation was successful. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_2' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections : get: tags: - PrivateEndpointConnection summary: Microsoft Azure Gets Private Endpoint Connections description: Get private endpoint connections for account operationId: microsoftAzurePrivateendpointconnectionsListbyaccount parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/accountName' - $ref: '#/parameters/api-version' - name: $skipToken in: query description: The skip token. required: false type: string responses: '200': description: Success schema: $ref: '#/definitions/PrivateEndpointConnectionList' default: description: An error response received from the provider. schema: $ref: '#/definitions/ErrorResponseModel' x-ms-pageable: nextLinkName: nextLink x-ms-examples: PrivateEndpointConnections_ListByAccount: $ref: ./examples/PrivateEndpointConnections_ListByAccount.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnection summary: Microsoft Azure Gets Private Endpoint Connection Information description: Get a private endpoint connection operationId: microsoftAzurePrivateendpointconnectionsGet parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/accountName' - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/PrivateEndpointConnection_3' default: description: An error response received from the provider. schema: $ref: '#/definitions/ErrorResponseModel' x-ms-examples: PrivateEndpointConnections_Get: $ref: ./examples/PrivateEndpointConnections_Get.json put: tags: - PrivateEndpointConnection summary: Microsoft Azure Approves Rejects Private Endpoint Connection Request description: Create or update a private endpoint connection operationId: microsoftAzurePrivateendpointconnectionsCreateorupdate parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/accountName' - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true type: string - name: request in: body description: The request. required: true schema: $ref: '#/definitions/PrivateEndpointConnection_3' - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/PrivateEndpointConnection_3' '201': description: Success schema: $ref: '#/definitions/PrivateEndpointConnection_3' default: description: An error response received from the provider. schema: $ref: '#/definitions/ErrorResponseModel' x-ms-long-running-operation: true x-ms-examples: PrivateEndpointConnections_CreateOrUpdate: $ref: ./examples/PrivateEndpointConnections_CreateOrUpdate.json delete: tags: - PrivateEndpointConnection summary: Microsoft Azure Deletes Private Endpoint Connection description: Delete a private endpoint connection operationId: microsoftAzurePrivateendpointconnectionsDelete parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/accountName' - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success '202': description: Accepted '204': description: Success default: description: An error response received from the provider. schema: $ref: '#/definitions/ErrorResponseModel' x-ms-long-running-operation: true x-ms-examples: PrivateEndpointConnections_Delete: $ref: ./examples/PrivateEndpointConnections_Delete.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnection description: Get Private Endpoint Connection. This call is made by Backup Admin. operationId: microsoftAzurePrivateendpointconnectionGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/VaultName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/PrivateEndpointConnectionResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/NewErrorResponse' x-ms-examples: Get PrivateEndpointConnection: $ref: ./examples/PrivateEndpointConnection/GetPrivateEndpointConnection.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnection description: Approve or Reject Private Endpoint requests. This call is made by Backup Admin. operationId: microsoftAzurePrivateendpointconnectionPut produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/VaultName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true type: string - name: parameters in: body description: Request body for operation required: true schema: $ref: '#/definitions/PrivateEndpointConnectionResource' responses: '200': description: OK schema: $ref: '#/definitions/PrivateEndpointConnectionResource' '201': description: Created schema: $ref: '#/definitions/PrivateEndpointConnectionResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true x-ms-examples: Update PrivateEndpointConnection: $ref: ./examples/PrivateEndpointConnection/PutPrivateEndpointConnection.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnection description: Delete Private Endpoint requests. This call is made by Backup Admin. operationId: microsoftAzurePrivateendpointconnectionDelete produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/VaultName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: privateEndpointConnectionName in: path description: The name of the private endpoint connection. required: true type: string responses: '200': description: OK '202': description: Accepted '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true x-ms-examples: Delete PrivateEndpointConnection: $ref: ./examples/PrivateEndpointConnection/DeletePrivateEndpointConnection.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Privateendpointconnections Privateendpointconnectionname definitions: PrivateLinkServiceConnectionState_4: description: Private Link Service Connection State type: object properties: status: description: Gets or sets the status enum: - Pending - Approved - Rejected - Disconnected type: string x-ms-enum: name: PrivateEndpointConnectionStatus modelAsString: true description: description: Gets or sets description type: string actionRequired: description: Gets or sets actions required type: string ProxyResource: properties: id: readOnly: true type: string description: The ID of the resource. name: readOnly: true type: string description: The name of the resource. type: readOnly: true type: string description: The type of the resource. etag: readOnly: true type: string description: The ETag of the resource, used for concurrency statements. description: A definition of an Azure resource. x-ms-azure-resource: true PrivateEndpoint: properties: id: type: string title: The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. readOnly: true description: The private endpoint of the private endpoint connection. ErrorModel: description: Default error model type: object properties: code: description: Gets or sets the code. type: string readOnly: true details: description: Gets or sets the details. uniqueItems: false type: array items: $ref: '#/definitions/ErrorModel' readOnly: true message: description: Gets or sets the messages. type: string readOnly: true target: description: Gets or sets the target. type: string readOnly: true 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 display in a user interface. target: type: string description: The target of the particular error. For example, the name of the property in error. details: type: array items: $ref: '#/definitions/CloudErrorBody' description: A list of additional details about the error. description: An error response from the Batch service. PrivateLinkServiceConnectionState: properties: status: $ref: '#/definitions/PrivateLinkServiceConnectionStatus' title: The status for the private endpoint connection of Batch account description: type: string title: Description of the private Connection state actionRequired: type: string title: Action required on the private connection state readOnly: true required: - status description: The private link service connection state of the private endpoint connection NewErrorResponse: properties: error: type: object description: The error object. properties: code: readOnly: true type: string description: The error code. message: readOnly: true type: string description: The error message. target: readOnly: true type: string description: The error target. details: readOnly: true type: array items: $ref: '#/definitions/NewErrorResponse' x-ms-identifiers: - /error/code description: The error details. additionalInfo: readOnly: true type: array items: $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo x-ms-identifiers: [] description: The error additional info. description: The resource management error response. Resource: description: ARM Resource. type: object properties: id: description: Resource Id represents the complete path to the resource. type: string readOnly: true name: description: Resource name associated with the resource. type: string readOnly: true type: description: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... type: string readOnly: true location: description: Resource location. type: string tags: description: Resource tags. type: object additionalProperties: type: string eTag: description: Optional ETag. type: string x-ms-azure-resource: true PrivateEndpointConnectionProperties: properties: provisioningState: type: string readOnly: true x-nullable: false title: The provisioning state of the private endpoint connection. enum: - Succeeded - Updating - Failed x-ms-enum: name: PrivateEndpointConnectionProvisioningState modelAsString: false values: - value: Succeeded description: The connection status is final and is ready for use if Status is Approved. - value: Updating description: The user has requested that the connection status be updated, but the update operation has not yet completed. You may not reference the connection when connecting the Batch account. - value: Failed description: The user requested that the connection be updated and it failed. You may retry the update operation. privateEndpoint: $ref: '#/definitions/PrivateEndpoint' title: The ARM resource identifier of the private endpoint. privateLinkServiceConnectionState: $ref: '#/definitions/PrivateLinkServiceConnectionState' title: The private link service connection state of the private endpoint connection. description: Private endpoint connection properties. PrivateEndpoint_3: description: A private endpoint class. type: object properties: id: description: The private endpoint identifier. type: string PrivateEndpointConnection_3: description: A private endpoint connection class. type: object allOf: - $ref: '#/definitions/ProxyResource_3' properties: properties: $ref: '#/definitions/PrivateEndpointConnectionProperties_3' description: The connection identifier. x-ms-client-flatten: true PrivateEndpointConnection_4: description: Private Endpoint Connection Response Properties type: object properties: provisioningState: description: Gets or sets provisioning state of the private endpoint connection enum: - Succeeded - Deleting - Failed - Pending type: string x-ms-enum: name: ProvisioningState modelAsString: true privateEndpoint: $ref: '#/definitions/PrivateEndpoint_4' description: Gets or sets private endpoint associated with the private endpoint connection privateLinkServiceConnectionState: $ref: '#/definitions/PrivateLinkServiceConnectionState_4' description: Gets or sets private link service connection state ProxyResource_3: description: Proxy Azure Resource type: object properties: id: description: Gets or sets the identifier. type: string readOnly: true name: description: Gets or sets the name. type: string readOnly: true type: description: Gets or sets the type. type: string readOnly: true x-ms-azure-resource: true PrivateEndpointConnectionList: description: Paged list of private endpoint connections required: - value type: object properties: count: format: int64 description: Total item count. type: integer nextLink: description: The Url of next result page. type: string value: description: Collection of items of type results. uniqueItems: false type: array items: $ref: '#/definitions/PrivateEndpointConnection_3' PrivateEndpointConnection: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/PrivateEndpointConnectionProperties' description: The properties associated with the private endpoint connection. allOf: - $ref: '#/definitions/ProxyResource' description: Contains information about a private link resource. CloudError_3: x-ms-external: true properties: error: type: object $ref: '#/definitions/CloudErrorBody_3' description: The error object. description: An error response from the Container Instance service. ListPrivateEndpointConnectionsResult: properties: value: type: array items: $ref: '#/definitions/PrivateEndpointConnection' description: The collection of returned private endpoint connection. nextLink: type: string description: The continuation token. description: Values returned by the List operation. CloudErrorBody_2: type: object 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 display in a user interface. 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' x-ms-identifiers: - message - target description: A list of additional details about the error. description: An error response from the Batch service. PrivateEndpoint_4: description: The Private Endpoint network resource that is linked to the Private Endpoint connection type: object properties: id: description: Gets or sets id type: string CloudErrorBody_3: x-ms-external: true properties: code: readOnly: true type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: readOnly: true type: string description: A message describing the error, intended to be suitable for display in a user interface. target: readOnly: true type: string description: The target of the particular error. For example, the name of the property in error. details: readOnly: true type: array items: $ref: '#/definitions/CloudErrorBody_3' x-ms-identifiers: - code description: A list of additional details about the error. additionalInfo: readOnly: true type: array items: $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo x-ms-identifiers: [] description: The error additional info. description: An error response from the Container Instance service. PrivateLinkServiceConnectionStatus: type: string title: The status of the Batch private endpoint connection enum: - Approved - Pending - Rejected - Disconnected x-ms-enum: name: PrivateLinkServiceConnectionStatus modelAsString: false values: - value: Approved description: The private endpoint connection is approved and can be used to access Batch account - value: Pending description: The private endpoint connection is pending and cannot be used to access Batch account - value: Rejected description: The private endpoint connection is rejected and cannot be used to access Batch account - value: Disconnected description: The private endpoint connection is disconnected and cannot be used to access Batch account ErrorResponseModel: description: Default error response model type: object properties: error: description: Gets or sets the error. allOf: - $ref: '#/definitions/ErrorModel' readOnly: true PrivateLinkServiceConnectionState_3: description: The private link service connection state. type: object properties: actionsRequired: description: The required actions. type: string description: description: The description. type: string status: description: The status. enum: - Unknown - Pending - Approved - Rejected - Disconnected type: string x-ms-enum: name: status modelAsString: true CloudError: x-ms-external: true properties: error: $ref: '#/definitions/CloudErrorBody' description: An error response from the Batch service. PrivateEndpointConnectionResource: description: Private Endpoint Connection Response Properties allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/PrivateEndpointConnection_4' description: PrivateEndpointConnectionResource properties PrivateEndpointConnectionProperties_3: description: A private endpoint connection properties class. type: object properties: privateEndpoint: $ref: '#/definitions/PrivateEndpoint_3' description: The private endpoint information. privateLinkServiceConnectionState: $ref: '#/definitions/PrivateLinkServiceConnectionState_3' description: The private link service connection state. provisioningState: description: The provisioning state. type: string readOnly: true CloudError_2: type: object x-ms-external: true properties: error: description: The body of the error response. $ref: '#/definitions/CloudErrorBody_2' description: An error response from the Batch service. parameters: ApiVersionParameter: name: api-version in: query required: true type: string description: The API version to be used with the HTTP request. VaultName: name: vaultName in: path description: The name of the recovery services vault. required: true type: string x-ms-parameter-location: method resourceGroupName: name: resourceGroupName in: path description: The resource group name. required: true type: string x-ms-parameter-location: method SubscriptionId: name: subscriptionId in: path description: The subscription Id. required: true type: string ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string description: The name of the resource group that contains the Batch account. x-ms-parameter-location: method api-version: name: api-version in: query description: The api version to use. required: true type: string ResourceGroupName: name: resourceGroupName in: path description: The name of the resource group where the recovery services vault is present. required: true type: string x-ms-parameter-location: method AccountNameParameter: name: accountName in: path required: true type: string pattern: ^[a-zA-Z0-9]+$ minLength: 3 maxLength: 24 description: The name of the Batch account. x-ms-parameter-location: method PrivateEndpointConnectionNameParameter: name: privateEndpointConnectionName in: path required: true type: string pattern: ^[a-zA-Z0-9_-]+\.?[a-fA-F0-9-]*$ minLength: 1 maxLength: 101 description: The private endpoint connection name. This must be unique within the account. x-ms-parameter-location: method ApiVersion: name: api-version in: query description: Client Api Version. required: true type: string SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) subscriptionId: name: subscriptionId in: path description: The subscription identifier required: true type: string accountName: name: accountName in: path description: The name of the account. required: true type: string maxLength: 63 minLength: 3 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'