Iot Dps Resource - Delete Private Endpoint Connection

Reference

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Delete private endpoint connection with the specified name

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-12-12

URI Parameters

Name	In	Required	Type	Description
privateEndpointConnectionName	path	True	string	The name of the private endpoint connection
resourceGroupName	path	True	string	The name of the resource group that contains the provisioning service.
resourceName	path	True	string	The name of the provisioning service.
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	The version of the API.

Responses

Name	Type	Description
200 OK	PrivateEndpointConnection	This is returned as a response to the status polling request for the delete operation.
202 Accepted	PrivateEndpointConnection	This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. Headers Azure-AsyncOperation: string Location: string Retry-After: string
204 No Content		PrivateEndpoint does not exist.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

PrivateEndpointConnection_Delete

Sample request

HTTP

DELETE https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/privateEndpointConnections/myPrivateEndpointConnection?api-version=2022-12-12

Sample response

Status code:: 200

{
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection",
  "name": "myPrivateEndpointConnection",
  "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Disconnected",
      "description": "Deleted",
      "actionsRequired": "None"
    }
  }
}

Status code:: 202

Retry-After: 15
Location: /subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15
Azure-AsyncOperation: /subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15

{
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection",
  "name": "myPrivateEndpointConnection",
  "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Disconnected",
      "description": "Deleted",
      "actionsRequired": "None"
    }
  }
}

Status code:: 204

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorDetails	Error details.
PrivateEndpoint	The private endpoint property of a private endpoint connection
PrivateEndpointConnection	The private endpoint connection of a provisioning service
PrivateEndpointConnectionProperties	The properties of a private endpoint connection
PrivateLinkServiceConnectionState	The current state of a private endpoint connection
PrivateLinkServiceConnectionStatus	The status of a private endpoint connection
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Error details.

Name	Type	Description
code	integer	The error code.
details	string	The error details.
httpStatusCode	string	The HTTP status code.
message	string	The error message.

PrivateEndpoint

The private endpoint property of a private endpoint connection

Name	Type	Description
id	string	The resource identifier.

PrivateEndpointConnection

The private endpoint connection of a provisioning service

Name	Type	Description
id	string	The resource identifier.
name	string	The resource name.
properties	PrivateEndpointConnectionProperties	The properties of a private endpoint connection
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
type	string	The resource type.

PrivateEndpointConnectionProperties

The properties of a private endpoint connection

Name	Type	Description
privateEndpoint	PrivateEndpoint	The private endpoint property of a private endpoint connection
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	The current state of a private endpoint connection

PrivateLinkServiceConnectionState

The current state of a private endpoint connection

Name	Type	Description
actionsRequired	string	Actions required for a private endpoint connection
description	string	The description for the current state of a private endpoint connection
status	PrivateLinkServiceConnectionStatus	The status of a private endpoint connection

PrivateLinkServiceConnectionStatus

The status of a private endpoint connection

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via