New-AzKeyVault
Key Vault を作成します。
構文
New-AzKeyVault
[-Name] <String>
[-ResourceGroupName] <String>
[-Location] <String>
[-EnabledForDeployment]
[-EnabledForTemplateDeployment]
[-EnabledForDiskEncryption]
[-EnablePurgeProtection]
[-DisableRbacAuthorization]
[-SoftDeleteRetentionInDays <Int32>]
[-PublicNetworkAccess <String>]
[-Sku <String>]
[-Tag <Hashtable>]
[-NetworkRuleSet <PSKeyVaultNetworkRuleSet>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>] 説明
New-AzKeyVault コマンドレットは、指定したリソース グループにキー コンテナーを作成します。 また、このコマンドレットは、現在ログオンしているユーザーに対して、キー コンテナー内のキーとシークレットを追加、削除、または一覧表示するためのアクセス許可を付与します。 注: 新しいキー コンテナーを作成しようとしたときに、サブスクリプションが名前空間 'Microsoft.KeyVault' を使用するように登録されていない場合は、 Register-AzResourceProvider -ProviderNamespace "Microsoft.KeyVault" を実行し、 New-AzKeyVault コマンドを再実行します。 詳細については、「Register-AzResourceProvider」を参照してください。
このコマンドレットは、入力パラメーターに従って、以下の Microsoft Graph API を呼び出す場合があります。
- GET /directoryObjects/{id}
- GET /users/{id}
- GET /servicePrincipals/{id}
- GET /groups/{id}
- GET /me
例
例 1: Standard キー コンテナーを作成する
New-AzKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US'
Vault Name : contoso03vault
Resource Group Name : group14
Location : East US
Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/group14/providers
/Microsoft.KeyVault/vaults/contoso03vault
Vault URI : https://contoso03vault.vault.azure.net/
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU : Standard
Enabled For Deployment? :
Enabled For Template Deployment? :
Enabled For Disk Encryption? :
Soft Delete Enabled? : True
Access Policies :
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Application ID :
Display Name : User Name (username@microsoft.com)
Permissions to Keys : all
Permissions to Secrets : all
Permissions to Certificates : all
Permissions to (Key Vault Managed) Storage : all
Network Rule Set :
Default Action : Allow
Bypass : AzureServices
IP Rules :
Virtual Network Rules :
Tags :このコマンドにより、Contoso03Vault という名前のキー コンテナーが、米国東部の Azure リージョンに作成されます。 このコマンドは、Group14 という名前のリソース グループにキー コンテナーを追加します。 コマンドは SKU パラメーターの値を指定しないため、Standard キー コンテナーを作成します。
例 2: Premium キー コンテナーを作成する
New-AzKeyVault -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -Location 'East US' -Sku 'Premium'
Vault Name : contoso03vault
Resource Group Name : group14
Location : East US
Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/group14/providers
/Microsoft.KeyVault/vaults/contoso03vault
Vault URI : https://contoso03vault.vault.azure.net/
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU : Premium
Enabled For Deployment? : False
Enabled For Template Deployment? : False
Enabled For Disk Encryption? : False
Soft Delete Enabled? :
Access Policies :
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Application ID :
Display Name : User Name (username@microsoft.com)
Permissions to Keys : all
Permissions to Secrets : all
Permissions to Certificates : all
Permissions to (Key Vault Managed) Storage : all
Network Rule Set :
Default Action : Allow
Bypass : AzureServices
IP Rules :
Virtual Network Rules :
Tags :このコマンドは、前の例と同様に、キー コンテナーを作成します。 ただし、Premium キー コンテナーを作成するために、 SKU パラメーターに Premium の値を指定します。
例 3
$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "110.0.1.0/24" -ServiceEndpoint Microsoft.KeyVault
$virtualNetwork = New-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG -Location westus -AddressPrefix "110.0.0.0/16" -Subnet $frontendSubnet
$myNetworkResId = (Get-AzVirtualNetwork -Name myVNet -ResourceGroupName myRG).Subnets[0].Id
$ruleSet = New-AzKeyVaultNetworkRuleSetObject -DefaultAction Allow -Bypass AzureServices -IpAddressRange "110.0.1.0/24" -VirtualNetworkResourceId $myNetworkResId
New-AzKeyVault -ResourceGroupName "myRg" -VaultName "myVault" -NetworkRuleSet $ruleSet -Location westus
Vault Name : myVault
Resource Group Name : myRg
Location : East US
Resource ID : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myRg/providers
/Microsoft.KeyVault/vaults/myVault
Vault URI : https://myVault.vault.azure.net/
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU : Premium
Enabled For Deployment? : False
Enabled For Template Deployment? : False
Enabled For Disk Encryption? : False
Soft Delete Enabled? :
Access Policies :
Tenant ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Object ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
Application ID :
Display Name : User Name (username@microsoft.com)
Permissions to Keys : all
Permissions to Secrets : all
Permissions to Certificates : all
Permissions to (Key Vault Managed) Storage : all
Network Rule Set :
Default Action : Allow
Bypass : AzureServices
IP Rules : 110.0.1.0/24
Virtual Network Rules : /subscriptions/0b1f6471-1bf0-4dda-ae
c3-cb9272f09590/resourcegroups/myRg/providers/microsoft.network/virtualnetworks
/myvnet/subnets/frontendsubnet
Tags :キー コンテナーを作成し、$myNetworkResIdによって識別される仮想ネットワークから指定された IP アドレスへのアクセスを許可するネットワーク 規則を指定します。 詳細については、「 New-AzKeyVaultNetworkRuleSetObject 」を参照してください。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DisableRbacAuthorization
指定した場合、ロールベースのアクセス制御 (RBAC) によるデータ アクションの承認を無効にし、コンテナーのプロパティで指定されたアクセス ポリシーが受け入れられます。 管理アクションは常に RBAC で承認されることに注意してください。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-EnabledForDeployment
仮想マシンの作成時など、このキー コンテナーがリソース作成時に参照される場合、Microsoft.Compute リソース プロバイダーがこのキー コンテナーからシークレットを取得できるようにします。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-EnabledForDiskEncryption
Azure ディスク暗号化サービスがシークレットを取得し、このキー コンテナーからキーのラップを解除できるようにします。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-EnabledForTemplateDeployment
テンプレートのデプロイでこのキー コンテナーが参照される場合、Azure Resource Manager がこのキー コンテナーからシークレットを取得できるようにします。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-EnablePurgeProtection
指定した場合、このコンテナーに対して即時削除に対する保護が有効になります。では、論理的な削除も有効にする必要があります。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Location
キー コンテナーを作成する Azure リージョンを指定します。 Get-AzLocation コマンドを使用して、選択内容を確認します。
| 型: | String |
| 配置: | 2 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
作成するキー コンテナーの名前を指定します。 名前は、文字、数字、またはハイフンの任意の組み合わせにすることができます。 名前の先頭と末尾は文字または数字にする必要があります。 名前は汎用一意である必要があります。
| 型: | String |
| Aliases: | VaultName |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-NetworkRuleSet
コンテナーのネットワーク 規則セットを指定します。 これは、特定のネットワークの場所からのキー コンテナーのアクセシビリティを制御します。 New-AzKeyVaultNetworkRuleSetObjectによって作成されます。
| 型: | PSKeyVaultNetworkRuleSet |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PublicNetworkAccess
コンテナーがパブリック インターネットからのトラフィックを受け入れるかどうかを指定します。 プライベート エンドポイント トラフィックを除くすべてのトラフィックを "無効" に設定すると、信頼されたサービスから送信されたトラフィックはブロックされます。 これにより、設定されたファイアウォール規則がオーバーライドされます。つまり、ファイアウォール規則が存在する場合でも、その規則は適用されません。 既定では、パブリック ネットワーク アクセスが有効になります。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ResourceGroupName
キー コンテナーを作成する既存のリソース グループの名前を指定します。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Sku
キー コンテナー インスタンスの SKU を指定します。 各 SKU で使用できる機能の詳細については、Azure Key Vault の価格に関する Web サイト (https://go.microsoft.com/fwlink/?linkid=512521) を参照してください。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-SoftDeleteRetentionInDays
削除されたリソースを保持する期間と、削除された状態のコンテナーまたはオブジェクトを消去できる期間を指定します。 既定値は 90 日です。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-SubscriptionId
サブスクリプションの ID です。 既定では、コマンドレットは現在のコンテキストで設定されているサブスクリプションで実行されます。 ユーザーが別のサブスクリプションを指定した場合、現在のコマンドレットはユーザーが指定したサブスクリプションで実行されます。 サブスクリプションのオーバーライドは、現在のコマンドレットのライフサイクル中にのみ有効になります。 コンテキスト内のサブスクリプションは変更されず、後続のコマンドレットには影響しません。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Tag
ハッシュ テーブルの形式のキーと値のペア。 例: @{key0="value0";key1=$null;key2="value2"}
| 型: | Hashtable |
| Aliases: | Tags |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |