Skip to content

Latest commit

 

History

History
185 lines (139 loc) · 4.17 KB

Remove-AzCognitiveServicesAccount.md

File metadata and controls

185 lines (139 loc) · 4.17 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.CognitiveServices.dll-Help.xml
Az.CognitiveServices
87A79215-5688-474D-822A-6B84B3D10E3F
2.0.0

Remove-AzCognitiveServicesAccount

SYNOPSIS

Deletes a Cognitive Services account.

SYNTAX

AccountParameterSet (Default)

Remove-AzCognitiveServicesAccount [-ResourceGroupName] <String> [-Name] <String> [-Force]
 [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]

DeletedAccountParameterSet

Remove-AzCognitiveServicesAccount [-ResourceGroupName] <String> [-Name] <String> [-InRemovedState]
 [-Location] <String> [-Force] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Remove-AzCognitiveServicesAccount cmdlet deletes the specified Cognitive Services account.

EXAMPLES

Example 1

This command doesn't return anything.

Remove-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis

PARAMETERS

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-Force

Forces the command to run without asking for user confirmation.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-InRemovedState

Specifies whether to only show the deleted accounts in the output.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: DeletedAccountParameterSet
Aliases:

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

-Location

Cognitive Services Account Location.

Type: System.String
Parameter Sets: DeletedAccountParameterSet
Aliases:

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

-Name

Specifies the name of the account to delete.

Type: System.String
Parameter Sets: (All)
Aliases: CognitiveServicesAccountName, AccountName

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

-ResourceGroupName

Specifies the name of the resource group the Cognitive Services account is assigned to.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
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.

INPUTS

System.String

OUTPUTS

System.Void

NOTES

RELATED LINKS

Get-AzCognitiveServicesAccount

New-AzCognitiveServicesAccount

Set-AzCognitiveServicesAccount