Edit

Clear-AzDefault

  • Reference
Module:
Az.Accounts

Clears the defaults set by the user in the current context.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Clear-AzDefault
     [-ResourceGroup]
     [-PassThru]
     [-Force]
     [-Scope <ContextModificationScope>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Clear-AzDefault cmdlet removes the defaults set by the user depending on the switch parameters specified by the user.

Examples

Example 1

Clear-AzDefault

This command removes all the defaults set by the user in the current context.

Example 2

Clear-AzDefault -ResourceGroup

This command removes the default resource group set by the user in the current context.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-Force

Remove all defaults if no default is specified

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

{{Fill PassThru Description}}

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroup

Clear Default Resource Group

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Scope

Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user.

Type:ContextModificationScope
Accepted values:Process, CurrentUser
Position:Named
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
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

SwitchParameter

Outputs

Boolean