Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzCosmosDBSqlRoleAssignment

Gets the CosmosDB Sql Role Assignment.

Syntax

ByNameParameterSet (Default) 

Get-AzCosmosDBSqlRoleAssignment
 -ResourceGroupName <String>
 -AccountName <String>
 [-Id <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

ByParentObjectParameterSet 

Get-AzCosmosDBSqlRoleAssignment
 -ParentObject <PSDatabaseAccountGetResults>
 [-Id <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Description

The Get-AzCosmosDBSqlRoleAssignment cmdlet gets the list of all existing CosmosDB Sql Role Assignments for a given ResourceGroupName, AccountName and gets a single CosmosDB Sql Role Assignment for a given ResourceGroupName, AccountName, Id. Id can be either fully qualified or just the Guid.

Examples

Example 1

Get-AzCosmosDBSqlRoleAssignment -AccountName accountName -ResourceGroupName resourceGroupName -Id roleAssignmentId

Id : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleAssignments/roleAssignmentId
Scope : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/
RoleDefinitionId : /subscriptions/subId/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlRoleDefinitions/roleDefinitionId
PrincipalId : principalId

Parameters

-AccountName

Name of the Cosmos DB database account.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

-Id

Role Assignment Id.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ParentObject

Cosmos DB Account object

Parameter properties

Type:PSDatabaseAccountGetResults
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceGroupName

Name of resource group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

PSSqlRoleAssignmentGetResults

Feedback

Was this page helpful?