Managed Hsms - Get Deleted

Referencia

Service:: Key Vault

API Version:: 2022-07-01

Obtiene el HSM administrado eliminado especificado.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedManagedHSMs/{name}?api-version=2022-07-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
location	path	True	string	Ubicación del HSM administrado eliminado.
name	path	True	string	Nombre del HSM administrado eliminado.
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	DeletedManagedHsm	Se recuperó información sobre el HSM administrado eliminado especificado.
Other Status Codes	ManagedHsmError	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

Retrieve a deleted managed HSM

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1?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 deleted_managed_hsm_get.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.managed_hsms.get_deleted(
        name="hsm1",
        location="westus",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/DeletedManagedHsm_Get.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/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1",
  "name": "vault-agile-drawer-6404",
  "type": "Microsoft.KeyVault/deletedManagedHSMs",
  "properties": {
    "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
    "location": "westus",
    "deletionDate": "2021-04-01T00:00:59Z",
    "scheduledPurgeDate": "2021-04-01T00:00:59Z",
    "purgeProtectionEnabled": true,
    "tags": {
      "Dept": "hsm",
      "Environment": "production"
    }
  }
}

Definiciones

Nombre	Description
DeletedManagedHsm
DeletedManagedHsmProperties	Propiedades del HSM administrado eliminado.
Error	Error del servidor.
ManagedHsmError	Excepción del error.

DeletedManagedHsm

Nombre	Tipo	Description
id	string	El identificador de recurso de Azure Resource Manager para el grupo de HSM administrado eliminado.
name	string	Nombre del grupo de HSM administrado.
properties	DeletedManagedHsmProperties	Propiedades del HSM administrado eliminado
type	string	Tipo de recurso del grupo de HSM administrado.

DeletedManagedHsmProperties

Propiedades del HSM administrado eliminado.

Nombre	Tipo	Description
deletionDate	string	Fecha eliminada.
location	string	Ubicación del HSM administrado original.
mhsmId	string	Identificador de recurso del HSM administrado original.
purgeProtectionEnabled	boolean	Purgar el estado de protección del HSM administrado original.
scheduledPurgeDate	string	Fecha purgada programada.
tags	object	Etiquetas del HSM administrado original.

Error

Error del servidor.

Nombre	Tipo	Description
code	string	Código de error.
innererror	Error	El error interno contiene un código de error más específico.
message	string	El mensaje de error.

ManagedHsmError

Excepción del error.

Nombre	Tipo	Description
error	Error	Error del servidor.