Microsoft.KeyVault vaults/secrets 2016-10-01

Template format

To create a Microsoft.KeyVault/vaults/secrets resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.KeyVault/vaults/secrets",
  "apiVersion": "2016-10-01",
  "tags": {},
  "properties": {
    "value": "string",
    "contentType": "string",
    "attributes": {
      "enabled": "boolean",
      "nbf": "integer",
      "exp": "integer"
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.KeyVault/vaults/secrets object

Name Type Required Value
name string Yes Name of the secret
type enum Yes secrets
-or-
Microsoft.KeyVault/vaults/secrets

See Set name and type for child resources.
apiVersion enum Yes 2016-10-01
tags object No The tags that will be assigned to the secret.
properties object Yes Properties of the secret - SecretProperties object

SecretProperties object

Name Type Required Value
value string No The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.
contentType string No The content type of the secret.
attributes object No The attributes of the secret. - SecretAttributes object

SecretAttributes object

Name Type Required Value
enabled boolean No Determines whether the object is enabled.
nbf integer No Not before date in seconds since 1970-01-01T00:00:00Z.
exp integer No Expiry date in seconds since 1970-01-01T00:00:00Z.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Application Gateway V2 with Key Vault

Deploy to Azure
This template deploys an Application Gateway V2 in a Virtual Network, a user defined identity, Key Vault, a secret (cert data), and access policy on Key Vault and Application Gateway.
Create an Azure Key Vault and a secret

Deploy to Azure
This template creates an Azure Key Vault and a secret.
Create ssh-keys and store in KeyVault

Deploy to Azure
This template uses the deploymentScript resource to generate ssh keys and stores the private key in keyVault.
Connect to a Key Vault via private endpoint

Deploy to Azure
This sample shows how to use configure a virtual network and private DNS zone to access Key Vault via private endpoint.
Create a Key Vault and a list of secrets

Deploy to Azure
This template creates a Key Vault and a list of secrets within the key vault as passed along with the parameters
Continuous Deployment to VM Scale Sets with Jenkins and Spinnaker

Deploy to Azure
This template allows you to deploy and configure a DevOps pipeline from an Aptly repository to a VM Scale Set in Azure.
Continuous Deployment to VM Scale Sets using Spinnaker

Deploy to Azure
This template allows you to install Spinnaker on VM or AKS. Specifically, as for the VM scenario you can deploy and configure a DevOps pipeline from an Aptly repository to a VM Scale Set in Azure.