Managed Hsms - List Deleted

Referens

Service:: Key Vault

API Version:: 2022-07-01

Liståtgärden hämtar information om de borttagna hanterade HSM:erna som är associerade med prenumerationen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	DeletedManagedHsmListResult	Hämtade information om alla hanterade HSM:er i den angivna prenumerationen.
Other Status Codes	ManagedHsmError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
DeletedManagedHsm
DeletedManagedHsmListResult	Lista över borttagna hanterade HSM-pooler
DeletedManagedHsmProperties	Egenskaper för den borttagna hanterade HSM:en.
Error	Serverfelet.
ManagedHsmError	Felfelsfelet.

DeletedManagedHsm

Name	Typ	Description
id	string	Resurs-ID för Azure Resource Manager för den borttagna hanterade HSM-poolen.
name	string	Namnet på den hanterade HSM-poolen.
properties	DeletedManagedHsmProperties	Egenskaper för den borttagna hanterade HSM:en
type	string	Resurstypen för den hanterade HSM-poolen.

DeletedManagedHsmListResult

Lista över borttagna hanterade HSM-pooler

Name	Typ	Description
nextLink	string	URL:en för att hämta nästa uppsättning borttagna hanterade HSM-pooler.
value	DeletedManagedHsm[]	Listan över borttagna hanterade HSM-pooler.

DeletedManagedHsmProperties

Egenskaper för den borttagna hanterade HSM:en.

Name	Typ	Description
deletionDate	string	Det borttagna datumet.
location	string	Platsen för den ursprungliga hanterade HSM:en.
mhsmId	string	Resurs-ID:t för den ursprungliga hanterade HSM:en.
purgeProtectionEnabled	boolean	Rensa skyddsstatus för den ursprungliga hanterade HSM:en.
scheduledPurgeDate	string	Det schemalagda rensade datumet.
tags	object	Taggar för den ursprungliga hanterade HSM:en.

Error

Serverfelet.

Name	Typ	Description
code	string	Felkoden.
innererror	Error	Det inre felet innehåller en mer specifik felkod.
message	string	Felmeddelandet.

ManagedHsmError

Felfelsfelet.

Name	Typ	Description
error	Error	Serverfelet.