Compartilhar via


New-AzCosmosDBSqlRoleDefinition

Cria uma nova definição de função do CosmosDB Sql.

Sintaxe

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

Description

Cria uma nova definição de função do CosmosDB Sql. Os escopos atribuíveis podem ser totalmente qualificados (ou seja, /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/dbs/dbName) ou começar com o nome do banco de dados (ou seja, /dbs/dbName). Para especificar as permissões da definição de função, use o parâmetro DataAction e passe uma lista de cadeias de caracteres que serão transformadas em um único objeto Permission ou use o cmdlet New-AzCosmosDBPermission para criar objetos PSPermission para passar por meio do parâmetro Permission.

Exemplos

Exemplo 1: Usando 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}

Exemplo 2: Usando Permission e 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}

Parâmetros

-AccountName

Nome da conta de banco de dados do Cosmos DB.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-AssignableScope

Conjunto de caminhos de recursos abaixo dos quais uma Atribuição de Função pode ser anexada à Definição de Função. Por exemplo: '/', '/dbs/dbname','/dbs/dbname/colls/collname'.

Tipo:List<T>[String]
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DataAction

Conjunto de ações de dados concedidas por meio da Definição de Função. A lista de ações permitidas pode ser encontrada em: https://aka.ms/cosmos-native-rbac

Tipo:List<T>[String]
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Id

ID de atribuição de função.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ParentObject

Objeto de definição de função.

Tipo:PSDatabaseAccountGetResults
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Permission

A permissão é uma coleção de ações de dados.

Tipo:List<T>[PSPermission]
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ResourceGroupName

Nome do grupo de recursos.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-RoleName

Nome da definição de função.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Type

Tipo de definição de função, CustomRole ou BuiltInRole. O valor padrão é CustomRole.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

PSSqlRoleDefinitionGetResults

Saídas

PSSqlRoleDefinitionGetResults