New-AzCosmosDBSqlRoleDefinition
新しい CosmosDB Sql ロール定義を作成します。
構文
ByFieldsDataActionsParameterSet (既定)
New-AzCosmosDBSqlRoleDefinition
-ResourceGroupName <String>
-AccountName <String>
-RoleName <String>
-AssignableScope <System.Collections.Generic.List`1[System.String]>
-DataAction <System.Collections.Generic.List`1[System.String]>
[-Id <String>]
[-Type <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByFieldsPermissionsParameterSet
New-AzCosmosDBSqlRoleDefinition
-ResourceGroupName <String>
-AccountName <String>
-RoleName <String>
-AssignableScope <System.Collections.Generic.List`1[System.String]>
-Permission <System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission]>
[-Id <String>]
[-Type <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByParentObjectDataActionsParameterSet
New-AzCosmosDBSqlRoleDefinition
-RoleName <String>
-AssignableScope <System.Collections.Generic.List`1[System.String]>
-DataAction <System.Collections.Generic.List`1[System.String]>
-ParentObject <PSDatabaseAccountGetResults>
[-Id <String>]
[-Type <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByParentObjectPermissionsParameterSet
New-AzCosmosDBSqlRoleDefinition
-RoleName <String>
-AssignableScope <System.Collections.Generic.List`1[System.String]>
-Permission <System.Collections.Generic.List`1[Microsoft.Azure.Commands.CosmosDB.Models.PSPermission]>
-ParentObject <PSDatabaseAccountGetResults>
[-Id <String>]
[-Type <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
新しい CosmosDB Sql ロール定義を作成します。
割り当て可能なスコープは、完全修飾 (/subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/dbs/dbName) またはデータベース名 (/dbs/dbName) で始めることができます。
ロール定義のアクセス許可を指定するには、DataAction パラメーターを使用して 1 つの Permission オブジェクトに変換される文字列の一覧を渡すか、New-AzCosmosDBPermission コマンドレットを使用して PSPermission オブジェクトを作成し、Permission パラメーターを渡します。
例
例 1: DataAction の使用
New-AzCosmosDBSqlRoleDefinition `
-AccountName accountName `
-ResourceGroupName resourceGroupName `
-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"
New-AzCosmosDBSqlRoleDefinition `
-Type CustomRole `
-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
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByFieldsDataActionsParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ByFieldsPermissionsParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AssignableScope
ロールの割り当てをロール定義にアタッチできるリソース パスのセット。 Eg. '/'、'/dbs/dbname'、'/dbs/dbname/colls/collname'。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DataAction
ロール定義によって付与されるデータ アクションのセット。 許可されるアクションの一覧は、次の場所にあります。 https://aka.ms/cosmos-native-rbac
パラメーターのプロパティ
パラメーター セット
ByFieldsDataActionsParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ByParentObjectDataActionsParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Id
ロールの割り当て ID。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ParentObject
ロール定義オブジェクト。
パラメーターのプロパティ
パラメーター セット
ByParentObjectDataActionsParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ByParentObjectPermissionsParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Permission
アクセス許可は、データ アクションのコレクションです。
パラメーターのプロパティ
パラメーター セット
ByFieldsPermissionsParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ByParentObjectPermissionsParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByFieldsDataActionsParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ByFieldsPermissionsParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RoleName
ロール定義名。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Type
ロール定義の種類 (CustomRole または BuiltInRole)。
既定値は CustomRole です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
