Vaults - Get

Referência

Service:: Key Vault

API Version:: 2022-07-01

Obtém o cofre de chaves do Azure especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do Grupo de Recursos ao qual o cofre pertence.
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.
vaultName	path	True	string	O nome do cofre.
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	Vault	Cofre recuperado
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Exemplos

Retrieve a vault

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault?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 get_vault.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.vaults.get(
        resource_group_name="sample-resource-group",
        vault_name="sample-vault",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/getVault.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/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault",
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/vaults",
  "location": "westus",
  "tags": {},
  "systemData": {
    "createdBy": "keyVaultUser1",
    "createdByType": "User",
    "createdAt": "2020-01-01T12:00:00.0000000Z",
    "lastModifiedBy": "keyVaultUser2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-01T12:00:00.0000000Z"
  },
  "properties": {
    "sku": {
      "family": "A",
      "name": "standard"
    },
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt",
            "decrypt",
            "wrapKey",
            "unwrapKey",
            "sign",
            "verify",
            "get",
            "list",
            "create",
            "update",
            "import",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "secrets": [
            "get",
            "list",
            "set",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "certificates": [
            "get",
            "list",
            "delete",
            "create",
            "import",
            "update",
            "managecontacts",
            "getissuers",
            "listissuers",
            "setissuers",
            "deleteissuers",
            "manageissuers",
            "recover",
            "purge"
          ]
        }
      }
    ],
    "enabledForDeployment": true,
    "enabledForDiskEncryption": true,
    "enabledForTemplateDeployment": true,
    "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
    "vaultUri": "https://sample-vault.vault.azure.net",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled"
  }
}

Definições

Nome	Description
AccessPolicyEntry	Uma identidade que tem acesso ao cofre de chaves. Todas as identidades na matriz devem usar a mesma ID de locatário que a ID de locatário do cofre de chaves.
ActionsRequired	Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor.
CertificatePermissions	Permissões para certificados
CloudError	Uma resposta de erro do provedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault
CreateMode	O modo de criação do cofre para indicar se o cofre precisa ser recuperado ou não.
identityType	O tipo de identidade que criou o recurso do cofre de chaves.
IPRule	Uma regra que rege a acessibilidade de um cofre de um endereço IP ou intervalo de ip específico.
KeyPermissions	Permissões para chaves
NetworkRuleAction	A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass é avaliada.
NetworkRuleBypassOptions	Informa qual tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'.
NetworkRuleSet	Um conjunto de regras que regem a acessibilidade de rede de um cofre.
Permissions	Permissões que a identidade tem para chaves, segredos, certificados e armazenamento.
PrivateEndpoint	Propriedades do objeto de ponto de extremidade privado.
PrivateEndpointConnectionItem	Item de conexão de ponto de extremidade privado.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointServiceConnectionStatus	A conexão de ponto de extremidade privado status.
PrivateLinkServiceConnectionState	Um objeto que representa o estado de aprovação da conexão de link privado.
SecretPermissions	Permissões para segredos
Sku	Detalhes do SKU
SkuFamily	Nome da família SKU
SkuName	Nome da SKU para especificar se o cofre de chaves é um cofre padrão ou um cofre Premium.
StoragePermissions	Permissões para contas de armazenamento
SystemData	Metadados relativos à criação e última modificação do recurso do cofre de chaves.
Vault	Informações de recurso com detalhes estendidos.
VaultProperties	Propriedades do cofre
VaultProvisioningState	Estado de provisionamento do cofre.
VirtualNetworkRule	Uma regra que rege a acessibilidade de um cofre de uma rede virtual específica.

AccessPolicyEntry

Uma identidade que tem acesso ao cofre de chaves. Todas as identidades na matriz devem usar a mesma ID de locatário que a ID de locatário do cofre de chaves.

Nome	Tipo	Description
applicationId	string	ID do aplicativo do cliente que está fazendo solicitação em nome de uma entidade de segurança
objectId	string	A ID de objeto de um usuário, entidade de serviço ou grupo de segurança no locatário do Azure Active Directory para o cofre. A ID do objeto deve ser exclusiva para a lista de políticas de acesso.
permissions	Permissions	Permissões que a identidade tem para chaves, segredos e certificados.
tenantId	string	A ID de locatário do Azure Active Directory que deve ser usada para autenticar solicitações no cofre de chaves.

ActionsRequired

Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor.

Nome	Tipo	Description
None	string

CertificatePermissions

Permissões para certificados

Nome	Tipo	Description
all	string
backup	string
create	string
delete	string
deleteissuers	string
get	string
getissuers	string
import	string
list	string
listissuers	string
managecontacts	string
manageissuers	string
purge	string
recover	string
restore	string
setissuers	string
update	string

CloudError

