你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

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 参数并传入将转换为单个 Permission 对象的字符串列表,或使用 New-AzCosmosDBPermission cmdlet 创建 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
不显示:False

参数集

ByFieldsDataActionsParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
ByFieldsPermissionsParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-AssignableScope

可在其中附加角色分配的资源路径集。 Eg. '/','/dbs/dbname','/dbs/dbname/colls/collname'。

参数属性

类型:

List<T>[String]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DataAction

通过角色定义授予的数据作集。 可在以下位置找到允许的作列表: https://aka.ms/cosmos-native-rbac

参数属性

类型:

List<T>[String]

默认值:None
支持通配符:False
不显示:False

参数集

ByFieldsDataActionsParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
ByParentObjectDataActionsParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Id

角色分配 ID。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ParentObject

角色定义对象。

参数属性

类型:PSDatabaseAccountGetResults
默认值:None
支持通配符:False
不显示:False

参数集

ByParentObjectDataActionsParameterSet
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False
ByParentObjectPermissionsParameterSet
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Permission

权限是数据作的集合。

参数属性

类型:

List<T>[PSPermission]

默认值:None
支持通配符:False
不显示:False

参数集

ByFieldsPermissionsParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
ByParentObjectPermissionsParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ResourceGroupName

资源组的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ByFieldsDataActionsParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
ByFieldsPermissionsParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RoleName

角色定义名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Type

角色定义的类型,即 CustomRole 或 BuiltInRole。 默认值为 CustomRole。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

PSSqlRoleDefinitionGetResults

输出

PSSqlRoleDefinitionGetResults