次の方法で共有


Update-AzCosmosDBSqlRoleDefinition

既存の CosmosDB Sql ロール定義を更新します。

構文

Update-AzCosmosDBSqlRoleDefinition
      -ResourceGroupName <String>
      -AccountName <String>
      -Id <String>
      [-Type <String>]
      [-RoleName <String>]
      [-DataAction <System.Collections.Generic.List`1[System.String]>]
      [-Permission <System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission]>]
      [-AssignableScope <System.Collections.Generic.List`1[System.String]>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzCosmosDBSqlRoleDefinition
      -Id <String>
      [-Type <String>]
      [-RoleName <String>]
      [-DataAction <System.Collections.Generic.List`1[System.String]>]
      [-Permission <System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission]>]
      [-AssignableScope <System.Collections.Generic.List`1[System.String]>]
      -ParentObject <PSDatabaseAccountGetResults>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzCosmosDBSqlRoleDefinition
      -InputObject <PSSqlRoleDefinitionGetResults>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

既存の CosmosDB Sql ロール定義を更新します。 割り当て可能なスコープは、完全修飾 (/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/dbs/dbName) またはデータベース名 (/dbs/dbName) で始めることができます。 ID には、完全修飾または Guid のみを指定できます。 ロール定義の権限を指定するには、DataAction パラメーターを使用して単一の Permission オブジェクトに変換される文字列の一覧を渡すか、New-AzCosmosDBPermission コマンドレットを使用して PSPermission オブジェクトを作成して Permission パラメーターを渡します。

例 1

Update-AzCosmosDBSqlRoleDefinition `
	-AccountName accountName `
	-ResourceGroupName resourceGroupName `
	-Id id `
	-Type CustomRole `
	-RoleName roleName `
	-DataAction "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create" `
	-AssignableScope "/"

RoleName         : roleName
Id               : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/id
Type             : CustomRole
Permissions      : {Microsoft.Azure.Management.CosmosDB.Models.Permission}
AssignableScopes : {/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName}

例 2: アクセス許可と ParentObject の使用

$DatabaseAccount = Get-AzCosmosDBAccount -Name accountName -ResourceGroupName resourceGroupName
$Permission = New-AzCosmosDBPermission -DataAction "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create"
Update-AzCosmosDBSqlRoleDefinition `
	-Type CustomRole `
	-Id id `
	-RoleName roleName `
	-Permission $Permission `
	-AssignableScope "/" `
	-ParentObject $DatabaseAccount

RoleName         : roleName
Id               : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/id
Type             : CustomRole
Permissions      : {Microsoft.Azure.Management.CosmosDB.Models.Permission}
AssignableScopes : {/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName}

パラメーター

-AccountName

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

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

-AssignableScope

ロールの割り当てをロール定義にアタッチできるリソース パスのセット。 例: '/'、'/dbs/dbname'、'/dbs/dbname/colls/collname'。

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

-Confirm

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

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

-DataAction

ロール定義によって付与されるデータ アクションのセット。 許可されるアクションの一覧は、次の場所にあります。 https://aka.ms/cosmos-native-rbac

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

-DefaultProfile

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

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

-Id

ロール定義 ID。

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

-InputObject

CosmosDB アカウント オブジェクト

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

-ParentObject

CosmosDB アカウント オブジェクト

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

-Permission

アクセス許可は、データ アクションのコレクションです。

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

-ResourceGroupName

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

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

-RoleName

ロール定義名。

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

-Type

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

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

-WhatIf

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

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

入力

Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccount

出力

PSThroughputSettingsGetResults