Vaults - Update

Referência

Serviço:: Key Vault

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

Atualize um cofre de chaves na subscrição especificada.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do Grupo de Recursos ao qual o servidor pertence.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
vaultName	path	True	string	Nome do cofre Padrão Regex: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

Name	Tipo	Description
properties	VaultPatchProperties	Propriedades do cofre
tags	object	As etiquetas que serão atribuídas ao cofre de chaves.

Respostas

Name	Tipo	Description
200 OK	Vault	Cofre com patches
201 Created	Vault	Cofre com patches
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

Update an existing vault

PATCH 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

{
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "sku": {
      "family": "A",
      "name": "standard"
    },
    "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,
    "publicNetworkAccess": "Enabled"
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python update_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.update(
        resource_group_name="sample-resource-group",
        vault_name="sample-vault",
        parameters={
            "properties": {
                "accessPolicies": [
                    {
                        "objectId": "00000000-0000-0000-0000-000000000000",
                        "permissions": {
                            "certificates": [
                                "get",
                                "list",
                                "delete",
                                "create",
                                "import",
                                "update",
                                "managecontacts",
                                "getissuers",
                                "listissuers",
                                "setissuers",
                                "deleteissuers",
                                "manageissuers",
                                "recover",
                                "purge",
                            ],
                            "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"],
                        },
                        "tenantId": "00000000-0000-0000-0000-000000000000",
                    }
                ],
                "enabledForDeployment": True,
                "enabledForDiskEncryption": True,
                "enabledForTemplateDeployment": True,
                "publicNetworkAccess": "Enabled",
                "sku": {"family": "A", "name": "standard"},
                "tenantId": "00000000-0000-0000-0000-000000000000",
            }
        },
    )
    print(response)


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

Código de estado:: 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",
    "networkAcls": {
      "bypass": "AzureServices",
      "defaultAction": "Deny",
      "ipRules": [
        {
          "value": ""
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "",
          "ignoreMissingVnetServiceEndpoint": false
        }
      ]
    },
    "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"
          ]
        }
      }
    ],
    "privateEndpointConnections": [
      {
        "id": "",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": ""
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "enabledForDeployment": true,
    "enabledForDiskEncryption": true,
    "enabledForTemplateDeployment": true,
    "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
    "vaultUri": "https://sample-vault.vault.azure.net",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled"
  }
}

Código de estado:: 201

