New-AzCosmosDBSqlRoleDefinition

Referência

Módulo:: Az.CosmosDB

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

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 Sql do CosmosDB. 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 pelo 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
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	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 ex. '/', '/dbs/dbname','/dbs/dbname/colls/collname'.

Tipo:	List<T>[String]
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Confirm

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

Tipo:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	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 consultada em: https://aka.ms/cosmos-native-rbac

Tipo:	List<T>[String]
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-DefaultProfile

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

Tipo:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Id

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

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ParentObject

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

Tipo:	PSDatabaseAccountGetResults
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-Permission

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

Tipo:	List<T>[PSPermission]
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ResourceGroupName

o nome do grupo de recursos.

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-RoleName

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

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Type

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

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

Entradas

PSSqlRoleDefinitionGetResults

Saídas