From 5d4a19f1c51b1870af2bf836a2f8691a70aec6f8 Mon Sep 17 00:00:00 2001 From: GitHub Action <> Date: Thu, 17 Mar 2022 22:54:38 +0000 Subject: [PATCH] Updating README with latest documentation --- README.md | 4 ++-- docs/accessPolicies.md | 2 +- docs/iprule.md | 2 +- docs/keyvaulttemplate-minimum.md | 30 ++++++++++++++++++++++++++++++ docs/networkruleset.md | 2 +- docs/permissions.md | 2 +- docs/sku.md | 2 +- docs/vaultproperties.md | 6 +++--- docs/vaults.md | 2 +- docs/virtualnetworkrule.md | 2 +- 10 files changed, 42 insertions(+), 12 deletions(-) create mode 100644 docs/keyvaulttemplate-minimum.md diff --git a/README.md b/README.md index adec6d0..0e11fc9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FArmReference%2Fkeyvault-vaults%2F1.0.0.0%2Fazuredeploy.json) +[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FArmReference%2Fkeyvault-vaults%2F1.0.0.1%2Fazuredeploy.json) # Azure template These templates are not meant for deployment, they simply build reference templates @@ -44,7 +44,7 @@ armTemplate | object | Fully populated template ```json { "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.1", + "contentVersion": "1.0.0.0", "metadata": { "template": "azuredeploy.json" }, diff --git a/docs/accessPolicies.md b/docs/accessPolicies.md index 76e5e20..86f1d05 100644 --- a/docs/accessPolicies.md +++ b/docs/accessPolicies.md @@ -46,7 +46,7 @@ accessPolicies | object | Azure KeyVault Access Policy ```json { "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.1", + "contentVersion": "1.0.0.0", "metadata": { "template": "reference/accessPolicies.json" }, diff --git a/docs/iprule.md b/docs/iprule.md index dd78259..5c42d86 100644 --- a/docs/iprule.md +++ b/docs/iprule.md @@ -25,7 +25,7 @@ IPRule | object | Azure KeyVault IPRule ```json { "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.1", + "contentVersion": "1.0.0.0", "metadata": { "template": "reference/iprule.json" }, diff --git a/docs/keyvaulttemplate-minimum.md b/docs/keyvaulttemplate-minimum.md new file mode 100644 index 0000000..b8374d1 --- /dev/null +++ b/docs/keyvaulttemplate-minimum.md @@ -0,0 +1,30 @@ +# Azure template + +## Snippets + +### Parameter file + +```json +{ + "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", + "contentVersion": "1.0.0.0", + "metadata": { + "template": "templates/keyvaulttemplate-minimum.json" + }, + "parameters": {} +} +``` + +### Command line + +#### PowerShell + +```powershell +New-AzResourceGroupDeployment -Name -ResourceGroupName -TemplateFile -TemplateParameterFile +``` + +#### Azure CLI + +```text +az group deployment create --name --resource-group --template-file --parameters @ +``` diff --git a/docs/networkruleset.md b/docs/networkruleset.md index 55c8996..2d669ad 100644 --- a/docs/networkruleset.md +++ b/docs/networkruleset.md @@ -52,7 +52,7 @@ NetworkRuleSet | object | Azure KeyVault NetworkRuleSet ```json { "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.1", + "contentVersion": "1.0.0.0", "metadata": { "template": "reference/networkruleset.json" }, diff --git a/docs/permissions.md b/docs/permissions.md index 4ee3bb0..06ca64e 100644 --- a/docs/permissions.md +++ b/docs/permissions.md @@ -46,7 +46,7 @@ permissions | object | Azure KeyVault Permissions Object ```json { "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.1", + "contentVersion": "1.0.0.0", "metadata": { "template": "reference/permissions.json" }, diff --git a/docs/sku.md b/docs/sku.md index cf48722..56eb338 100644 --- a/docs/sku.md +++ b/docs/sku.md @@ -36,7 +36,7 @@ sku | object | Azure KeyVault SKU ```json { "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.1", + "contentVersion": "1.0.0.0", "metadata": { "template": "reference/sku.json" }, diff --git a/docs/vaultproperties.md b/docs/vaultproperties.md index eac6783..331f4b9 100644 --- a/docs/vaultproperties.md +++ b/docs/vaultproperties.md @@ -9,7 +9,7 @@ softDeleteRetentionInDays | No | softDelete data retention days. It accept publicNetworkAccess | Yes | Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. networkAcls | No | A set of rules governing the network accessibility of a vault. sku | Yes | SKU details -accessPolicies | No | An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. +accessPolicies | No | An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. enabledForDeployment | No | Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. enabledForDiskEncryption | No | Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. enabledForTemplateDeployment | No | Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. @@ -55,7 +55,7 @@ SKU details ![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) -An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. +An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. ### enabledForDeployment @@ -118,7 +118,7 @@ properties | object | Azure KeyVault Properties ```json { "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.1", + "contentVersion": "1.0.0.0", "metadata": { "template": "reference/vaultproperties.json" }, diff --git a/docs/vaults.md b/docs/vaults.md index d497875..5883d9a 100644 --- a/docs/vaults.md +++ b/docs/vaults.md @@ -55,7 +55,7 @@ vaults | object | Azure KeyVault template ```json { "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.1", + "contentVersion": "1.0.0.0", "metadata": { "template": "reference/vaults.json" }, diff --git a/docs/virtualnetworkrule.md b/docs/virtualnetworkrule.md index f7a3020..214e1e5 100644 --- a/docs/virtualnetworkrule.md +++ b/docs/virtualnetworkrule.md @@ -32,7 +32,7 @@ VirtualNetworkRule | object | Azure KeyVault VirtualNetworkRule ```json { "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.1", + "contentVersion": "1.0.0.0", "metadata": { "template": "reference/virtualnetworkrule.json" },