MHSM Private Endpoint Connections - Delete

Referencia

Service:: Key Vault

API Version:: 2022-07-01

Elimina la conexión de punto de conexión privado especificada asociada al grupo de hsm administrado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre del grupo de HSM administrado
privateEndpointConnectionName	path	True	string	Nombre de la conexión de punto de conexión privado asociada al grupo de hsm administrado.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el grupo de HSM administrado.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	MHSMPrivateEndpointConnection	La conexión del punto de conexión privado se eliminó correctamente.
202 Accepted		Se está eliminando la conexión del punto de conexión privado. Headers Location: string
204 No Content		La conexión del punto de conexión privado no existe.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
ActionsRequired	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
CloudError	Respuesta de error del proveedor de recursos de Key Vault
CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault
identityType	Tipo de identidad que creó el recurso del almacén de claves.
ManagedHsmSku	Detalles de la SKU
ManagedHsmSkuFamily	Familia de SKU del grupo de HSM administrado
ManagedHsmSkuName	SKU del grupo de HSM administrado
MHSMPrivateEndpoint	Propiedades del objeto de punto de conexión privado.
MHSMPrivateEndpointConnection	Recurso de conexión de punto de conexión privado.
MHSMPrivateLinkServiceConnectionState	Objeto que representa el estado de aprobación de la conexión de vínculo privado.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
PrivateEndpointServiceConnectionStatus	Indica si el propietario del almacén de claves ha aprobado, rechazado o quitado la conexión.
SystemData	Metadatos relacionados con la creación y la última modificación del recurso del almacén de claves.

ActionsRequired

Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.

Nombre	Tipo	Description
None	string

CloudError

Respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
error	CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault

CloudErrorBody

Respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
code	string	Código de error. Se trata de una mnemónica que se puede consumir mediante programación.
message	string	Mensaje de error descriptivo. El mensaje suele localizarse y puede variar con la versión del servicio.

identityType

Tipo de identidad que creó el recurso del almacén de claves.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

Detalles de la SKU

Nombre	Tipo	Description
family	ManagedHsmSkuFamily	Familia de SKU del grupo de HSM administrado
name	ManagedHsmSkuName	SKU del grupo de HSM administrado

ManagedHsmSkuFamily

Familia de SKU del grupo de HSM administrado

Nombre	Tipo	Description
B	string

ManagedHsmSkuName

SKU del grupo de HSM administrado

Nombre	Tipo	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string