Vaults - Update Access Policy

Référence

Service:: Key Vault

API Version:: 2022-07-01

Mettez à jour les stratégies d’accès dans un coffre de clés dans l’abonnement spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
operationKind	path	True	AccessPolicyUpdateKind	Nom de l’opération
resourceGroupName	path	True	string	Nom du groupe de ressources auquel appartient le coffre.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
vaultName	path	True	string	Nom du coffre Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Obligatoire	Type	Description
properties	True	VaultAccessPolicyProperties	Propriétés de la stratégie d’accès

Réponses

Nom	Type	Description
200 OK	VaultAccessPolicyParameters	Stratégies d’accès mises à jour
201 Created	VaultAccessPolicyParameters	Stratégies d’accès mises à jour
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

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"
          ]
        }
      }
    ]
  }
}

Définitions

Nom	Description
AccessPolicyEntry	Identité qui a accès au coffre de clés. Toutes les identités du tableau doivent utiliser le même ID de locataire que l’ID de locataire du coffre de clés.
AccessPolicyUpdateKind	Nom de l’opération
CertificatePermissions	Autorisations sur les certificats
CloudError	Réponse d’erreur de Key Vault fournisseur de ressources
CloudErrorBody	Réponse d’erreur de Key Vault fournisseur de ressources
KeyPermissions	Autorisations sur les clés
Permissions	Autorisations dont dispose l’identité pour les clés, les secrets, les certificats et le stockage.
SecretPermissions	Autorisations sur les secrets
StoragePermissions	Autorisations sur les comptes de stockage
VaultAccessPolicyParameters	Paramètres de mise à jour de la stratégie d’accès dans un coffre
VaultAccessPolicyProperties	Propriétés de la stratégie d’accès au coffre

AccessPolicyEntry

Identité qui a accès au coffre de clés. Toutes les identités du tableau doivent utiliser le même ID de locataire que l’ID de locataire du coffre de clés.

Nom	Type	Description
applicationId	string	ID d’application du client effectuant une demande pour le compte d’un principal
objectId	string	ID d’objet d’un utilisateur, d’un principal de service ou d’un groupe de sécurité dans le locataire Azure Active Directory pour le coffre. Cet ID d’objet doit être unique dans la liste des stratégies d’accès.
permissions	Permissions	Autorisations dont dispose l’identité pour les clés, les secrets et les certificats.
tenantId	string	ID de locataire Azure Active Directory qui doit être utilisé pour l’authentification des demandes adressées au coffre de clés.

AccessPolicyUpdateKind

Nom de l’opération

Nom	Type	Description
add	string
remove	string
replace	string

CertificatePermissions

Autorisations sur les certificats

Nom	Type	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

Réponse d’erreur de Key Vault fournisseur de ressources

Nom	Type	Description
error	CloudErrorBody	Réponse d’erreur de Key Vault fournisseur de ressources

CloudErrorBody

Réponse d’erreur de Key Vault fournisseur de ressources

Nom	Type	Description
code	string	Code d’erreur. Il s’agit d’un mnémonique qui peut être consommé par programmation.
message	string	Message d’erreur convivial. Le message est généralement localisé et peut varier en fonction de la version du service.

KeyPermissions

Autorisations sur les clés

Nom	Type	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

Permissions

Autorisations dont dispose l’identité pour les clés, les secrets, les certificats et le stockage.

Nom	Type	Description
certificates	CertificatePermissions[]	Autorisations sur les certificats
keys	KeyPermissions[]	Autorisations sur les clés
secrets	SecretPermissions[]	Autorisations sur les secrets
storage	StoragePermissions[]	Autorisations sur les comptes de stockage

SecretPermissions

Autorisations sur les secrets

Nom	Type	Description
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

StoragePermissions

Autorisations sur les comptes de stockage

Nom	Type	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

VaultAccessPolicyParameters

Paramètres de mise à jour de la stratégie d’accès dans un coffre

Nom	Type	Description
id	string	ID de ressource de la stratégie d’accès.
location	string	Type de ressource de la stratégie d’accès.
name	string	Nom de la ressource de la stratégie d’accès.
properties	VaultAccessPolicyProperties	Propriétés de la stratégie d’accès
type	string	Nom de la ressource de la stratégie d’accès.

VaultAccessPolicyProperties

Propriétés de la stratégie d’accès au coffre

Nom	Type	Description
accessPolicies	AccessPolicyEntry[]	Tableau de 0 à 16 identités ayant accès au coffre de clés. Toutes les identités du tableau doivent utiliser le même ID de locataire que l’ID de locataire du coffre de clés.