Vaults - Create Or Update

Tjänst:

Key Vault

API-version:

2022-07-01

Skapa eller uppdatera ett nyckelvalv i den angivna prenumerationen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på den resursgrupp som servern tillhör.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
vaultName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Namnet på valvet
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Den Azure-plats som stöds där nyckelvalvet ska skapas.
properties	True	VaultProperties	Egenskaper för valvet
tags		object	Taggarna som ska tilldelas till nyckelvalvet.

Svar

Name	Typ	Description
200 OK	Vault	Skapat eller uppdaterat valv
201 Created	Vault	Skapat eller uppdaterat valv
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

Create a new vault or update an existing vault

Create or update a vault with network acls

Create a new vault or update an existing vault

Exempelbegäran

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault?api-version=2022-07-01

{
  "location": "westus",
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "sku": {
      "family": "A",
      "name": "standard"
    },
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt",
            "decrypt",
            "wrapKey",
            "unwrapKey",
            "sign",
            "verify",
            "get",
            "list",
            "create",
            "update",
            "import",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "secrets": [
            "get",
            "list",
            "set",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "certificates": [
            "get",
            "list",
            "delete",
            "create",
            "import",
            "update",
            "managecontacts",
            "getissuers",
            "listissuers",
            "setissuers",
            "deleteissuers",
            "manageissuers",
            "recover",
            "purge"
          ]
        }
      }
    ],
    "enabledForDeployment": true,
    "enabledForDiskEncryption": true,
    "enabledForTemplateDeployment": true,
    "publicNetworkAccess": "Enabled"
  }
}

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python create_vault.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.begin_create_or_update(
        resource_group_name="sample-resource-group",
        vault_name="sample-vault",
        parameters={
            "location": "westus",
            "properties": {
                "accessPolicies": [
                    {
                        "objectId": "00000000-0000-0000-0000-000000000000",
                        "permissions": {
                            "certificates": [
                                "get",
                                "list",
                                "delete",
                                "create",
                                "import",
                                "update",
                                "managecontacts",
                                "getissuers",
                                "listissuers",
                                "setissuers",
                                "deleteissuers",
                                "manageissuers",
                                "recover",
                                "purge",
                            ],
                            "keys": [
                                "encrypt",
                                "decrypt",
                                "wrapKey",
                                "unwrapKey",
                                "sign",
                                "verify",
                                "get",
                                "list",
                                "create",
                                "update",
                                "import",
                                "delete",
                                "backup",
                                "restore",
                                "recover",
                                "purge",
                            ],
                            "secrets": ["get", "list", "set", "delete", "backup", "restore", "recover", "purge"],
                        },
                        "tenantId": "00000000-0000-0000-0000-000000000000",
                    }
                ],
                "enabledForDeployment": True,
                "enabledForDiskEncryption": True,
                "enabledForTemplateDeployment": True,
                "publicNetworkAccess": "Enabled",
                "sku": {"family": "A", "name": "standard"},
                "tenantId": "00000000-0000-0000-0000-000000000000",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/createVault.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

Exempelsvar

Statuskod:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault",
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/vaults",
  "location": "westus",
  "tags": {},
  "systemData": {
    "createdBy": "keyVaultUser1",
    "createdByType": "User",
    "createdAt": "2020-01-01T12:00:00.0000000Z",
    "lastModifiedBy": "keyVaultUser2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-01T12:00:00.0000000Z"
  },
  "properties": {
    "sku": {
      "family": "A",
      "name": "standard"
    },
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "networkAcls": {
      "bypass": "AzureServices",
      "defaultAction": "Deny",
      "ipRules": [
        {
          "value": ""
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "",
          "ignoreMissingVnetServiceEndpoint": false
        }
      ]
    },
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt",
            "decrypt",
            "wrapKey",
            "unwrapKey",
            "sign",
            "verify",
            "get",
            "list",
            "create",
            "update",
            "import",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "secrets": [
            "get",
            "list",
            "set",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "certificates": [
            "get",
            "list",
            "delete",
            "create",
            "import",
            "update",
            "managecontacts",
            "getissuers",
            "listissuers",
            "setissuers",
            "deleteissuers",
            "manageissuers",
            "recover",
            "purge"
          ]
        }
      }
    ],
    "privateEndpointConnections": [
      {
        "id": "",
        "etag": "",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": ""
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "enabledForDeployment": true,
    "enabledForDiskEncryption": true,
    "enabledForTemplateDeployment": true,
    "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
    "vaultUri": "https://sample-vault.vault.azure.net",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled"
  }
}

Statuskod:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault",
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/vaults",
  "location": "westus",
  "tags": {},
  "systemData": {
    "createdBy": "keyVaultUser1",
    "createdByType": "User",
    "createdAt": "2020-01-01T12:00:00.0000000Z",
    "lastModifiedBy": "keyVaultUser2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-01T12:00:00.0000000Z"
  },
  "properties": {
    "sku": {
      "family": "A",
      "name": "standard"
    },
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt",
            "decrypt",
            "wrapKey",
            "unwrapKey",
            "sign",
            "verify",
            "get",
            "list",
            "create",
            "update",
            "import",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "secrets": [
            "get",
            "list",
            "set",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "certificates": [
            "get",
            "list",
            "delete",
            "create",
            "import",
            "update",
            "managecontacts",
            "getissuers",
            "listissuers",
            "setissuers",
            "deleteissuers",
            "manageissuers",
            "recover",
            "purge"
          ]
        }
      }
    ],
    "enabledForDeployment": true,
    "enabledForDiskEncryption": true,
    "enabledForTemplateDeployment": true,
    "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
    "vaultUri": "https://sample-vault.vault.azure.net",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled"
  }
}

