Managed Hsms - List Deleted

Referência

Serviço:: Key Vault

Versão da API:: 2022-07-01

A operação Lista obtém informações sobre os HSMs gerenciados excluídos associados à assinatura.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	DeletedManagedHsmListResult	Informações recuperadas sobre todos os HSMs gerenciados na assinatura especificada.
Other Status Codes	ManagedHsmError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Resposta de exemplo

Código de status:: 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=="
}

Definições

Nome	Description
DeletedManagedHsm
DeletedManagedHsmListResult	Lista de pools de HSM gerenciados excluídos
DeletedManagedHsmProperties	Propriedades do HSM gerenciado excluído.
Error	O erro do servidor.
ManagedHsmError	A exceção do erro.

DeletedManagedHsm

Nome	Tipo	Description
id	string	O Azure Resource Manager ID do recurso para o pool de HSM gerenciado excluído.
name	string	O nome do pool de HSM gerenciado.
properties	DeletedManagedHsmProperties	Propriedades do HSM gerenciado excluído
type	string	O tipo de recurso do pool de HSM gerenciado.

DeletedManagedHsmListResult

Lista de pools de HSM gerenciados excluídos

Nome	Tipo	Description
nextLink	string	A URL para obter o próximo conjunto de pools de HSM gerenciados excluídos.
value	DeletedManagedHsm[]	A lista de pools de HSM gerenciados excluídos.

DeletedManagedHsmProperties

Propriedades do HSM gerenciado excluído.

Nome	Tipo	Description
deletionDate	string	A data excluída.
location	string	O local do HSM gerenciado original.
mhsmId	string	A ID do recurso do HSM gerenciado original.
purgeProtectionEnabled	boolean	Limpe a proteção status do HSM gerenciado original.
scheduledPurgeDate	string	A data de limpeza agendada.
tags	object	Marcas do HSM gerenciado original.

Error

O erro do servidor.

Nome	Tipo	Description
code	string	O código de erro.
innererror	Error	O erro interno contém um código de erro mais específico.
message	string	A mensagem de erro.

ManagedHsmError

A exceção do erro.

Nome	Tipo	Description
error	Error	O erro do servidor.

Compartilhar via