Skip to content

Remove CosmosDbAccount

Daniel Scott-Raynsford edited this page Dec 23, 2018 · 2 revisions

external help file: CosmosDB-help.xml Module Name: CosmosDB online version: schema: 2.0.0

Remove-CosmosDbAccount

SYNOPSIS

Delete a Cosmos DB account from Azure.

SYNTAX

Remove-CosmosDbAccount [-Name] <String> [-ResourceGroupName] <String> [-AsJob] [-Force] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Use to delete an Azure Cosmos DB account from a resource group.

EXAMPLES

Example 1

PS C:\> Remove-CosmosDbAccount -Name 'MyCosmosDBAccount' -ResourceGroupName 'MyResourceGroup'

Delete the Cosmos DB account named 'MyCosmosDBAccount' from the resource group 'MyResourceGroup'.

PARAMETERS

-AsJob

Remove the resource in the background. The function will return immediately with a Job object that can be used to query the state of the job.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-Force

Forces the deletion of the Cosmos DB account with out confirming with the user.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

The name of the Cosmos DB account to delete.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceGroupName

The name of the resource group containing the Cosmos DB account to delete.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

CosmosDB Cmdlets

Clone this wiki locally