Managed Hsms - Get Deleted

Reference

Service:: Key Vault

API Version:: 2022-07-01

Získá zadaný odstraněný spravovaný HSM.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
location	path	True	string	Umístění odstraněného spravovaného HSM.
name	path	True	string	Název odstraněného spravovaného HSM.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	DeletedManagedHsm	Načetly se informace o zadaném odstraněné spravovaném HSM.
Other Status Codes	ManagedHsmError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
DeletedManagedHsm
DeletedManagedHsmProperties	Vlastnosti odstraněného spravovaného HSM
Error	Chyba serveru.
ManagedHsmError	Výjimka chyby.

DeletedManagedHsm

Name	Typ	Description
id	string	Azure Resource Manager ID prostředku odstraněného spravovaného fondu HSM.
name	string	Název spravovaného fondu HSM.
properties	DeletedManagedHsmProperties	Vlastnosti odstraněného spravovaného HSM
type	string	Typ prostředku spravovaného fondu HSM.

DeletedManagedHsmProperties

Vlastnosti odstraněného spravovaného HSM

Name	Typ	Description
deletionDate	string	Datum odstranění.
location	string	Umístění původního spravovaného HSM.
mhsmId	string	ID prostředku původního spravovaného HSM.
purgeProtectionEnabled	boolean	Stav ochrany před vymazáním původního spravovaného HSM
scheduledPurgeDate	string	Plánované vyprázdněné datum
tags	object	Značky původního spravovaného HSM

Error

Chyba serveru.

Name	Typ	Description
code	string	Kód chyby
innererror	Error	Vnitřní chyba obsahuje konkrétnější kód chyby.
message	string	Chybová zpráva

ManagedHsmError

Výjimka chyby.

Name	Typ	Description
error	Error	Chyba serveru.