Managed Hsms - List Deleted

Odwołanie

Service:: Key Vault

API Version:: 2022-07-01

Operacja Lista pobiera informacje o usuniętych zarządzanych modułach HSM skojarzonych z subskrypcją.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DeletedManagedHsmListResult	Pobrano informacje o wszystkich zarządzanych modułach HSM w określonej subskrypcji.
Other Status Codes	ManagedHsmError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List deleted managed HSMs in the specified subscription

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedManagedHSMs?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_list.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.list_deleted()
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/DeletedManagedHsm_List.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

{
  "value": [
    {
      "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"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm2",
      "name": "vault-agile-drawer-6404",
      "type": "Microsoft.KeyVault/deletedManagedHSMs",
      "properties": {
        "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2",
        "location": "westus",
        "deletionDate": "2021-04-01T00:00:59Z",
        "scheduledPurgeDate": "2021-04-01T00:00:59Z",
        "purgeProtectionEnabled": true,
        "tags": {
          "Dept": "hsm",
          "Environment": "production"
        }
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedManagedHSMs?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

Definicje

Nazwa	Opis
DeletedManagedHsm
DeletedManagedHsmListResult	Lista usuniętych zarządzanych pul modułów HSM
DeletedManagedHsmProperties	Właściwości usuniętego zarządzanego modułu HSM.
Error	Błąd serwera.
ManagedHsmError	Wyjątek błędu.

DeletedManagedHsm

Nazwa	Typ	Opis
id	string	Identyfikator zasobu usługi Azure Resource Manager dla usuniętej zarządzanej puli modułów HSM.
name	string	Nazwa zarządzanej puli modułów HSM.
properties	DeletedManagedHsmProperties	Właściwości usuniętego zarządzanego modułu HSM
type	string	Typ zasobu zarządzanej puli modułów HSM.

DeletedManagedHsmListResult

Lista usuniętych zarządzanych pul modułów HSM

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający pobranie następnego zestawu usuniętych zarządzanych pul modułów HSM.
value	DeletedManagedHsm[]	Lista usuniętych zarządzanych pul modułów HSM.

DeletedManagedHsmProperties

Właściwości usuniętego zarządzanego modułu HSM.

Nazwa	Typ	Opis
deletionDate	string	Data usunięcia.
location	string	Lokalizacja oryginalnego zarządzanego modułu HSM.
mhsmId	string	Identyfikator zasobu oryginalnego zarządzanego modułu HSM.
purgeProtectionEnabled	boolean	Przeczyść stan ochrony oryginalnego zarządzanego modułu HSM.
scheduledPurgeDate	string	Zaplanowana data przeczyszczania.
tags	object	Tagi oryginalnego zarządzanego modułu HSM.

Error

Błąd serwera.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	Error	Wewnętrzny błąd zawiera bardziej szczegółowy kod błędu.
message	string	Komunikat o błędzie.

ManagedHsmError

Wyjątek błędu.

Nazwa	Typ	Opis
error	Error	Błąd serwera.

Share via