Vaults - Update Access Policy

Riferimento

Service:: Key Vault

API Version:: 2022-07-01

Aggiornare i criteri di accesso in un insieme di credenziali delle chiavi nella sottoscrizione specificata.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
operationKind	path	True	AccessPolicyUpdateKind	Nome dell'operazione
resourceGroupName	path	True	string	Nome del gruppo di risorse a cui appartiene l'insieme di credenziali.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
vaultName	path	True	string	Nome dell'insieme di credenziali Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Versione api client.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties	True	VaultAccessPolicyProperties	Proprietà dei criteri di accesso

Risposte

Nome	Tipo	Descrizione
200 OK	VaultAccessPolicyParameters	Criteri di accesso aggiornati
201 Created	VaultAccessPolicyParameters	Criteri di accesso aggiornati
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

Add an access policy, or update an access policy with new permissions

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/add?api-version=2022-07-01

{
  "properties": {
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt"
          ],
          "secrets": [
            "get"
          ],
          "certificates": [
            "get"
          ]
        }
      }
    ]
  }
}

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python update_access_policies_add.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_access_policy(
        resource_group_name="sample-group",
        vault_name="sample-vault",
        operation_kind="add",
        parameters={
            "properties": {
                "accessPolicies": [
                    {
                        "objectId": "00000000-0000-0000-0000-000000000000",
                        "permissions": {"certificates": ["get"], "keys": ["encrypt"], "secrets": ["get"]},
                        "tenantId": "00000000-0000-0000-0000-000000000000",
                    }
                ]
            }
        },
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/updateAccessPoliciesAdd.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-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/",
  "type": "Microsoft.KeyVault/vaults/accessPolicies",
  "properties": {
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt"
          ],
          "secrets": [
            "get"
          ],
          "certificates": [
            "get"
          ]
        }
      }
    ]
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/",
  "type": "Microsoft.KeyVault/vaults/accessPolicies",
  "properties": {
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt"
          ],
          "secrets": [
            "get"
          ],
          "certificates": [
            "get"
          ]
        }
      }
    ]
  }
}

Definizioni

Nome	Descrizione
AccessPolicyEntry	Identità che ha accesso all'insieme di credenziali delle chiavi. Tutte le identità nella matrice devono usare lo stesso ID tenant dell'ID tenant dell'insieme di credenziali delle chiavi.
AccessPolicyUpdateKind	Nome dell'operazione
CertificatePermissions	Autorizzazioni per i certificati
CloudError	Risposta di errore da Key Vault provider di risorse
CloudErrorBody	Risposta di errore da Key Vault provider di risorse
KeyPermissions	Autorizzazioni per le chiavi
Permissions	Autorizzazioni per l'identità per chiavi, segreti, certificati e archiviazione.
SecretPermissions	Autorizzazioni per i segreti
StoragePermissions	Autorizzazioni per gli account di archiviazione
VaultAccessPolicyParameters	Parametri per l'aggiornamento dei criteri di accesso in un insieme di credenziali
VaultAccessPolicyProperties	Proprietà dei criteri di accesso dell'insieme di credenziali

AccessPolicyEntry

Identità che ha accesso all'insieme di credenziali delle chiavi. Tutte le identità nella matrice devono usare lo stesso ID tenant dell'ID tenant dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
applicationId	string	ID applicazione del client che effettua una richiesta per conto di un'entità
objectId	string	ID oggetto di un utente, di un'entità servizio o di un gruppo di sicurezza nel tenant di Azure Active Directory per l'insieme di credenziali. L'ID oggetto deve essere univoco per l'elenco dei criteri di accesso.
permissions	Permissions	Autorizzazioni per l'identità per chiavi, segreti e certificati.
tenantId	string	ID tenant di Azure Active Directory da usare per autenticare le richieste all'insieme di credenziali delle chiavi.

AccessPolicyUpdateKind

Nome dell'operazione

Nome	Tipo	Descrizione
add	string
remove	string
replace	string

CertificatePermissions

Autorizzazioni per i certificati

Nome	Tipo	Descrizione
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

Risposta di errore da Key Vault provider di risorse

Nome	Tipo	Descrizione
error	CloudErrorBody	Risposta di errore da Key Vault provider di risorse

CloudErrorBody

Risposta di errore da Key Vault provider di risorse

Nome	Tipo	Descrizione
code	string	Codice di errore. Si tratta di un mnemonico che può essere utilizzato a livello di codice.
message	string	Messaggio di errore descrittivo. Il messaggio viene in genere localizzato e può variare con la versione del servizio.

KeyPermissions

Autorizzazioni per le chiavi

Nome	Tipo	Descrizione
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

Permissions

Autorizzazioni per l'identità per chiavi, segreti, certificati e archiviazione.

Nome	Tipo	Descrizione
certificates	CertificatePermissions[]	Autorizzazioni per i certificati
keys	KeyPermissions[]	Autorizzazioni per le chiavi
secrets	SecretPermissions[]	Autorizzazioni per i segreti
storage	StoragePermissions[]	Autorizzazioni per gli account di archiviazione

SecretPermissions

Autorizzazioni per i segreti

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

StoragePermissions

Autorizzazioni per gli account di archiviazione

Nome	Tipo	Descrizione
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

VaultAccessPolicyParameters

Parametri per l'aggiornamento dei criteri di accesso in un insieme di credenziali

Nome	Tipo	Descrizione
id	string	ID risorsa dei criteri di accesso.
location	string	Tipo di risorsa dei criteri di accesso.
name	string	Nome della risorsa dei criteri di accesso.
properties	VaultAccessPolicyProperties	Proprietà dei criteri di accesso
type	string	Nome della risorsa dei criteri di accesso.

VaultAccessPolicyProperties

Proprietà dei criteri di accesso dell'insieme di credenziali

Nome	Tipo	Descrizione
accessPolicies	AccessPolicyEntry[]	Matrice da 0 a 16 identità che hanno accesso all'insieme di credenziali delle chiavi. Tutte le identità nella matrice devono usare lo stesso ID tenant dell'ID tenant dell'insieme di credenziali delle chiavi.