Create or update a vault with network acls

Exempelbegäran

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault?api-version=2022-07-01

{
  "location": "westus",
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "sku": {
      "family": "A",
      "name": "standard"
    },
    "networkAcls": {
      "defaultAction": "Deny",
      "bypass": "AzureServices",
      "ipRules": [
        {
          "value": "124.56.78.91"
        },
        {
          "value": "'10.91.4.0/24'"
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"
        }
      ]
    },
    "enabledForDeployment": true,
    "enabledForDiskEncryption": true,
    "enabledForTemplateDeployment": true
  }
}

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python create_vault_with_network_acls.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.begin_create_or_update(
        resource_group_name="sample-resource-group",
        vault_name="sample-vault",
        parameters={
            "location": "westus",
            "properties": {
                "enabledForDeployment": True,
                "enabledForDiskEncryption": True,
                "enabledForTemplateDeployment": True,
                "networkAcls": {
                    "bypass": "AzureServices",
                    "defaultAction": "Deny",
                    "ipRules": [{"value": "124.56.78.91"}, {"value": "'10.91.4.0/24'"}],
                    "virtualNetworkRules": [
                        {
                            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"
                        }
                    ],
                },
                "sku": {"family": "A", "name": "standard"},
                "tenantId": "00000000-0000-0000-0000-000000000000",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/createVaultWithNetworkAcls.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

Exempelsvar

Statuskod:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault",
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/vaults",
  "location": "westus",
  "tags": {},
  "systemData": {
    "createdBy": "keyVaultUser1",
    "createdByType": "User",
    "createdAt": "2020-01-01T12:00:00.0000000Z",
    "lastModifiedBy": "keyVaultUser2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-01T12:00:00.0000000Z"
  },
  "properties": {
    "sku": {
      "family": "A",
      "name": "standard"
    },
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "networkAcls": {
      "defaultAction": "Deny",
      "bypass": "AzureServices",
      "ipRules": [
        {
          "value": "124.56.78.91/32"
        },
        {
          "value": "'10.91.4.0/24'"
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.network/virtualnetworks/test-vnet/subnets/subnet1"
        }
      ]
    },
    "enabledForDeployment": true,
    "enabledForDiskEncryption": true,
    "enabledForTemplateDeployment": true,
    "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
    "vaultUri": "https://sample-vault.vault.azure.net"
  }
}

Statuskod:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault",
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/vaults",
  "location": "westus",
  "tags": {},
  "systemData": {
    "createdBy": "keyVaultUser1",
    "createdByType": "User",
    "createdAt": "2020-01-01T12:00:00.0000000Z",
    "lastModifiedBy": "keyVaultUser2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-01T12:00:00.0000000Z"
  },
  "properties": {
    "sku": {
      "family": "A",
      "name": "standard"
    },
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "networkAcls": {
      "defaultAction": "Deny",
      "bypass": "AzureServices",
      "ipRules": [
        {
          "value": "124.56.78.91/32"
        },
        {
          "value": "'10.91.4.0/24'"
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.network/virtualnetworks/test-vnet/subnets/subnet1"
        }
      ]
    },
    "enabledForDeployment": true,
    "enabledForDiskEncryption": true,
    "enabledForTemplateDeployment": true,
    "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
    "vaultUri": "https://sample-vault.vault.azure.net"
  }
}

Definitioner

Name	Description
AccessPolicyEntry	En identitet som har åtkomst till nyckelvalvet. Alla identiteter i matrisen måste använda samma klient-ID som nyckelvalvets klient-ID.
ActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
CertificatePermissions	Behörigheter till certifikat
CloudError	Ett felsvar från Key Vault-resursprovidern
CloudErrorBody	Ett felsvar från Key Vault-resursprovidern
CreateMode	Valvets skapandeläge för att ange om valvet behöver återställas eller inte.
identityType	Den typ av identitet som skapade nyckelvalvsresursen.
IPRule	En regel som styr tillgängligheten för ett valv från en specifik IP-adress eller ett ip-intervall.
KeyPermissions	Behörigheter till nycklar
NetworkRuleAction	Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast efter att förbikopplingsegenskapen har utvärderats.
NetworkRuleBypassOptions	Talar om för vilken trafik som kan kringgå nätverksregler. Det kan vara "AzureServices" eller "None". Om det inte anges är standardvärdet "AzureServices".
NetworkRuleSet	En uppsättning regler som styr nätverkstillgängligheten för ett valv.
Permissions	Behörigheter som identiteten har för nycklar, hemligheter, certifikat och lagring.
PrivateEndpoint	Egenskaper för privat slutpunktsobjekt.
PrivateEndpointConnectionItem	Privat slutpunktsanslutningsobjekt.
PrivateEndpointConnectionProvisioningState	Det aktuella etableringstillståndet.
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState	Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.
SecretPermissions	Behörigheter till hemligheter
Sku	SKU-information
SkuFamily	SKU-familjenamn
SkuName	SKU-namn för att ange om nyckelvalvet är ett standardvalv eller ett Premium-valv.
StoragePermissions	Behörigheter till lagringskonton
SystemData	Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.
Vault	Resursinformation med utökad information.
VaultCreateOrUpdateParameters	Parametrar för att skapa eller uppdatera ett valv
VaultProperties	Egenskaper för valvet
VaultProvisioningState	Etableringstillstånd för valvet.
VirtualNetworkRule	En regel som styr tillgängligheten för ett valv från ett specifikt virtuellt nätverk.

AccessPolicyEntry

Objekt

En identitet som har åtkomst till nyckelvalvet. Alla identiteter i matrisen måste använda samma klient-ID som nyckelvalvets klient-ID.

Name	Typ	Description
applicationId	string (uuid)	Program-ID för klienten som begär för ett huvudnamn
objectId	string	Objekt-ID för en användare, tjänstens huvudnamn eller säkerhetsgrupp i Azure Active Directory-klientorganisationen för valvet. Objekt-ID:t måste vara unikt för listan över åtkomstprinciper.
permissions	Permissions	Behörigheter som identiteten har för nycklar, hemligheter och certifikat.
tenantId	string (uuid)	Det Azure Active Directory-klient-ID som ska användas för att autentisera begäranden till nyckelvalvet.

ActionsRequired

Uppräkning

Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.

Värde	Description
None

CertificatePermissions

Uppräkning

Behörigheter till certifikat

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

CloudError

Objekt

Ett felsvar från Key Vault-resursprovidern

Name	Typ	Description
error	CloudErrorBody	Ett felsvar från Key Vault-resursprovidern

CloudErrorBody

Objekt

Ett felsvar från Key Vault-resursprovidern

Name	Typ	Description
code	string	Felkod. Detta är en mnemonic som kan användas programmatiskt.
message	string	Användarvänligt felmeddelande. Meddelandet är vanligtvis lokaliserat och kan variera beroende på tjänstversion.

CreateMode

Uppräkning

Valvets skapandeläge för att ange om valvet behöver återställas eller inte.

Värde	Description
default
recover

identityType

Uppräkning

Den typ av identitet som skapade nyckelvalvsresursen.

Värde	Description
Application
Key
ManagedIdentity
User

IPRule

Objekt

En regel som styr tillgängligheten för ett valv från en specifik IP-adress eller ett ip-intervall.

Name	Typ	Description
value	string	Ett IPv4-adressintervall i CIDR-notation, till exempel "124.56.78.91" (enkel IP-adress) eller "124.56.78.0/24" (alla adresser som börjar med 124.56.78).

KeyPermissions

Uppräkning

Behörigheter till nycklar

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

NetworkRuleAction

Uppräkning

Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast efter att förbikopplingsegenskapen har utvärderats.

Värde	Description
Allow
Deny

NetworkRuleBypassOptions

Uppräkning

Talar om för vilken trafik som kan kringgå nätverksregler. Det kan vara "AzureServices" eller "None". Om det inte anges är standardvärdet "AzureServices".

Värde	Description
AzureServices
None

NetworkRuleSet

Objekt

En uppsättning regler som styr nätverkstillgängligheten för ett valv.

Name	Typ	Description
bypass	NetworkRuleBypassOptions	Talar om för vilken trafik som kan kringgå nätverksregler. Det kan vara "AzureServices" eller "None". Om det inte anges är standardvärdet "AzureServices".
defaultAction	NetworkRuleAction	Standardåtgärden när ingen regel från ipRules och från virtualNetworkRules matchar. Detta används endast efter att förbikopplingsegenskapen har utvärderats.
ipRules	IPRule[]	Listan över IP-adressregler.
virtualNetworkRules	VirtualNetworkRule[]	Listan över regler för virtuella nätverk.

Permissions

Objekt

Behörigheter som identiteten har för nycklar, hemligheter, certifikat och lagring.

Name	Typ	Description
certificates	CertificatePermissions[]	Behörigheter till certifikat
keys	KeyPermissions[]	Behörigheter till nycklar
secrets	SecretPermissions[]	Behörigheter till hemligheter
storage	StoragePermissions[]	Behörigheter till lagringskonton

PrivateEndpoint

Objekt

Egenskaper för privat slutpunktsobjekt.

Name	Typ	Description
id	string	Fullständig identifierare för den privata slutpunktsresursen.

PrivateEndpointConnectionItem

Objekt

Privat slutpunktsanslutningsobjekt.

Name	Typ	Description
etag	string	Ändras när det sker en ändring i tillståndet för den privata slutpunktsanslutningen.
id	string	ID för privat slutpunktsanslutning.
properties.privateEndpoint	PrivateEndpoint	Egenskaper för det privata slutpunktsobjektet.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Godkännandetillstånd för den privata länkanslutningen.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.

PrivateEndpointConnectionProvisioningState

Uppräkning

Det aktuella etableringstillståndet.

Värde	Description
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

Uppräkning

Anslutningsstatus för privat slutpunkt.

Värde	Description
Approved
Disconnected
Pending
Rejected

PrivateLinkServiceConnectionState

Objekt

Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.

Name	Typ	Description
actionsRequired	ActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
description	string	Anledningen till godkännande eller avvisande.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts, avvisats eller tagits bort av nyckelvalvets ägare.

SecretPermissions

Uppräkning

Behörigheter till hemligheter

Värde	Description
all
backup
delete
get
list
purge
recover
restore
set

Sku

Objekt

SKU-information

Name	Typ	Description
family	SkuFamily	SKU-familjenamn
name	SkuName	SKU-namn för att ange om nyckelvalvet är ett standardvalv eller ett Premium-valv.

SkuFamily

Uppräkning

SKU-familjenamn

Värde	Description
A

SkuName

Uppräkning

SKU-namn för att ange om nyckelvalvet är ett standardvalv eller ett Premium-valv.

Värde	Description
premium
standard

StoragePermissions

Uppräkning

Behörigheter till lagringskonton

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

SystemData

Objekt

Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för att skapa nyckelvalvets resurs (UTC).
createdBy	string	Identiteten som skapade nyckelvalvsresursen.
createdByType	identityType	Den typ av identitet som skapade nyckelvalvsresursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för nyckelvalvsresursens senaste ändring (UTC).
lastModifiedBy	string	Identiteten som senast ändrade nyckelvalvsresursen.
lastModifiedByType	identityType	Den typ av identitet som senast ändrade nyckelvalvsresursen.

Vault

Objekt

Resursinformation med utökad information.

Name	Typ	Description
id	string	Fullständigt kvalificerad identifierare för nyckelvalvsresursen.
location	string	Azure-platsen för nyckelvalvsresursen.
name	string	Namnet på nyckelvalvsresursen.
properties	VaultProperties	Egenskaper för valvet
systemData	SystemData	Systemmetadata för nyckelvalvet.
tags	object	Taggar som tilldelats till nyckelvalvsresursen.
type	string	Resurstyp för nyckelvalvsresursen.

VaultCreateOrUpdateParameters

Objekt

Parametrar för att skapa eller uppdatera ett valv

Name	Typ	Description
location	string	Den Azure-plats som stöds där nyckelvalvet ska skapas.
properties	VaultProperties	Egenskaper för valvet
tags	object	Taggarna som ska tilldelas till nyckelvalvet.

VaultProperties

Objekt

Egenskaper för valvet

Name	Typ	Standardvärde	Description
accessPolicies	AccessPolicyEntry[]		En matris med 0 till 1 024 identiteter som har åtkomst till nyckelvalvet. Alla identiteter i matrisen måste använda samma klient-ID som nyckelvalvets klient-ID. När createMode är inställt på recoverkrävs inte åtkomstprinciper. Annars krävs åtkomstprinciper.
createMode	CreateMode		Valvets skapandeläge för att ange om valvet behöver återställas eller inte.
enablePurgeProtection	boolean		Egenskap som anger om skydd mot rensning är aktiverat för det här valvet. Om du anger den här egenskapen till true aktiveras skydd mot rensning för det här valvet och dess innehåll . Endast Key Vault-tjänsten kan initiera en hård och oåterkallelig borttagning. Inställningen är endast effektiv om mjuk borttagning också är aktiverad. Det går inte att ångra aktiveringen av den här funktionen, dvs. egenskapen accepterar inte false som värde.
enableRbacAuthorization	boolean	False	Egenskap som styr hur dataåtgärder auktoriseras. När det är sant använder nyckelvalvet rollbaserad åtkomstkontroll (RBAC) för auktorisering av dataåtgärder och de åtkomstprinciper som anges i valvegenskaper ignoreras. När det är falskt använder nyckelvalvet de åtkomstprinciper som anges i valvegenskaper och alla principer som lagras i Azure Resource Manager ignoreras. Om null eller inte anges skapas valvet med standardvärdet false. Observera att hanteringsåtgärder alltid är auktoriserade med RBAC.
enableSoftDelete	boolean	True	Egenskap för att ange om funktionen "mjuk borttagning" är aktiverad för det här nyckelvalvet. Om det inte är inställt på något värde (sant eller falskt) när du skapar ett nytt nyckelvalv, anges det som standard till sant. När värdet är sant kan det inte återställas till false.
enabledForDeployment	boolean		Egenskap för att ange om virtuella Azure-datorer tillåts hämta certifikat som lagras som hemligheter från nyckelvalvet.
enabledForDiskEncryption	boolean		Egenskap för att ange om Azure Disk Encryption tillåts hämta hemligheter från valvet och packa upp nycklar.
enabledForTemplateDeployment	boolean		Egenskap för att ange om Azure Resource Manager tillåts hämta hemligheter från nyckelvalvet.
hsmPoolResourceId	string		Resurs-ID för HSM-pool.
networkAcls	NetworkRuleSet		Regler som styr åtkomsten till nyckelvalvet från specifika nätverksplatser.
privateEndpointConnections	PrivateEndpointConnectionItem[]		Lista över privata slutpunktsanslutningar som är associerade med nyckelvalvet.
provisioningState	VaultProvisioningState		Etableringstillstånd för valvet.
publicNetworkAccess	string	enabled	Egenskap för att ange om valvet ska acceptera trafik från offentligt Internet. Om den är inställd på "inaktiverad" blockeras all trafik utom privat slutpunktstrafik och den som kommer från betrodda tjänster. Detta åsidosätter de angivna brandväggsreglerna, vilket innebär att även om brandväggsreglerna finns kommer vi inte att respektera reglerna.
sku	Sku		SKU-information
softDeleteRetentionInDays	integer (int32)	90	softTa bort datakvarhållningsdagar. Den accepterar >=7 och <=90.
tenantId	string (uuid)		Det Azure Active Directory-klient-ID som ska användas för att autentisera begäranden till nyckelvalvet.
vaultUri	string		URI:n för valvet för att utföra åtgärder på nycklar och hemligheter.

VaultProvisioningState

Uppräkning

Etableringstillstånd för valvet.

Värde	Description
RegisteringDns
Succeeded

VirtualNetworkRule

Objekt

En regel som styr tillgängligheten för ett valv från ett specifikt virtuellt nätverk.

Name	Typ	Description
id	string	Fullständigt resurs-ID för ett vnet-undernät, till exempel "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Egenskap för att ange om NRP ska ignorera kontrollen om det överordnade undernätet har serviceEndpoints konfigurerade.