Vaults - Update Access Policy

Referentie

Service:: Key Vault

API-versie:: 2022-07-01

Toegangsbeleid bijwerken in een sleutelkluis in het opgegeven abonnement.

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

URI-parameters

Name	In	Vereist	Type	Description
operationKind	path	True	AccessPolicyUpdateKind	Naam van de bewerking
resourceGroupName	path	True	string	De naam van de resourcegroep waartoe de kluis behoort.
subscriptionId	path	True	string	Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
vaultName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Naam van de kluis
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Vereist	Type	Description
properties	True	VaultAccessPolicyProperties	Eigenschappen van het toegangsbeleid

Antwoorden

Name	Type	Description
200 OK	VaultAccessPolicyParameters	Het bijgewerkte toegangsbeleid
201 Created	VaultAccessPolicyParameters	Het bijgewerkte toegangsbeleid
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

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

Voorbeeldrespons

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

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

Definities

Name	Description
AccessPolicyEntry	Een identiteit die toegang heeft tot de sleutelkluis. Alle identiteiten in de matrix moeten dezelfde tenant-id gebruiken als de tenant-id van de sleutelkluis.
AccessPolicyUpdateKind	Naam van de bewerking
CertificatePermissions	Machtigingen voor certificaten
CloudError	Een foutreactie van de Key Vault-resourceprovider
CloudErrorBody	Een foutreactie van de Key Vault-resourceprovider
KeyPermissions	Machtigingen voor sleutels
Permissions	Machtigingen die de identiteit heeft voor sleutels, geheimen, certificaten en opslag.
SecretPermissions	Machtigingen voor geheimen
StoragePermissions	Machtigingen voor opslagaccounts
VaultAccessPolicyParameters	Parameters voor het bijwerken van het toegangsbeleid in een kluis
VaultAccessPolicyProperties	Eigenschappen van het toegangsbeleid voor de kluis

AccessPolicyEntry

Object

Een identiteit die toegang heeft tot de sleutelkluis. Alle identiteiten in de matrix moeten dezelfde tenant-id gebruiken als de tenant-id van de sleutelkluis.

Name	Type	Description
applicationId	string (uuid)	Toepassings-id van de clientaanvraag namens een principal
objectId	string	De object-id van een gebruiker, service-principal of beveiligingsgroep in de Azure Active Directory-tenant voor de kluis. De object-id moet uniek zijn voor de lijst met toegangsbeleidsregels.
permissions	Permissions	Machtigingen die de identiteit heeft voor sleutels, geheimen en certificaten.
tenantId	string (uuid)	De tenant-id van Azure Active Directory die moet worden gebruikt voor het verifiëren van aanvragen bij de sleutelkluis.

AccessPolicyUpdateKind

Inventarisatie

Naam van de bewerking

Waarde	Description
add
remove
replace

CertificatePermissions

Inventarisatie

Machtigingen voor certificaten

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

CloudError

Object

Een foutreactie van de Key Vault-resourceprovider

Name	Type	Description
error	CloudErrorBody	Een foutreactie van de Key Vault-resourceprovider

CloudErrorBody

Object

Een foutreactie van de Key Vault-resourceprovider

Name	Type	Description
code	string	Foutcode. Dit is een mnemonic die programmatisch kan worden verbruikt.
message	string	Gebruiksvriendelijk foutbericht. Het bericht is doorgaans gelokaliseerd en kan variëren met de serviceversie.

KeyPermissions

Inventarisatie

Machtigingen voor sleutels

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

Permissions

Object

Machtigingen die de identiteit heeft voor sleutels, geheimen, certificaten en opslag.

Name	Type	Description
certificates	CertificatePermissions[]	Machtigingen voor certificaten
keys	KeyPermissions[]	Machtigingen voor sleutels
secrets	SecretPermissions[]	Machtigingen voor geheimen
storage	StoragePermissions[]	Machtigingen voor opslagaccounts

SecretPermissions

Inventarisatie

Machtigingen voor geheimen

Waarde	Description
all
backup
delete
get
list
purge
recover
restore
set

StoragePermissions

Inventarisatie

Machtigingen voor opslagaccounts

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

VaultAccessPolicyParameters

Object

Parameters voor het bijwerken van het toegangsbeleid in een kluis

Name	Type	Description
id	string	De resource-id van het toegangsbeleid.
location	string	Het resourcetype van het toegangsbeleid.
name	string	De resourcenaam van het toegangsbeleid.
properties	VaultAccessPolicyProperties	Eigenschappen van het toegangsbeleid
type	string	De resourcenaam van het toegangsbeleid.

VaultAccessPolicyProperties

Object

Eigenschappen van het toegangsbeleid voor de kluis

Name	Type	Description
accessPolicies	AccessPolicyEntry[]	Een matrix van 0 tot 16 identiteiten die toegang hebben tot de sleutelkluis. Alle identiteiten in de matrix moeten dezelfde tenant-id gebruiken als de tenant-id van de sleutelkluis.

Delen via

Vaults - Update Access Policy

URI-parameters

Aanvraagbody

Antwoorden

Voorbeelden

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

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AccessPolicyEntry

AccessPolicyUpdateKind

CertificatePermissions

CloudError

CloudErrorBody

KeyPermissions

Permissions

SecretPermissions

StoragePermissions

VaultAccessPolicyParameters

VaultAccessPolicyProperties

Aanvullende resources