Vaults - Create Or Update

Creare o aggiornare un insieme di credenziali delle chiavi nella sottoscrizione specificata.

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

Parametri dell'URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nome del gruppo di risorse a cui appartiene il server.

subscriptionId
path True
  • string

Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure.Subscription credentials which uniquely identify Microsoft Azure subscription. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.

vaultName
path True
  • string

Nome dell'insieme di credenziali

Regex pattern: ^[a-zA-Z0-9-]{3,24}$

api-version
query True
  • string

Versione api client.

Corpo della richiesta

Name Required Type Description
location True
  • string

Posizione di Azure supportata in cui deve essere creato l'insieme di credenziali delle chiavi.

properties True

Proprietà dell'insieme di credenziali

tags
  • object

I tag che verranno assegnati all'insieme di credenziali delle chiavi.

Risposte

Name Type Description
200 OK

Vault creato o aggiornato

201 Created

Vault creato o aggiornato

Esempio

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

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault?api-version=2019-09-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
  }
}

Sample Response

{
  "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": {},
  "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,
    "vaultUri": "https://sample-vault.vault.azure.net"
  }
}
{
  "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": {},
  "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,
    "vaultUri": "https://sample-vault.vault.azure.net"
  }
}

Create or update a vault with network acls

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault?api-version=2019-09-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
  }
}

Sample Response

{
  "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": {},
  "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,
    "vaultUri": "https://sample-vault.vault.azure.net"
  }
}
{
  "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": {},
  "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,
    "vaultUri": "https://sample-vault.vault.azure.net"
  }
}

Definizioni

AccessPolicyEntry

Identità che hanno accesso all'insieme di credenziali delle chiavi. Tutte le identità nell'array devono utilizzare lo stesso ID tenant dell'ID tenant dell'insieme di credenziali delle chiavi.

CreateMode

Modalità di creazione del vault per indicare se il vault deve essere recuperato o meno.

IPRule

Regola che regola l'accessibilità di un insieme di credenziali da un indirizzo IP o un intervallo IP specifico.

NetworkRuleAction

L'azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrisponde. Viene utilizzato solo dopo la valutazione della proprietà bypass.

NetworkRuleBypassOptions

Indica il traffico che può ignorare le regole di rete. Può essere 'AzureServices' o 'None'. Se non specificato, il valore predefinito è 'AzureServices'.

NetworkRuleSet

Insieme di regole che regolano l'accessibilità di rete di un insieme di credenziali.

Permissions

Autorizzazioni dell'identità per chiavi, segreti, certificati e archiviazione.

PrivateEndpoint

Proprietà dell'oggetto endpoint privato.

PrivateEndpointConnectionItem

Elemento di connessione endpoint privato.

PrivateEndpointConnectionProvisioningState

Stato di provisioning corrente.

PrivateEndpointServiceConnectionStatus

Stato della connessione all'endpoint privato.

PrivateLinkServiceConnectionState

Oggetto che rappresenta lo stato di approvazione della connessione di collegamento privato.

Sku

Dettagli SKU

SkuFamily

Nome della famiglia SKU

SkuName

Nome SKU per specificare se l'insieme di credenziali delle chiavi è un insieme di credenziali standard o un insieme di credenziali premium.

Vault

Informazioni sulle risorse con dettagli estesi.

VaultCreateOrUpdateParameters

Parametri per la creazione o l'aggiornamento di un vault

VaultProperties

Proprietà dell'insieme di credenziali

VirtualNetworkRule

Regola che regola l'accessibilità di un insieme di credenziali da una rete virtuale specifica.

AccessPolicyEntry

Identità che hanno accesso all'insieme di credenziali delle chiavi. Tutte le identità nell'array devono utilizzare lo stesso ID tenant dell'ID tenant dell'insieme di credenziali delle chiavi.

Name Type Description
applicationId
  • string

ID applicazione del cliente che effettua una richiesta per conto di un'entità

objectId
  • string

ID oggetto di un utente, un'entità servizio o un gruppo di sicurezza nel tenant di Azure Active Directory per l'insieme di credenziali. L'ID oggetto deve essere univoco per l'elenco dei criteri di accesso.

permissions

Autorizzazioni di cui dispone l'identità per chiavi, segreti e certificati.

