Share via

New-AzCosmosDBMongoDBRoleDefinition

  • Reference
Modul:
Az.CosmosDB

Vytvoří novou definici role MongoDB služby Cosmos DB.

Syntax

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

Vytvoří novou definici role MongoDB služby Cosmos DB. Pokud chcete zadat oprávnění definice role, použijte rutinu New-AzCosmosDBMongoDBPrivilege k vytvoření objektů PSMongoPrivilege, které se předávají prostřednictvím parametru Privileges. Pokud chcete určit role definice role, použijte rutinu New-AzCosmosDBMongoDBRole k vytvoření objektů PSMongoRole, které se předávají prostřednictvím parametru Roles.

Příklady

Příklad 1: Výchozí

$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}

Příklad 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}

Parametry

-AccountName

Název účtu databáze Cosmos DB.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DatabaseAccountObject

Objekt definice role.

Type:PSDatabaseAccountGetResults
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DatabaseName

Název databáze pro definici role MongoDB.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Jedinečné ID definice role (formát je <databaseName>.<roleName>).

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Privileges

Sada oprávnění pro rozhraní MongoDB API služby Cosmos DB

Type:PSMongoPrivilege[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Název skupiny prostředků.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

ResourceId prostředku.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RoleName

Název definice role.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Roles

Sada zděděných rolí pro definici role rozhraní MongoDB API služby CosmosDB

Type:PSMongoRole[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Type

Typ definice role, buď CustomRole, nebo BuiltInRole. Výchozí hodnota je CustomRole.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Výstupy

Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBRoleDefinitionGetResults