New-AzureRmKeyVault

參考

模組:: AzureRM.KeyVault

建立金鑰保存庫。

警告

自 2024 年 2 月 29 日起，AzureRM PowerShell 模組已正式淘汰。建議使用者從 AzureRM 遷移至 Az PowerShell 模組，以確保持續支援和更新。

雖然 AzureRM 模組可能仍可運作，但不再維護或支援它，但會根據用戶的判斷權和風險放置任何繼續使用。如需轉換至 Az 模組的指引，請參閱我們的移轉資源。

語法

New-AzureRmKeyVault
   [-Name] <String>
   [-ResourceGroupName] <String>
   [-Location] <String>
   [-EnabledForDeployment]
   [-EnabledForTemplateDeployment]
   [-EnabledForDiskEncryption]
   [-EnableSoftDelete]
   [-EnablePurgeProtection]
   [-Sku <SkuName>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

範例

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

PS C:\> New-AzureRmKeyVault -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?          : 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                        : get, create, delete, list, update,
                                   import, backup, restore, recover
                                   Permissions to Secrets                     : get, list, set, delete, backup,
                                   restore, recover
                                   Permissions to Certificates                : get, delete, list, create, import,
                                   update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers,
                                   setissuers, recover, backup, restore
                                   Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list,
                                   listsas, regeneratekey, set, setsas, update, recover, backup, restore

Tags                             :

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

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

PS C:\>New-AzureRmKeyVault -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                        : get, create, delete, list, update,
                                   import, backup, restore, recover
                                   Permissions to Secrets                     : get, list, set, delete, backup,
                                   restore, recover
                                   Permissions to Certificates                : get, delete, list, create, import,
                                   update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers,
                                   setissuers, recover, backup, restore
                                   Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list,
                                   listsas, regeneratekey, set, setsas, update, recover, backup, restore

Tags                             :

此命令會建立金鑰保存庫，就像先前的範例一樣。不過，它會為 SKU 參數指定 Premium 值，以建立進階密鑰保存庫。

參數

-Confirm

執行 Cmdlet 之前先提示您確認。

類型:	SwitchParameter
別名:	cf
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶

類型:	IAzureContextContainer
別名:	AzureRmContext, AzureCredential
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-EnabledForDeployment

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

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-EnabledForDiskEncryption

可讓 Azure 磁碟加密服務從此金鑰保存庫取得秘密和解除包裝密鑰。

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-EnabledForTemplateDeployment

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

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-EnablePurgeProtection

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

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-EnableSoftDelete

指定此金鑰儲存函式庫已啟用虛刪除功能。啟用虛刪除時，在寬限期內，您可以在刪除此金鑰保存庫及其內容之後復原。如需此功能的詳細資訊，請參閱 Azure 金鑰保存庫虛刪除概觀。如需操作說明，請參閱如何搭配PowerShell使用金鑰保存庫虛刪除。

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Location

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

類型:	String
Position:	2
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-Name

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

類型:	String
別名:	VaultName
Position:	0
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-ResourceGroupName

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

類型:	String
Position:	1
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-Sku

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

類型:	SkuName
接受的值:	Standard, Premium
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-Tag

哈希表形式的索引鍵/值組。例如：@{key0=“value0”;key1=$null;key2=“value2”}

類型:	Hashtable
別名:	Tags
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。未執行 Cmdlet。

類型:	SwitchParameter
別名:	wi
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

輸入

String

SwitchParameter

SkuName

Hashtable

輸出

PSKeyVault

共用方式為

New-AzureRmKeyVault

語法

Description

範例

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

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

參數

-Confirm

-DefaultProfile

-EnabledForDeployment

-EnabledForDiskEncryption

-EnabledForTemplateDeployment

-EnablePurgeProtection

-EnableSoftDelete

-Location

-Name

-ResourceGroupName

-Sku

-Tag

-WhatIf

輸入

輸出

其他資源

共用方式為

New-AzureRmKeyVault

語法

Description

範例

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

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

參數

-Confirm

-DefaultProfile

-EnabledForDeployment

-EnabledForDiskEncryption

-EnabledForTemplateDeployment

-EnablePurgeProtection

-EnableSoftDelete

-Location

-Name

-ResourceGroupName

-Sku

-Tag

-WhatIf

輸入

輸出

相關連結

其他資源