MHSM Private Endpoint Connections - Delete

Reference

Service:: Key Vault

API Version:: 2022-07-01

Deletes the specified private endpoint connection associated with the managed hsm pool.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-07-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the managed HSM Pool
privateEndpointConnectionName	path	True	string	Name of the private endpoint connection associated with the managed hsm pool.
resourceGroupName	path	True	string	Name of the resource group that contains the managed HSM pool.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	MHSMPrivateEndpointConnection	The private endpoint connection was successfully deleted.
202 Accepted		The private endpoint connection is being deleted. Headers Location: string
204 No Content		The private endpoint connection does not exist.
Other Status Codes	CloudError	Error response describing why the operation failed.

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

ManagedHsmDeletePrivateEndpointConnection

DELETE https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateEndpointConnections/sample-pec?api-version=2022-07-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python managed_hsm_delete_private_endpoint_connection.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.mhsm_private_endpoint_connections.begin_delete(
        resource_group_name="sample-group",
        name="sample-mhsm",
        private_endpoint_connection_name="sample-pec",
    ).result()
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_deletePrivateEndpointConnection.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-vault/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
  "properties": {
    "provisioningState": "Disconnected"
  }
}

Status code:: 202

Location: https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec?operationid=25334578

Status code:: 204

Definitions

Name	Description
ActionsRequired	A message indicating if changes on the service provider require any updates on the consumer.
CloudError	An error response from Key Vault resource provider
CloudErrorBody	An error response from Key Vault resource provider
identityType	The type of identity that created the key vault resource.
ManagedHsmSku	SKU details
ManagedHsmSkuFamily	SKU Family of the managed HSM Pool
ManagedHsmSkuName	SKU of the managed HSM Pool
MHSMPrivateEndpoint	Private endpoint object properties.
MHSMPrivateEndpointConnection	Private endpoint connection resource.
MHSMPrivateLinkServiceConnectionState	An object that represents the approval state of the private link connection.
PrivateEndpointConnectionProvisioningState	Provisioning state of the private endpoint connection.
PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been approved, rejected or removed by the key vault owner.
SystemData	Metadata pertaining to creation and last modification of the key vault resource.

ActionsRequired

A message indicating if changes on the service provider require any updates on the consumer.

Name	Type	Description
None	string

CloudError

An error response from Key Vault resource provider

Name	Type	Description
error	CloudErrorBody	An error response from Key Vault resource provider

CloudErrorBody

An error response from Key Vault resource provider

Name	Type	Description
code	string	Error code. This is a mnemonic that can be consumed programmatically.
message	string	User friendly error message. The message is typically localized and may vary with service version.

identityType

The type of identity that created the key vault resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

SKU details

Name	Type	Description
family	ManagedHsmSkuFamily	SKU Family of the managed HSM Pool
name	ManagedHsmSkuName	SKU of the managed HSM Pool

ManagedHsmSkuFamily

SKU Family of the managed HSM Pool

Name	Type	Description
B	string

ManagedHsmSkuName

SKU of the managed HSM Pool

Name	Type	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string