< Back
Set-AzureRmDefaultProfile
Post
NAME Set-AzureRmDefaultProfile
SYNOPSIS
Sets the given profile as a default profile to be used with all API version profile cmdlets.
SYNTAX
Set-AzureRmDefaultProfile [-Profile] {2017-03-09-profile | latest | <others>} [-Force] [-Scope {CurrentUser |
AllUsers}] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Sets the given profile as a default profile to be used with all API version profile cmdlets. Default profile
selection is persisted across sessions and shells.
PARAMETERS
-Force [<SwitchParameter>]
Set the given profile as default without prompting for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Profile <String>
The profile version to set as default. You can get a list of available profile versions using
Get-AzureRmProfile -ListAvailable
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Scope <String>
Specifies the installation scope of the modules. The acceptable values for this parameter are: AllUsers and
CurrentUser. The AllUsers scope lets modules be installed in a location that is accessible to all users of the
computer. The CurrentUser scope lets modules be installed in a location that is available only to the current
user.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
None
NOTES
Example 1 - Using Default Version Profile to Automatically Load Module Versions
PS C:\\> Set-AzureRmDefaultProfile -Profile '2017-03-09-profile'
PS C:\\> Import-Module AzureRM.Compute
Sets profile '2017-03-09-profile' as the default profile. When importing AzureRM modules like AzureRM.Compute,
you will automatically import a version of the module compatible with the default profile setting, unless you
explicitly specify a RequiredVersion.
Example 2 - Using Default Version Profile to Set Default Profile for BootStrapper cmdlets
PS C:\\> Set-AzureRmDefaultProfile -Profile '2017-03-09-profile'
PS c:\\> Install-AzureRmProfile
Sets the default profile as '2017-03-09-profile'. After this, BootStrapper cmdlets will automatically use the
default profile if no profile is set. In this case, 'Install-AzureRmProfile' will install profile
'2017-03-09-profile', since this profile was set as the default.
RELATED LINKS
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Set-BootstrapRepo; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Set-BootstrapRepo [[-Repo] <string>] [<CommonParameters>]
ModuleName : AzureRM.BootStrapper
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Set-BootstrapRepo
Category : Function
Component :
Role :
Functionality :
SYNOPSIS
Sets the given profile as a default profile to be used with all API version profile cmdlets.
SYNTAX
Set-AzureRmDefaultProfile [-Profile] {2017-03-09-profile | latest | <others>} [-Force] [-Scope {CurrentUser |
AllUsers}] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Sets the given profile as a default profile to be used with all API version profile cmdlets. Default profile
selection is persisted across sessions and shells.
PARAMETERS
-Force [<SwitchParameter>]
Set the given profile as default without prompting for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Profile <String>
The profile version to set as default. You can get a list of available profile versions using
Get-AzureRmProfile -ListAvailable
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Scope <String>
Specifies the installation scope of the modules. The acceptable values for this parameter are: AllUsers and
CurrentUser. The AllUsers scope lets modules be installed in a location that is accessible to all users of the
computer. The CurrentUser scope lets modules be installed in a location that is available only to the current
user.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
None
NOTES
Example 1 - Using Default Version Profile to Automatically Load Module Versions
PS C:\\> Set-AzureRmDefaultProfile -Profile '2017-03-09-profile'
PS C:\\> Import-Module AzureRM.Compute
Sets profile '2017-03-09-profile' as the default profile. When importing AzureRM modules like AzureRM.Compute,
you will automatically import a version of the module compatible with the default profile setting, unless you
explicitly specify a RequiredVersion.
Example 2 - Using Default Version Profile to Set Default Profile for BootStrapper cmdlets
PS C:\\> Set-AzureRmDefaultProfile -Profile '2017-03-09-profile'
PS c:\\> Install-AzureRmProfile
Sets the default profile as '2017-03-09-profile'. After this, BootStrapper cmdlets will automatically use the
default profile if no profile is set. In this case, 'Install-AzureRmProfile' will install profile
'2017-03-09-profile', since this profile was set as the default.
RELATED LINKS
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Set-BootstrapRepo; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Set-BootstrapRepo [[-Repo] <string>] [<CommonParameters>]
ModuleName : AzureRM.BootStrapper
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Set-BootstrapRepo
Category : Function
Component :
Role :
Functionality :