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 waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
vaultName	path	True	string	Naam van de kluis Regex-patroon: `^[a-zA-Z0-9-]{3,24}$`
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 Key Vault resourceprovider
CloudErrorBody	Een foutreactie van 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

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	Toepassings-id van de client die een aanvraag indient 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	De Azure Active Directory-tenant-id die moet worden gebruikt voor het verifiëren van aanvragen voor de sleutelkluis.

AccessPolicyUpdateKind

Naam van de bewerking

Name	Type	Description
add	string
remove	string
replace	string

CertificatePermissions

Machtigingen voor certificaten

Name	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

Een foutreactie van Key Vault resourceprovider

Name	Type	Description
error	CloudErrorBody	Een foutreactie van Key Vault resourceprovider

CloudErrorBody

Een foutreactie van Key Vault resourceprovider

Name	Type	Description
code	string	Foutcode. Dit is een ezelsbruggetje dat programmatisch kan worden gebruikt.
message	string	Gebruiksvriendelijk foutbericht. Het bericht is doorgaans gelokaliseerd en kan per serviceversie verschillen.

KeyPermissions

Machtigingen voor sleutels

Name	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

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

Machtigingen voor geheimen

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

StoragePermissions

Machtigingen voor opslagaccounts

Name	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

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

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