Vaults - List By Resource Group
A operação Lista obtém informações sobre os cofres associados à assinatura e dentro do grupo de recursos especificado.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults?$top={$top}&api-version=2022-07-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do Grupo de Recursos ao qual o cofre pertence. |
subscription
|
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. |
$top
|
query |
integer int32 |
Número máximo de resultados a serem retornados. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Obtenha informações sobre todos os cofres de chaves no grupo de recursos especificado. |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Exemplos
List vaults in the specified resource group
Solicitação de exemplo
Resposta de exemplo
{
"value": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-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": "premium"
},
"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,
"enableSoftDelete": true,
"hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
"vaultUri": "https://sample-vault.vault.azure.net/",
"provisioningState": "Succeeded"
}
}
],
"nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}
Definições
Nome | Description |
---|---|
Access |
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. |
Actions |
Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor. |
Certificate |
Permissões para certificados |
Cloud |
Uma resposta de erro do provedor de recursos Key Vault |
Cloud |
Uma resposta de erro do provedor de recursos Key Vault |
Create |
O modo de criação do cofre para indicar se o cofre precisa ser recuperado ou não. |
identity |
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. |
Key |
Permissões para chaves |
Network |
A ação padrão quando nenhuma regra de ipRules e de virtualNetworkRules corresponder. Isso só é usado depois que a propriedade bypass é avaliada. |
Network |
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'. |
Network |
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. |
Private |
Propriedades do objeto de ponto de extremidade privado. |
Private |
Item de conexão de ponto de extremidade privado. |
Private |
O estado de provisionamento atual. |
Private |
A conexão do ponto de extremidade privado status. |
Private |
Um objeto que representa o estado de aprovação da conexão de link privado. |
Secret |
Permissões para segredos |
Sku |
Detalhes do SKU |
Sku |
Nome da família SKU |
Sku |
Nome da SKU para especificar se o cofre de chaves é um cofre padrão ou um cofre Premium. |
Storage |
Permissões para contas de armazenamento |
System |
Metadados relativos à criação e última modificação do recurso do cofre de chaves. |
Vault |
Informações de recurso com detalhes estendidos. |
Vault |
Lista de cofres |
Vault |
Propriedades do cofre |
Vault |
Estado de provisionamento do cofre. |
Virtual |
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 |
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 que indica 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 |
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 |
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 |
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 |
A lista de regras de rede virtual. |
Permissions
Permissões que a identidade tem para chaves, segredos, certificados e armazenamento.
Nome | Tipo | Description |
---|---|---|
certificates |
Permissões para certificados |
|
keys |
Permissões para chaves |
|
secrets |
Permissões para segredos |
|
storage |
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 |
Propriedades do objeto de ponto de extremidade privado. |
|
properties.privateLinkServiceConnectionState |
Estado de aprovação da conexão de link privado. |
|
properties.provisioningState |
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 do 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 |
Uma mensagem que indica 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 |
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 |
Nome da família SKU |
|
name |
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 |
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 |
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 |
Propriedades do cofre |
|
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. |
VaultListResult
Lista de cofres
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
A URL para obter o próximo conjunto de cofres. |
value |
Vault[] |
A lista de cofres. |
VaultProperties
Propriedades do cofre
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
accessPolicies |
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 |
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 |
Regras que regem a acessibilidade do cofre de chaves de locais de rede específicos. |
||
privateEndpointConnections |
Lista de conexões de ponto de extremidade privado associadas ao cofre de chaves. |
||
provisioningState |
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 |
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 configurados. |