Managed Hsms - Get Deleted

Référence

Service:: Key Vault

API Version:: 2022-07-01

Obtient le HSM managé supprimé spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
location	path	True	string	Emplacement du HSM managé supprimé.
name	path	True	string	Nom du HSM managé supprimé.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	DeletedManagedHsm	Informations récupérées sur le HSM managé supprimé spécifié.
Other Status Codes	ManagedHsmError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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"
    }
  }
}

Définitions

Nom	Description
DeletedManagedHsm
DeletedManagedHsmProperties	Propriétés du HSM managé supprimé.
Error	Erreur du serveur.
ManagedHsmError	Exception d'erreur.

DeletedManagedHsm

Nom	Type	Description
id	string	L’ID de ressource Azure Resource Manager pour le pool HSM managé supprimé.
name	string	Nom du pool HSM managé.
properties	DeletedManagedHsmProperties	Propriétés du HSM managé supprimé
type	string	Type de ressource du pool HSM managé.

DeletedManagedHsmProperties

Propriétés du HSM managé supprimé.

Nom	Type	Description
deletionDate	string	Date de suppression.
location	string	Emplacement du HSM managé d’origine.
mhsmId	string	ID de ressource du HSM managé d’origine.
purgeProtectionEnabled	boolean	Purger la protection status du HSM managé d’origine.
scheduledPurgeDate	string	Date de purge planifiée.
tags	object	Balises du HSM managé d’origine.

Error

Erreur du serveur.

Nom	Type	Description
code	string	Code d'erreur.
innererror	Error	L’erreur interne contient un code d’erreur plus spécifique.
message	string	Message d’erreur.

ManagedHsmError

Exception d'erreur.

Nom	Type	Description
error	Error	Erreur du serveur.

Share via