Uma resposta de erro do provedor de recursos Key Vault

Nome	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do provedor de recursos Key Vault

Nome	Tipo	Description
code	string	Código do erro. Este é um mnemônico que pode ser consumido programaticamente.
message	string	Mensagem de erro amigável. Normalmente, a mensagem é localizada e pode variar com a versão do serviço.

CreateMode

O modo de criação do cofre para indicar se o cofre precisa ser recuperado ou não.

Nome	Tipo	Description
default	string
recover	string

identityType

O tipo de identidade que criou o recurso do cofre de chaves.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

IPRule

Uma regra que rege a acessibilidade de um cofre de um endereço IP ou intervalo de ip específico.

Nome	Tipo	Description
value	string	Um intervalo de endereços IPv4 na notação CIDR, como '124.56.78.91' (endereço IP simples) ou '124.56.78.0/24' (todos os endereços que começam com 124.56.78).

KeyPermissions

Permissões para chaves

Nome	Tipo	Description
all	string
backup	string
create	string
decrypt	string
delete	string
encrypt	string
get	string
getrotationpolicy	string
import	string
list	string
purge	string
recover	string
release	string
restore	string
rotate	string
setrotationpolicy	string
sign	string
unwrapKey	string
update	string
verify	string
wrapKey	string

NetworkRuleAction

A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass é avaliada.

Nome	Tipo	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

Informa qual tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'.

Nome	Tipo	Description
AzureServices	string
None	string

NetworkRuleSet

Um conjunto de regras que regem a acessibilidade de rede de um cofre.

Nome	Tipo	Description
bypass	NetworkRuleBypassOptions	Informa qual tráfego pode ignorar as regras de rede. Isso pode ser 'AzureServices' ou 'None'. Se não for especificado, o padrão será 'AzureServices'.
defaultAction	NetworkRuleAction	A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass é avaliada.
ipRules	IPRule[]	A lista de regras de endereço IP.
virtualNetworkRules	VirtualNetworkRule[]	A lista de regras de rede virtual.

Permissions

Permissões que a identidade tem para chaves, segredos, certificados e armazenamento.

Nome	Tipo	Description
certificates	CertificatePermissions[]	Permissões para certificados
keys	KeyPermissions[]	Permissões para chaves
secrets	SecretPermissions[]	Permissões para segredos
storage	StoragePermissions[]	Permissões para contas de armazenamento

PrivateEndpoint

Propriedades do objeto de ponto de extremidade privado.

Nome	Tipo	Description
id	string	Identificador completo do recurso de ponto de extremidade privado.

PrivateEndpointConnectionItem

Item de conexão de ponto de extremidade privado.

Nome	Tipo	Description
etag	string	Modificado sempre que houver uma alteração no estado da conexão de ponto de extremidade privado.
id	string	Id da conexão de ponto de extremidade privado.
properties.privateEndpoint	PrivateEndpoint	Propriedades do objeto de ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Estado de aprovação da conexão de link privado.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de provisionamento da conexão de ponto de extremidade privado.

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

Nome	Tipo	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

A conexão de ponto de extremidade privado status.

Nome	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Um objeto que representa o estado de aprovação da conexão de link privado.

Nome	Tipo	Description
actionsRequired	ActionsRequired	Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor.
description	string	O motivo da aprovação ou rejeição.
status	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada, rejeitada ou removida pelo proprietário do cofre de chaves.

SecretPermissions

Permissões para segredos

Nome	Tipo	Description
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

Sku

Detalhes do SKU

Nome	Tipo	Description
family	SkuFamily	Nome da família SKU
name	SkuName	Nome da SKU para especificar se o cofre de chaves é um cofre padrão ou um cofre Premium.

SkuFamily

Nome da família SKU

Nome	Tipo	Description
A	string

SkuName

Nome da SKU para especificar se o cofre de chaves é um cofre padrão ou um cofre Premium.

Nome	Tipo	Description
premium	string
standard	string

StoragePermissions

Permissões para contas de armazenamento

Nome	Tipo	Description
all	string
backup	string
delete	string
deletesas	string
get	string
getsas	string
list	string
listsas	string
purge	string
recover	string
regeneratekey	string
restore	string
set	string
setsas	string
update	string

SystemData

Metadados relativos à criação e última modificação do recurso do cofre de chaves.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos do cofre de chaves (UTC).
createdBy	string	A identidade que criou o recurso do cofre de chaves.
createdByType	identityType	O tipo de identidade que criou o recurso do cofre de chaves.
lastModifiedAt	string	O carimbo de data/hora do recurso de cofre de chaves última modificação (UTC).
lastModifiedBy	string	A identidade que modificou o recurso do cofre de chaves pela última vez.
lastModifiedByType	identityType	O tipo de identidade que modificou pela última vez o recurso do cofre de chaves.

