New-AzKeyVaultRoleDefinition

參考

模組:: Az.KeyVault

在 HSM 上建立自定義角色定義。

Syntax

New-AzKeyVaultRoleDefinition
   [-HsmName] <String>
   [-Scope <String>]
   [-Role] <PSKeyVaultRoleDefinition>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzKeyVaultRoleDefinition
   [-HsmName] <String>
   [-Scope <String>]
   [-InputFile] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Cmdlet New-AzKeyVaultRoleDefinition 會在 Azure KeyVault 受控 HSM 的 Azure 角色型存取控制中建立自定義角色。

提供 JSON 角色定義檔案或 PSKeyVaultRoleDefinition 物件做為輸入。首先，使用 Get-AzKeyVaultRoleDefinition 命令來產生基準角色定義物件。然後，視需要修改其屬性。最後，使用此命令來使用角色定義建立自定義角色。

範例

範例 1

$role = Get-AzKeyVaultRoleDefinition -HsmName myHsm -RoleDefinitionName 'Managed HSM Crypto User'
$role.Name = $null
$role.RoleName = "my custom role"
$role.Description = "description for my role"
$role.Permissions[0].DataActions = @("Microsoft.KeyVault/managedHsm/roleAssignments/write/action", "Microsoft.KeyVault/managedHsm/roleAssignments/delete/action") # todo
New-AzKeyVaultRoleDefinition -HsmName myHsm -Role $role

此範例使用預先定義的「受控 HSM 密碼編譯使用者」角色作為範本來建立自定義角色。

範例 2

Get-AzKeyVaultRoleDefinition -HsmName myHsm -RoleDefinitionName 'Managed HSM Crypto User' | ConvertTo-Json -Depth 9 > C:\Temp\roleDefinition.json
# Edit roleDefinition.json. Make sure to clear "Name" so as not to overwrite an existing role.
New-AzKeyVaultRoleDefinition -HsmName myHsm -InputFile C:\Temp\roleDefinition.json

此範例會使用 JSON 檔案作為自定義角色的輸入。

參數

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HsmName

HSM 的名稱。

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputFile

包含單一角色定義的檔名。

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Role

角色定義物件。

Type:	PSKeyVaultRoleDefinition
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Scope

角色指派或定義套用至的範圍，例如 '/' 或 '/keys' 或 '/keys/{keyName}'。省略時會使用『/』。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

輸入

None

輸出

PSKeyVaultRoleDefinition