Compartilhar via

New-AzCosmosDBMongoDBRoleDefinition

  • Referência
Módulo:
Az.CosmosDB

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

Sintaxe

New-AzCosmosDBMongoDBRoleDefinition
   -Id <String>
   -RoleName <String>
   -Type <String>
   -DatabaseName <String>
   -Privileges <PSMongoPrivilege[]>
   [-Roles <PSMongoRole[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzCosmosDBMongoDBRoleDefinition
   -ResourceGroupName <String>
   -AccountName <String>
   -Id <String>
   -RoleName <String>
   -Type <String>
   -DatabaseName <String>
   -Privileges <PSMongoPrivilege[]>
   [-Roles <PSMongoRole[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzCosmosDBMongoDBRoleDefinition
   -Id <String>
   -RoleName <String>
   -Type <String>
   -DatabaseName <String>
   -Privileges <PSMongoPrivilege[]>
   [-Roles <PSMongoRole[]>]
   -DatabaseAccountObject <PSDatabaseAccountGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzCosmosDBMongoDBRoleDefinition
   -Id <String>
   -RoleName <String>
   -Type <String>
   -DatabaseName <String>
   -Privileges <PSMongoPrivilege[]>
   [-Roles <PSMongoRole[]>]
   -DatabaseAccountObject <PSDatabaseAccountGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzCosmosDBMongoDBRoleDefinition
   -Id <String>
   -RoleName <String>
   -Type <String>
   -DatabaseName <String>
   -Privileges <PSMongoPrivilege[]>
   [-Roles <PSMongoRole[]>]
   [-ResourceId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Cria uma nova definição de função do CosmosDB MongoDB. Para especificar os privilégios da definição de função, use o cmdlet New-AzCosmosDBMongoDBPrivilege para criar objetos PSMongoPrivilege para passar por meio do parâmetro Privileges. Para especificar as funções da definição de função, use o cmdlet New-AzCosmosDBMongoDBRole para criar objetos PSMongoRole a serem passados por meio do parâmetro Roles.

Exemplos

Exemplo 1: Padrão

$Actions = 'insert', 'find'
  $PrivilegeResource = New-AzCosmosDBMongoDBPrivilegeResource -Database test -Collection test
  $Privilege = New-AzCosmosDBMongoDBPrivilege -PrivilegeResource $PrivilegeResource -Actions $Actions
  $Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName


New-AzCosmosDBMongoDBRoleDefinition `
	-AccountName accountName `
	-ResourceGroupName resourceGroupName `
	-DatabaseName test `
	-Id id `
	-Type CustomRole `
	-RoleName roleName `
	-Privileges $Privilege `
	-Roles $Roles

Id           : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbRoleDefinitions/id
RoleName     : roleName
Type         : CustomRole
DatabaseName : test
Privileges   : {Microsoft.Azure.Management.CosmosDB.Models.Privilege}
Roles        : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role}

Exemplo 2: ParentObject

$DatabaseAccount = Get-AzCosmosDBAccount -Name accountName -ResourceGroupName resourceGroupName
$Actions = 'insert', 'find'
$PrivilegeResource = New-AzCosmosDBMongoDBPrivilegeResource -Database test -Collection test
$Privilege = New-AzCosmosDBMongoDBPrivilege -PrivilegeResource $PrivilegeResource -Actions $Actions
$Roles = New-AzCosmosDBMongoDBRole -Database test -Role roleName
New-AzCosmosDBMongoDBRoleDefinition `
	-Id id `
	-Type CustomRole `
	-RoleName roleName `
	-Privileges $Privilege `
	-Roles $Roles `
	-DatabaseAccountObject $DatabaseAccount

Id           : /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/mongodbRoleDefinitions/id
RoleName     : roleName
Type         : CustomRole
DatabaseName : test
Privileges   : {Microsoft.Azure.Management.CosmosDB.Models.Privilege}
Roles        : {Microsoft.Azure.Management.CosmosDB.Models.Role, Microsoft.Azure.Management.CosmosDB.Models.Role}

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

-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

-DatabaseAccountObject

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

-DatabaseName

Nome do banco de dados para a definição de função do MongoDB.

Tipo: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 exclusivo de definição de função (o formato é <databaseName>.<roleName>).

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

-Privileges

Conjunto de privilégios para a API do CosmosDB MongoDB.

Tipo:PSMongoPrivilege[]
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

-ResourceId

ResourceId do recurso.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
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

-Roles

Conjunto de funções herdadas para a definição de função da API do CosmosDB MongoDB.

Tipo:PSMongoRole[]
Cargo:Named
Valor padrão:None
Obrigatório:False
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:True
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

Saídas

Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBRoleDefinitionGetResults