New-AzCosmosDBMongoDBRoleDefinition

モジュール:

Az.CosmosDB

新しい CosmosDB MongoDB ロール定義を作成します。

構文

New-AzCosmosDBMongoDBRoleDefinition
   -Id <String>
   -RoleName <String>
   -Type <String>
   -DatabaseName <String>
   -Privileges <PSMongoPrivilege[]>
   [-Roles <PSMongoRole[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzCosmosDBMongoDBRoleDefinition
   -ResourceGroupName <String>
   -AccountName <String>
   -Id <String>
   -RoleName <String>
   -Type <String>
   -DatabaseName <String>
   -Privileges <PSMongoPrivilege[]>
   [-Roles <PSMongoRole[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzCosmosDBMongoDBRoleDefinition
   -Id <String>
   -RoleName <String>
   -Type <String>
   -DatabaseName <String>
   -Privileges <PSMongoPrivilege[]>
   [-Roles <PSMongoRole[]>]
   -DatabaseAccountObject <PSDatabaseAccountGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzCosmosDBMongoDBRoleDefinition
   -Id <String>
   -RoleName <String>
   -Type <String>
   -DatabaseName <String>
   -Privileges <PSMongoPrivilege[]>
   [-Roles <PSMongoRole[]>]
   -DatabaseAccountObject <PSDatabaseAccountGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzCosmosDBMongoDBRoleDefinition
   -Id <String>
   -RoleName <String>
   -Type <String>
   -DatabaseName <String>
   -Privileges <PSMongoPrivilege[]>
   [-Roles <PSMongoRole[]>]
   [-ResourceId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

新しい CosmosDB MongoDB ロール定義を作成します。 ロール定義の特権を指定するには、New-AzCosmosDBMongoDBPrivilege コマンドレットを使用して、Privileges パラメーターを渡す PSMongoPrivilege オブジェクトを作成します。 ロール定義の Roles を指定するには、New-AzCosmosDBMongoDBRole コマンドレットを使用して PSMongoRole オブジェクトを作成し、Roles パラメーターを渡します。

例

例 1: 既定値

$Actions = 'insert', 'find'
  $PrivilegeResource = New-AzCosmosDBMongoDBPrivilegeResource -Database test -Collection test
  $Privilege = New-AzCosmosDBMongoDBPrivilege -PrivilegeResource $PrivilegeResource -Actions $Actions
  $Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName


New-AzCosmosDBMongoDBRoleDefinition `
	-AccountName accountName `
	-ResourceGroupName resourceGroupName `
	-DatabaseName test `
	-Id id `
	-Type CustomRole `
	-RoleName roleName `
	-Privileges $Privilege `
	-Roles $Roles

Id           : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbRoleDefinitions/id
RoleName     : roleName
Type         : CustomRole
DatabaseName : test
Privileges   : {Microsoft.Azure.Management.CosmosDB.Models.Privilege}
Roles        : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role}

例 2: ParentObject

$DatabaseAccount = Get-AzCosmosDBAccount -Name accountName -ResourceGroupName resourceGroupName
$Actions = 'insert', 'find'
$PrivilegeResource = New-AzCosmosDBMongoDBPrivilegeResource -Database test -Collection test
$Privilege = New-AzCosmosDBMongoDBPrivilege -PrivilegeResource $PrivilegeResource -Actions $Actions
$Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName
New-AzCosmosDBMongoDBRoleDefinition `
	-Id id `
	-Type CustomRole `
	-RoleName roleName `
	-Privileges $Privilege `
	-Roles $Roles `
	-DatabaseAccountObject $DatabaseAccount

Id           : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbRoleDefinitions/id
RoleName     : roleName
Type         : CustomRole
DatabaseName : test
Privileges   : {Microsoft.Azure.Management.CosmosDB.Models.Privilege}
Roles        : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role}

パラメーター

-AccountName

Cosmos DB データベース アカウントの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DatabaseAccountObject

ロール定義オブジェクト。

型:	PSDatabaseAccountGetResults
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-DatabaseName

MongoDB ロール定義のデータベース名。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Id

ロール定義の一意の ID (形式は <databaseName>.<roleName>)。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Privileges

CosmosDB MongoDB API の特権のセット。

型:	PSMongoPrivilege[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソース グループの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceId

リソースの ResourceId。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RoleName

ロール定義名。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Roles

CosmosDB MongoDB API ロール定義の継承されたロールのセット。

型:	PSMongoRole[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Type

ロール定義の種類 (CustomRole または BuiltInRole)。 既定値は CustomRole です。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

出力

Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBRoleDefinitionGetResults

関連リンク

• Get-AzCosmosDBMongoDBRoleDefinition
• Update-AzCosmosDBMongoDBRoleDefinition
• Remove-AzCosmosDBMongoDBRoleDefinition