Vaults - Update Access Policy

Referencia

Service:: Key Vault

API Version:: 2022-07-01

Hozzáférési szabályzatok frissítése egy kulcstartóban a megadott előfizetésben.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
operationKind	path	True	AccessPolicyUpdateKind	A művelet neve
resourceGroupName	path	True	string	Annak az erőforráscsoportnak a neve, amelyhez a tároló tartozik.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
vaultName	path	True	string	A tároló neve Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Ügyfél API-verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
properties	True	VaultAccessPolicyProperties	A hozzáférési szabályzat tulajdonságai

Válaszok

Name	Típus	Description
200 OK	VaultAccessPolicyParameters	A frissített hozzáférési szabályzatok
201 Created	VaultAccessPolicyParameters	A frissített hozzáférési szabályzatok
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Példák

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

Definíciók

Name	Description
AccessPolicyEntry	A kulcstartóhoz hozzáféréssel rendelkező identitás. A tömb minden identitásának ugyanazt a bérlőazonosítót kell használnia, mint a kulcstartó bérlőazonosítóját.
AccessPolicyUpdateKind	A művelet neve
CertificatePermissions	Tanúsítványokra vonatkozó engedélyek
CloudError	Hibaválasz Key Vault erőforrás-szolgáltatótól
CloudErrorBody	Hibaválasz Key Vault erőforrás-szolgáltatótól
KeyPermissions	Kulcsokhoz való engedélyek
Permissions	Az identitás kulcsokhoz, titkos kódokhoz, tanúsítványokhoz és tárolókhoz tartozó engedélyekkel rendelkezik.
SecretPermissions	Titkos kódokra vonatkozó engedélyek
StoragePermissions	Tárfiókokhoz való engedélyek
VaultAccessPolicyParameters	A hozzáférési szabályzat tárolóban való frissítésének paraméterei
VaultAccessPolicyProperties	A tároló hozzáférési szabályzatának tulajdonságai

AccessPolicyEntry

A kulcstartóhoz hozzáféréssel rendelkező identitás. A tömb minden identitásának ugyanazt a bérlőazonosítót kell használnia, mint a kulcstartó bérlőazonosítóját.

Name	Típus	Description
applicationId	string	A megbízó nevében kérelmet küldő ügyfél alkalmazásazonosítója
objectId	string	Egy felhasználó, szolgáltatásnév vagy biztonsági csoport objektumazonosítója a tároló Azure Active Directory-bérlőjében. Az objektumazonosítónak egyedinek kell lennie a hozzáférési szabályzatok listájához.
permissions	Permissions	Az identitás kulcsokhoz, titkos kulcsokhoz és tanúsítványokhoz tartozó engedélyekkel rendelkezik.
tenantId	string	Az Azure Active Directory bérlőazonosítója, amelyet a kulcstartóba irányuló kérések hitelesítéséhez kell használni.

AccessPolicyUpdateKind

A művelet neve

Name	Típus	Description
add	string
remove	string
replace	string

CertificatePermissions

Tanúsítványokra vonatkozó engedélyek

Name	Típus	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

Hibaválasz Key Vault erőforrás-szolgáltatótól

Name	Típus	Description
error	CloudErrorBody	Hibaválasz Key Vault erőforrás-szolgáltatótól

CloudErrorBody

Hibaválasz Key Vault erőforrás-szolgáltatótól

Name	Típus	Description
code	string	Hibakód. Ez egy mnemonikus, amely programozott módon használható.
message	string	Felhasználóbarát hibaüzenet. Az üzenet általában honosított, és a szolgáltatás verziójától függően változhat.

KeyPermissions

Kulcsokhoz való engedélyek

Name	Típus	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

Az identitás kulcsokhoz, titkos kódokhoz, tanúsítványokhoz és tárolókhoz tartozó engedélyekkel rendelkezik.

Name	Típus	Description
certificates	CertificatePermissions[]	Tanúsítványokra vonatkozó engedélyek
keys	KeyPermissions[]	Kulcsokhoz való engedélyek
secrets	SecretPermissions[]	Titkos kódokra vonatkozó engedélyek
storage	StoragePermissions[]	Tárfiókokhoz való engedélyek

SecretPermissions

Titkos kódokra vonatkozó engedélyek

Name	Típus	Description
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

StoragePermissions

Tárfiókokhoz való engedélyek

Name	Típus	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

A hozzáférési szabályzat tárolóban való frissítésének paraméterei

Name	Típus	Description
id	string	A hozzáférési szabályzat erőforrás-azonosítója.
location	string	A hozzáférési szabályzat erőforrástípusa.
name	string	A hozzáférési szabályzat erőforrásneve.
properties	VaultAccessPolicyProperties	A hozzáférési szabályzat tulajdonságai
type	string	A hozzáférési szabályzat erőforrásneve.

VaultAccessPolicyProperties

A tároló hozzáférési szabályzatának tulajdonságai

Name	Típus	Description
accessPolicies	AccessPolicyEntry[]	0–16 identitásból álló tömb, amely hozzáfér a kulcstartóhoz. A tömb minden identitásának ugyanazt a bérlőazonosítót kell használnia, mint a kulcstartó bérlőazonosítóját.