{
  "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

Name	Description
AccessPolicyEntry	Uma identidade que tenha acesso ao cofre de chaves. Todas as identidades na matriz têm de utilizar o mesmo ID de inquilino que o ID de inquilino do cofre de chaves.
ActionsRequired	Uma mensagem a indicar se as alterações no fornecedor de serviços necessitam de atualizações no consumidor.
CertificatePermissions	Permissões para certificados
CloudError	Uma resposta de erro do fornecedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do fornecedor de recursos Key Vault
CreateMode	O modo de criação do cofre para indicar se o cofre precisa ou não de ser recuperado.
identityType	O tipo de identidade que criou o recurso do cofre de chaves.
IPRule	Uma regra que rege a acessibilidade de um cofre a partir de um endereço IP ou intervalo ip específico.
KeyPermissions	Permissões para chaves
NetworkRuleAction	A ação predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada.
NetworkRuleBypassOptions	Indica que tráfego pode ignorar as regras de rede. Pode ser "AzureServices" ou "None". Se não for especificado, a predefinição é "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 final privado.
PrivateEndpointConnectionItem	Item de ligação de ponto final privado.
PrivateEndpointConnectionProvisioningState	O estado de aprovisionamento atual.
PrivateEndpointServiceConnectionStatus	O estado da ligação do ponto final privado.
PrivateLinkServiceConnectionState	Um objeto que representa o estado de aprovação da ligação de ligação privada.
SecretPermissions	Permissões para segredos
Sku	Detalhes do SKU
SkuFamily	Nome da família SKU
SkuName	Nome do SKU para especificar se o cofre de chaves é um cofre standard 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 recursos com detalhes alargados.
VaultPatchParameters	Parâmetros para criar ou atualizar um cofre
VaultPatchProperties	Propriedades do cofre
VaultProperties	Propriedades do cofre
VaultProvisioningState	Estado de aprovisionamento do cofre.
VirtualNetworkRule	Uma regra que rege a acessibilidade de um cofre a partir de uma rede virtual específica.

AccessPolicyEntry

Uma identidade que tenha acesso ao cofre de chaves. Todas as identidades na matriz têm de utilizar o mesmo ID de inquilino que o ID de inquilino do cofre de chaves.

Name	Tipo	Description
applicationId	string	ID da aplicação do cliente que faz o pedido em nome de um principal
objectId	string	O ID de objeto de um utilizador, principal de serviço ou grupo de segurança no inquilino do Azure Active Directory para o cofre. O ID do objeto tem de ser exclusivo para a lista de políticas de acesso.
permissions	Permissions	Permissões que a identidade tem para chaves, segredos e certificados.
tenantId	string	O ID de inquilino do Azure Active Directory que deve ser utilizado para autenticar pedidos no cofre de chaves.

ActionsRequired

Uma mensagem a indicar se as alterações no fornecedor de serviços necessitam de atualizações no consumidor.

Name	Tipo	Description
None	string

CertificatePermissions

Permissões para certificados

Name	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 fornecedor de recursos Key Vault

Name	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do fornecedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do fornecedor de recursos Key Vault

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

CreateMode

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

Name	Tipo	Description
default	string
recover	string

identityType

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

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

IPRule

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

Name	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

Name	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 predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada.

Name	Tipo	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

Indica que tráfego pode ignorar as regras de rede. Pode ser "AzureServices" ou "None". Se não for especificado, a predefinição é "AzureServices".

Name	Tipo	Description
AzureServices	string
None	string

NetworkRuleSet

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

Name	Tipo	Description
bypass	NetworkRuleBypassOptions	Indica que tráfego pode ignorar as regras de rede. Pode ser "AzureServices" ou "None". Se não for especificado, a predefinição é "AzureServices".
defaultAction	NetworkRuleAction	A ação predefinida quando nenhuma regra de ipRules e de virtualNetworkRules corresponde. Esta ação só é utilizada depois de a propriedade bypass ter sido avaliada.
ipRules	IPRule[]	A lista de regras de endereços IP.
virtualNetworkRules	VirtualNetworkRule[]	A lista de regras de rede virtual.

Permissions

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

Name	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 final privado.

Name	Tipo	Description
id	string	Identificador completo do recurso de ponto final privado.

PrivateEndpointConnectionItem

Item de ligação de ponto final privado.

Name	Tipo	Description
etag	string	Modificado sempre que existir uma alteração no estado da ligação de ponto final privado.
id	string	ID da ligação de ponto final privado.
properties.privateEndpoint	PrivateEndpoint	Propriedades do objeto de ponto final privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Estado de aprovação da ligação de ligação privada.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de aprovisionamento da ligação de ponto final privado.

PrivateEndpointConnectionProvisioningState

O estado de aprovisionamento atual.

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

PrivateEndpointServiceConnectionStatus

O estado da ligação do ponto final privado.

Name	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Um objeto que representa o estado de aprovação da ligação de ligação privada.

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

SecretPermissions

Permissões para segredos

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

Sku

Detalhes do SKU

Name	Tipo	Description
family	SkuFamily	Nome da família SKU
name	SkuName	Nome do SKU para especificar se o cofre de chaves é um cofre standard ou um cofre premium.

SkuFamily

Nome da família SKU

Name	Tipo	Description
A	string

SkuName

Nome do SKU para especificar se o cofre de chaves é um cofre standard ou um cofre premium.

Name	Tipo	Description
premium	string
standard	string

StoragePermissions

Permissões para contas de armazenamento

Name	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.

Name	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 da última modificação (UTC) do recurso do cofre de chaves.
lastModifiedBy	string	A identidade que modificou pela última vez o recurso do cofre de chaves.
lastModifiedByType	identityType	O tipo de identidade que modificou pela última vez o recurso do cofre de chaves.

Vault

Informações de recursos com detalhes alargados.

Name	Tipo	Description
id	string	Identificador completamente qualificado do recurso do cofre de chaves.
location	string	Localização 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	Etiquetas atribuídas ao recurso do cofre de chaves.
type	string	Tipo de recurso do recurso do cofre de chaves.

VaultPatchParameters

Parâmetros para criar ou atualizar um cofre

Name	Tipo	Description
properties	VaultPatchProperties	Propriedades do cofre
tags	object	As etiquetas que serão atribuídas ao cofre de chaves.

VaultPatchProperties

Propriedades do cofre

Name	Tipo	Description
accessPolicies	AccessPolicyEntry[]	Uma matriz de 0 a 16 identidades que têm acesso ao cofre de chaves. Todas as identidades na matriz têm de utilizar o mesmo ID de inquilino que o ID de inquilino do cofre de chaves.
createMode	CreateMode	O modo de criação do cofre para indicar se o cofre precisa ou não de ser recuperado.
enablePurgeProtection	boolean	Propriedade que especifica se a proteção contra a remoção está ativada para este cofre. Definir esta propriedade como verdadeiro ativa a proteção contra a remoção deste cofre e do respetivo conteúdo – apenas o serviço Key Vault pode iniciar uma eliminação difícil e irrecuperável. A definição só é eficaz se a eliminação recuperável também estiver ativada. Ativar esta funcionalidade é irreversível, ou seja, a propriedade não aceita falso como o respetivo valor.
enableRbacAuthorization	boolean	Propriedade que controla a forma como as ações de dados são autorizadas. Quando for verdadeiro, o cofre de chaves utilizará o Controlo de Acesso Baseado em Funções (RBAC) para autorização de ações de dados e as políticas de acesso especificadas nas propriedades do cofre serão ignoradas. Quando falso, o cofre de chaves utilizará 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 for especificado, o valor desta propriedade não será alterado.
enableSoftDelete	boolean	Propriedade para especificar se a funcionalidade "eliminação recuperável" está ativada para este cofre de chaves. Uma vez definido como verdadeiro, não pode ser revertido para falso.
enabledForDeployment	boolean	Propriedade para especificar se os Máquinas Virtuais do Azure têm permissão para obter certificados armazenados como segredos do cofre de chaves.
enabledForDiskEncryption	boolean	Propriedade para especificar se o Azure Disk Encryption tem permissão para obter segredos do cofre e desembrulhar chaves.
enabledForTemplateDeployment	boolean	Propriedade para especificar se o Azure Resource Manager está autorizado a obter segredos do cofre de chaves.
networkAcls	NetworkRuleSet	Uma coleção de regras que regem a acessibilidade do cofre a partir de localizações de rede específicas.
publicNetworkAccess	string	Propriedade para especificar se o cofre aceitará tráfego da Internet pública. Se definido como "desativado" todo o tráfego, exceto o tráfego de ponto final privado e o proveniente de serviços fidedignos, será bloqueado. Isto irá substituir as regras de firewall definidas, o que significa que, mesmo que as regras da firewall estejam presentes, não respeitaremos as regras.
sku	Sku	Detalhes do SKU
softDeleteRetentionInDays	integer	softDelete data retention days. Aceita >=7 e <=90.
tenantId	string	O ID de inquilino do Azure Active Directory que deve ser utilizado para autenticar pedidos no cofre de chaves.

VaultProperties