Vault

Informações de recurso com detalhes estendidos.

Nome	Tipo	Description
id	string	Identificador totalmente qualificado do recurso do cofre de chaves.
location	string	Local do Azure do recurso do cofre de chaves.
name	string	Nome do recurso do cofre de chaves.
properties	VaultProperties	Propriedades do cofre
systemData	SystemData	Metadados do sistema para o cofre de chaves.
tags	object	Marcas atribuídas ao recurso do cofre de chaves.
type	string	Tipo de recurso do recurso do cofre de chaves.

VaultProperties

Propriedades do cofre

Nome	Tipo	Valor padrão	Description
accessPolicies	AccessPolicyEntry[]		Uma matriz de 0 a 1024 identidades que têm acesso ao cofre de chaves. Todas as identidades na matriz devem usar a mesma ID de locatário que a ID de locatário do cofre de chaves. Quando `createMode` é definido como `recover`, as políticas de acesso não são necessárias. Caso contrário, as políticas de acesso serão necessárias.
createMode	CreateMode		O modo de criação do cofre para indicar se o cofre precisa ser recuperado ou não.
enablePurgeProtection	boolean		Propriedade que especifica se a proteção contra limpeza está habilitada para esse cofre. Definir essa propriedade como true ativa a proteção contra limpeza para esse cofre e seu conteúdo – somente o serviço Key Vault pode iniciar uma exclusão dura e irrecuperável. A configuração só será eficaz se a exclusão reversível também estiver habilitada. Habilitar essa funcionalidade é irreversível– ou seja, a propriedade não aceita false como seu valor.
enableRbacAuthorization	boolean	False	Propriedade que controla como as ações de dados são autorizadas. Quando true, o cofre de chaves usará o RBAC (Controle de Acesso baseado em função) para autorização de ações de dados e as políticas de acesso especificadas nas propriedades do cofre serão ignoradas. Quando false, o cofre de chaves usará as políticas de acesso especificadas nas propriedades do cofre e qualquer política armazenada no Azure Resource Manager será ignorada. Se for nulo ou não especificado, o cofre será criado com o valor padrão de false. Observe que as ações de gerenciamento são sempre autorizadas com RBAC.
enableSoftDelete	boolean	True	Propriedade para especificar se a funcionalidade "exclusão reversível" está habilitada para esse cofre de chaves. Se ele não estiver definido como nenhum valor (verdadeiro ou falso) ao criar um novo cofre de chaves, ele será definido como true por padrão. Depois de definido como true, ele não pode ser revertido para false.
enabledForDeployment	boolean		Propriedade para especificar se os Máquinas Virtuais do Azure têm permissão para recuperar certificados armazenados como segredos do cofre de chaves.
enabledForDiskEncryption	boolean		Propriedade para especificar se o Azure Disk Encryption tem permissão para recuperar segredos do cofre e desembrulhar chaves.
enabledForTemplateDeployment	boolean		Propriedade para especificar se o Resource Manager do Azure tem permissão para recuperar segredos do cofre de chaves.
hsmPoolResourceId	string		A ID do recurso do pool de HSM.
networkAcls	NetworkRuleSet		Regras que regem a acessibilidade do cofre de chaves de locais de rede específicos.
privateEndpointConnections	PrivateEndpointConnectionItem[]		Lista de conexões de ponto de extremidade privado associadas ao cofre de chaves.
provisioningState	VaultProvisioningState		Estado de provisionamento do cofre.
publicNetworkAccess	string	enabled	Propriedade para especificar se o cofre aceitará o tráfego da Internet pública. Se definido como "desabilitado" todo o tráfego, exceto o tráfego de ponto de extremidade privado e que se origina de serviços confiáveis, será bloqueado. Isso substituirá as regras de firewall definidas, o que significa que, mesmo que as regras de firewall estejam presentes, não respeitaremos as regras.
sku	Sku		Detalhes do SKU
softDeleteRetentionInDays	integer	90	softDelete dias de retenção de dados. Ele aceita >=7 e <=90.
tenantId	string		A ID de locatário do Azure Active Directory que deve ser usada para autenticar solicitações no cofre de chaves.
vaultUri	string		O URI do cofre para executar operações em chaves e segredos.

VaultProvisioningState

Estado de provisionamento do cofre.

Nome	Tipo	Description
RegisteringDns	string
Succeeded	string

VirtualNetworkRule

Uma regra que rege a acessibilidade de um cofre de uma rede virtual específica.

Nome	Tipo	Description
id	string	ID de recurso completa de uma sub-rede vnet, como '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.
ignoreMissingVnetServiceEndpoint	boolean	Propriedade para especificar se o NRP ignorará o marcar se a sub-rede pai tiver serviceEndpoints configurado.