tenantId
  • string

ID tenant di Azure Active Directory che deve essere usato per l'autenticazione delle richieste all'insieme di credenziali delle chiavi.

CreateMode

Modalità di creazione del vault per indicare se il vault deve essere recuperato o meno.

Name Type Description
default
  • string
recover
  • string

IPRule

Regola che regola l'accessibilità di un insieme di credenziali da un indirizzo IP o un intervallo IP specifico.

Name Type Description
value
  • string

Un intervallo di indirizzi IPv4 in notazione CIDR, ad esempio '124.56.78.91' (indirizzo IP semplice) o '124.56.78.0/24' (tutti gli indirizzi che iniziano con 124.56.78).

NetworkRuleAction

L'azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrisponde. Viene utilizzato solo dopo la valutazione della proprietà bypass.

Name Type Description
Allow
  • string
Deny
  • string

NetworkRuleBypassOptions

Indica il traffico che può ignorare le regole di rete. Può essere 'AzureServices' o 'None'. Se non specificato, il valore predefinito è 'AzureServices'.

Name Type Description
AzureServices
  • string
None
  • string

NetworkRuleSet

Insieme di regole che regolano l'accessibilità di rete di un insieme di credenziali.

Name Type Description
bypass

Indica il traffico che può ignorare le regole di rete. Può essere 'AzureServices' o 'None'. Se non specificato, il valore predefinito è 'AzureServices'.

defaultAction

L'azione predefinita quando nessuna regola da ipRules e da virtualNetworkRules corrisponde. Viene utilizzato solo dopo la valutazione della proprietà bypass.

ipRules

Elenco di regole di indirizzi IP.

virtualNetworkRules

Elenco di regole di rete virtuale.

Permissions

Autorizzazioni dell'identità per chiavi, segreti, certificati e archiviazione.

Name Type Description
certificates
  • string[]

Autorizzazioni per i certificati

keys
  • string[]

Autorizzazioni per le chiavi

secrets
  • string[]

Autorizzazioni per i segreti

storage
  • string[]

Autorizzazioni per gli account di archiviazionePermissions to storage accounts

PrivateEndpoint

Proprietà dell'oggetto endpoint privato.

Name Type Description
id
  • string

Identificatore completo della risorsa endpoint privato.

PrivateEndpointConnectionItem

Elemento di connessione endpoint privato.

Name Type Description
properties.privateEndpoint

Proprietà dell'oggetto endpoint privato.

properties.privateLinkServiceConnectionState

Stato di approvazione della connessione di collegamento privato.

properties.provisioningState

Stato di provisioning della connessione all'endpoint privato.

PrivateEndpointConnectionProvisioningState

Stato di provisioning corrente.

Name Type Description
Creating
  • string
Deleting
  • string
Disconnected
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

PrivateEndpointServiceConnectionStatus

Stato della connessione all'endpoint privato.

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

Oggetto che rappresenta lo stato di approvazione della connessione di collegamento privato.

Name Type Description
actionRequired
  • string

Messaggio che indica se le modifiche nel provider di servizi richiedono aggiornamenti sul consumer.

description
  • string

Motivo dell'approvazione o del rifiuto.

status

Indica se la connessione è stata approvata, rifiutata o rimossa dal proprietario dell'insieme di credenziali delle chiavi.

Sku

Dettagli SKU

Name Type Description
family

Nome della famiglia SKU

name

Nome SKU per specificare se l'insieme di credenziali delle chiavi è un insieme di credenziali standard o un insieme di credenziali premium.

SkuFamily

Nome della famiglia SKU

Name Type Description
A
  • string

SkuName

Nome SKU per specificare se l'insieme di credenziali delle chiavi è un insieme di credenziali standard o un insieme di credenziali premium.

Name Type Description
premium
  • string
standard
  • string

Vault

Informazioni sulle risorse con dettagli estesi.

Name Type Description
id
  • string

Identificatore completo della risorsa dell'insieme di credenziali delle chiavi.

location
  • string

Posizione di Azure della risorsa dell'insieme di credenziali delle chiavi.

name
  • string

Nome della risorsa dell'insieme di credenziali delle chiavi.

properties

Proprietà dell'insieme di credenziali

tags
  • object

