Vaults - Update Access Policy

Reference

Service:: Key Vault

API Version:: 2022-07-01

Aktualizujte zásady přístupu v trezoru klíčů v zadaném předplatném.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
operationKind	path	True	AccessPolicyUpdateKind	Název operace
resourceGroupName	path	True	string	Název skupiny prostředků, do které trezor patří.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
vaultName	path	True	string	Název trezoru Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Vyžadováno	Typ	Description
properties	True	VaultAccessPolicyProperties	Vlastnosti zásad přístupu

Odpovědi

Name	Typ	Description
200 OK	VaultAccessPolicyParameters	Aktualizované zásady přístupu
201 Created	VaultAccessPolicyParameters	Aktualizované zásady přístupu
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Příklady

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

Definice

Name	Description
AccessPolicyEntry	Identita, která má přístup k trezoru klíčů. Všechny identity v poli musí používat stejné ID tenanta jako ID tenanta trezoru klíčů.
AccessPolicyUpdateKind	Název operace
CertificatePermissions	Oprávnění k certifikátům
CloudError	Chybová odpověď od poskytovatele prostředků Key Vault
CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault
KeyPermissions	Oprávnění ke klíčům
Permissions	Oprávnění, která má identita ke klíčům, tajným klíčům, certifikátům a úložišti.
SecretPermissions	Oprávnění k tajným kódům
StoragePermissions	Oprávnění k účtům úložiště
VaultAccessPolicyParameters	Parametry pro aktualizaci zásad přístupu v trezoru
VaultAccessPolicyProperties	Vlastnosti zásad přístupu trezoru

AccessPolicyEntry

Identita, která má přístup k trezoru klíčů. Všechny identity v poli musí používat stejné ID tenanta jako ID tenanta trezoru klíčů.

Name	Typ	Description
applicationId	string	ID aplikace klienta, který provádí požadavek jménem objektu zabezpečení
objectId	string	ID objektu uživatele, instančního objektu nebo skupiny zabezpečení v tenantovi Azure Active Directory pro trezor. ID objektu musí být jedinečné pro seznam zásad přístupu.
permissions	Permissions	Oprávnění, která má identita ke klíčům, tajným klíčům a certifikátům.
tenantId	string	ID tenanta Azure Active Directory, které by se mělo použít k ověřování požadavků do trezoru klíčů.

AccessPolicyUpdateKind

Název operace

Name	Typ	Description
add	string
remove	string
replace	string

CertificatePermissions

Oprávnění k certifikátům

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

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault

CloudErrorBody

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
code	string	Kód chyby Toto je mnemotechnická funkce, kterou je možné využívat programově.
message	string	Uživatelsky přívětivá chybová zpráva. Zpráva je obvykle lokalizovaná a může se lišit podle verze služby.

KeyPermissions

Oprávnění ke klíčům

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

Oprávnění, která má identita ke klíčům, tajným klíčům, certifikátům a úložišti.

Name	Typ	Description
certificates	CertificatePermissions[]	Oprávnění k certifikátům
keys	KeyPermissions[]	Oprávnění ke klíčům
secrets	SecretPermissions[]	Oprávnění k tajným kódům
storage	StoragePermissions[]	Oprávnění k účtům úložiště

SecretPermissions

Oprávnění k tajným kódům

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

StoragePermissions

Oprávnění k účtům úložiště

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

Parametry pro aktualizaci zásad přístupu v trezoru

Name	Typ	Description
id	string	ID prostředku zásad přístupu.
location	string	Typ prostředku zásad přístupu.
name	string	Název prostředku zásad přístupu.
properties	VaultAccessPolicyProperties	Vlastnosti zásad přístupu
type	string	Název prostředku zásad přístupu.

VaultAccessPolicyProperties

Vlastnosti zásad přístupu trezoru

Name	Typ	Description
accessPolicies	AccessPolicyEntry[]	Pole 0 až 16 identit, které mají přístup k trezoru klíčů. Všechny identity v poli musí používat stejné ID tenanta jako ID tenanta trezoru klíčů.