Share via

Set-SCAzureProfile

  • Reference
Module:
VirtualMachineManager

Modifies the properties of an Azure profile in VMM.

Syntax

Set-SCAzureProfile
   [-VMMServer <ServerConnection>]
   [-AzureProfile] <AzureProfile>
   [-Name <String>]
   [-Description <String>]
   [-Owner <String>]
   [-UserRole <UserRole>]
   [-SubscriptionId <String>]
   [-CloudProvider <AzureCloudProvider>]
   [-AzureApplicationID <String>]
   [-AzureDirectoryID <String>]
   [-AzureApplicationKey <String>]
   [-CertificateThumbprint <String>]
   [-AutomationAccount <String>]
   [-AutomationAccountResourceGroup <String>]
   [-WorkspaceId <String>]
   [-WorkspaceKey <String>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Set-SCAzureProfile cmdlet modifies the properties of an azure profile created in VMM. To get an azure profile object, use the Get-SCAzureProfile cmdlet. For more information about azure profiles, type Get-Help New-SCAzureProfile -Detailed.

Examples

Example 1

PS C:> $azUpdateMgmtProfile = Get-SCAzureProfile | Where-Object {$_.Name -eq 'AzUpdateMgmtProfile'}
PS C:\> Set-SCAzureProfile -AzureProfile $azUpdateMgmtProfile -WorkspaceKey 'u6t5H1xh1aze28Rw03UtIG/vDkkCxAs9eWO2rYoGMz3RgWr98o6Xwtn/KZL1OaoQbihvnCIeGh6Qye4N6HrD+w=='

Update the log analytics workspace key on an existing Azure update management profile.

Example 2

PS C:\> $azUpdateMgmtProfile = Get-SCAzureProfile | Where-Object {$_.Name -eq 'AzUpdateMgmtProfile'}
PS C:\> Set-SCAzureProfile -AzureProfile $azUpdateMgmtProfile -Name azUpdateMgmtProfileNewName

Update the name on an existing Azure upate management profile.

Parameters

-AutomationAccount

Specifies the name of the Azure automation account to be used for updating VMs managed by VMM. Optional Parameter.

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

-AutomationAccountResourceGroup

Specifies the Azure Resource Group that holds the Azure automation account used to update VMs managed by VMM. Optional parameter.

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

-AzureApplicationID

Specifies the ID of the Application whose Identity is used to authenticate to Azure subscription. Optional parameter.

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

-AzureApplicationKey

Specifies the authentication key for the application used to authenticate to Azure subscription. Optional parameter.

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

-AzureDirectoryID

Specifies the ID of the Azure Active Directory tenant, which holds the identity used to authenticate to Azure subscription. Optional parameter.

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

-AzureProfile

Specifies an azure profile object. To get an azure profile object, use the Get-SCAzureProfile cmdlet.

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

-CertificateThumbprint

Specifies the thumbprint of the management certificate. The private key of the management certificate must be in the personal certificate store and the public key must be uploaded to Azure. Optional parameter.

Management certificate based authentication allows you to manage only Classic VMs.

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

-CloudProvider

Specifies the Azure cloud provider to use. This can be the Azure Public or one of the Azure Sovereign regions. Optional parameter.

Type:AzureCloudProvider
Accepted values:AzurePublic, AzureGovernment, AzureChina, AzureGermany
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for the Azure Profile. Optional parameter.

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

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter. Optional parameter.

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

-Name

Specifies the Name of the Azure Profile. Optional parameter.

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

-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies. Optional parameter.

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

-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies. Optional parameter.

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

-Owner

Specifies the owner of the Azure Profile in the form of a valid domain user account. Optional parameter. Example format:

  • -Owner “Contoso\DomainUser”
  • -Owner “Domainuser@Contoso.com”
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this account. This parameter lets you audit PRO tips. Optional parameter.

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

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately. Optional parameter. Optional parameter.

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

-SubscriptionId

Specifies the ID of the Azure Subscription. Optional parameter.

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

-UserRole

Specifies a user role object. Optional parameter.

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

-VMMServer

Specifies a VMM server object. Optional parameter.

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

-WorkspaceId

Specifies the Workspace ID of the Log Analytics workspace where the log data will be stored. Optional parameter.

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

-WorkspaceKey

Specifies the Workspace Key (primary or secondary) of the Log Analytics workspace. Optional parameter.

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

Notes

This cmdlet returns an AzureProfile object.