Tag assegnati alla risorsa dell'insieme di credenziali delle chiavi.

type
  • string

Tipo di risorsa della risorsa dell'insieme di credenziali delle chiavi.

VaultCreateOrUpdateParameters

Parametri per la creazione o l'aggiornamento di un vault

Name Type Description
location
  • string

Posizione di Azure supportata in cui deve essere creato l'insieme di credenziali delle chiavi.

properties

Proprietà dell'insieme di credenziali

tags
  • object

I tag che verranno assegnati all'insieme di credenziali delle chiavi.

VaultProperties

Proprietà dell'insieme di credenziali

Name Type Description
accessPolicies

Matrice da 0 a 1024 identità che hanno accesso all'insieme di credenziali delle chiavi. Tutte le identità nell'array devono utilizzare lo stesso ID tenant dell'ID tenant dell'insieme di credenziali delle chiavi. Quando createMode è recoverimpostato su , i criteri di accesso non sono necessari. In caso contrario, sono necessari criteri di accesso.

createMode

Modalità di creazione del vault per indicare se il vault deve essere recuperato o meno.

enablePurgeProtection
  • boolean

Proprietà che specifica se la protezione dall'eliminazione è abilitata per questo insieme di credenziali. L'impostazione di questa proprietà su true attiva la protezione dall'eliminazione per questo insieme di credenziali e il relativo contenuto: solo il servizio Key Vault può avviare un'eliminazione rigida e irreversibile. L'impostazione è efficace solo se è abilitata anche l'eliminazione temporanea. L'abilitazione di questa funzionalità è irreversibile, ovvero la proprietà non accetta false come valore.

enableRbacAuthorization
  • boolean

Proprietà che controlla la modalità di autorizzazione delle azioni dati. Se true, l'insieme di credenziali delle chiavi utilizzerà il controllo degli accessi in base al ruolo (RBAC) per l'autorizzazione delle azioni dati e i criteri di accesso specificati nelle proprietà dell'insieme di credenziali verranno ignorati (avviso: si tratta di una funzionalità di anteprima). Se false, l'insieme di credenziali delle chiavi utilizzerà i criteri di accesso specificati nelle proprietà dell'insieme di credenziali e tutti i criteri archiviati in Azure Resource Manager verranno ignorati. Se null o non specificato, l'insieme di credenziali viene creato con il valore predefinito false. Si noti che le azioni di gestione sono sempre autorizzate con il controllo degli accessi in base al ruolo.

enableSoftDelete
  • boolean

Proprietà per specificare se la funzionalità 'soft delete' è abilitata per questo insieme di credenziali delle chiavi. Se non è impostato su alcun valore (true o false) durante la creazione di un nuovo insieme di credenziali delle chiavi, verrà impostato su true per impostazione predefinita. Una volta impostato su true, non può essere ripristinato su false.

enabledForDeployment
  • boolean

Proprietà per specificare se alle Macchine virtuali di Azure è consentito recuperare i certificati archiviati come segreti dall'insieme di credenziali delle chiavi.

enabledForDiskEncryption
  • boolean

Proprietà per specificare se Azure Disk Encryption è autorizzato a recuperare segreti dall'insieme di credenziali e a annullare il wrapping delle chiavi.

enabledForTemplateDeployment
  • boolean

Proprietà per specificare se Azure Resource Manager è autorizzato a recuperare segreti dall'insieme di credenziali delle chiavi.

networkAcls

Regole che regolano l'accessibilità dell'insieme di credenziali delle chiavi da percorsi di rete specifici.

privateEndpointConnections

Elenco di connessioni endpoint privati associate all'insieme di credenziali delle chiavi.

sku

Dettagli SKU

softDeleteRetentionInDays
  • integer

softDelete giorni di conservazione dei dati. Accetta >7 e <90.

tenantId
  • string

ID tenant di Azure Active Directory che deve essere usato per l'autenticazione delle richieste all'insieme di credenziali delle chiavi.

vaultUri
  • string

URI dell'insieme di credenziali per l'esecuzione di operazioni su chiavi e segreti.

VirtualNetworkRule

Regola che regola l'accessibilità di un insieme di credenziali da una rete virtuale specifica.

Name Type Description
id
  • string

ID risorsa completa di una subnet vnet, ad esempio '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.