Remove-AzCosmosDBSqlRoleDefinition

Reference

Module:: Az.CosmosDB

Deletes the CosmosDB Sql Role Definition.

Syntax

Remove-AzCosmosDBSqlRoleDefinition
      -ResourceGroupName <String>
      -AccountName <String>
      -Id <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzCosmosDBSqlRoleDefinition
      -Id <String>
      -ParentObject <PSDatabaseAccountGetResults>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzCosmosDBSqlRoleDefinition
      -InputObject <PSSqlRoleDefinitionGetResults>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzCosmosDBSqlRoleDefinition cmdlet deletes the CosmosDB Sql Role Definition corresponding to the given ResourceGroupName, AccountName and Id. Id can be either fully qualified or just the Guid.

Examples

Example 1

Remove-AzCosmosDBSqlRoleDefinition -ResourceGroupName resourceGroupName -AccountName accountName -Id id -PassThru

true

Parameters

-AccountName

Name of the Cosmos DB database account.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

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

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

-Id

Role Definition Id.

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

-InputObject

Role definition object.

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

-ParentObject

CosmosDB Account object

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

-PassThru

To be set to true if the user wants to receive an output. The output is true if the operation was successful and an error is thrown if not.

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

-ResourceGroupName

Name of resource group.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

PSSqlRoleDefinitionGetResults

Outputs

Void

Share via