共用方式為

New-AzKeyVault

模組:
Az.KeyVault Module

建立金鑰保存庫。

語法

Default (預設值) 

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>]

Description

New-AzKeyVault Cmdlet 會在指定的資源群組中建立金鑰保存庫。 此 Cmdlet 也會授與目前登入的使用者在金鑰保存庫中新增、移除或列出金鑰和秘密的權限。 附註： 如果您在嘗試建立新的金鑰保存庫時看到錯誤訂 用帳戶未註冊以使用命名空間 'Microsoft.KeyVault' ，請執行 Register-AzResourceProvider -ProviderNamespace “Microsoft.KeyVault” ，然後重新執行 New-AzKeyVault 命令。 如需詳細資訊，請參閱 Register-AzResourceProvider。

Cmdlet 可能會根據輸入參數呼叫下列 Microsoft Graph API：

  • 取得 /directoryObjects/{id}
  • 取得 /users/{id}
  • 取得 /servicePrincipals/{id}
  • 取得 /群組/{id}
  • 取得/我

範例

範例 1：建立標準金鑰保存庫

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                             :

此命令會在美國東部的 Azure 區域中建立名為 Contoso03Vault 的金鑰保存庫。 此命令會將金鑰保存庫新增至名為 Group14 的資源群組。 由於命令不會指定 SKU 參數的值，因此會建立標準金鑰保存庫。

範例 2：建立進階金鑰保存庫

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                             :

此命令會建立金鑰保存庫，就像上一個範例一樣。 不過，它會指定 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

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:參閱

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DefaultProfile

用來與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶

參數屬性

類型:IAzureContextContainer
預設值:None
支援萬用字元:False
不要顯示:False
別名:AzContext, AzureRmContext, AzureCredential

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DisableRbacAuthorization

如果指定，則停用角色型存取控制 （RBAC） 授權資料動作，然後將遵循保存庫內容中指定的存取原則。 請注意，管理動作一律已獲得 RBAC 的授權。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-EnabledForDeployment

讓 Microsoft.Compute 資源提供者在資源建立中參考此金鑰保存庫時，例如在建立虛擬機器時，從此金鑰保存庫擷取秘密。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-EnabledForDiskEncryption

讓 Azure 磁碟加密服務能夠從此金鑰保存庫取得秘密並解壓縮金鑰。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-EnabledForTemplateDeployment

讓 Azure Resource Manager 在範本部署中參考此金鑰保存庫時，從此金鑰保存庫取得秘密。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-EnablePurgeProtection

如果指定，則會為此保存庫啟用防止立即刪除的保護;也需要啟用虛刪除。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Location

指定要在其中建立金鑰保存庫的 Azure 區域。 使用命令 Get-AzLocation 來查看您的選擇。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:2
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Name

指定要建立的金鑰保存庫名稱。 名稱可以是字母、數字或連字號的任意組合。 名稱必須以字母或數字開頭和結尾。 名稱必須是通用唯一的。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False
別名:保管庫名稱

參數集

(All)
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-NetworkRuleSet

指定 Vault 的網路規則集。 它會控管金鑰保存庫從特定網路位置的可存取性。 創建者 New-AzKeyVaultNetworkRuleSetObject.

參數屬性

類型:PSKeyVaultNetworkRuleSet
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PublicNetworkAccess

指定保存庫是否接受來自公用網際網路的流量。 如果設定為 「已停用」，則私人端點流量以外的所有流量，且源自信任服務的所有流量都會遭到封鎖。 這會覆寫設定的防火牆規則，這表示即使防火牆規則存在，我們也不會遵守規則。 預設情況下，我們將啟用公網存取。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ResourceGroupName

指定要在其中建立金鑰保存庫的現有資源群組名稱。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:1
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Sku

指定金鑰保存庫執行個體的 SKU。 如需每個 SKU 可用的功能的相關資訊，請參閱 Azure 金鑰保存庫定價網站 （https://go.microsoft.com/fwlink/?linkid=512521）。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-SoftDeleteRetentionInDays

指定已刪除資源的保留時間，以及可以清除處於已刪除狀態的 Vault 或物件的時間長度。 預設值為 90 天。

參數屬性

類型:Int32
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-SubscriptionId

訂用帳戶的識別碼。 根據預設，Cmdlet 會在目前內容中設定的訂用帳戶中執行。 如果使用者指定另一個訂用帳戶，則會在使用者指定的訂用帳戶中執行目前的 Cmdlet。 覆寫訂用帳戶只會在目前 Cmdlet 的生命週期期間生效。 它不會變更內容中的訂用帳戶，也不會影響後續的 Cmdlet。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Tag

雜湊表形式的鍵值對。 例如：@{key0=“value0”;key1=$null;key2=“值2”}

參數屬性

類型:Hashtable
預設值:None
支援萬用字元:False
不要顯示:False
別名:Tags

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 指令未執行。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:威斯康星州

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援常見參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸入

String

SwitchParameter

Hashtable

輸出

PSKeyVault