New-SCAzureProfile
Creates an Azure Profile in Virtual Machine Manager, which can be used to co-manage your VMM managed workloads with Azure.
Syntax
New-SCAzureProfile
[-VMMServer <ServerConnection>]
[-Name] <String>
[-Description <String>]
[-Owner <String>]
[-UserRole <UserRole>]
-SubscriptionId <String>
[-CloudProvider <AzureCloudProvider>]
-AzureApplicationID <String>
-AzureDirectoryID <String>
-AzureApplicationKey <String>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>] New-SCAzureProfile
[-VMMServer <ServerConnection>]
[-Name] <String>
[-Description <String>]
[-Owner <String>]
[-UserRole <UserRole>]
-SubscriptionId <String>
[-CloudProvider <AzureCloudProvider>]
-AutomationAccount <String>
-AutomationAccountResourceGroup <String>
-WorkspaceId <String>
-WorkspaceKey <String>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>] New-SCAzureProfile
[-VMMServer <ServerConnection>]
[-Name] <String>
[-Description <String>]
[-Owner <String>]
[-UserRole <UserRole>]
-SubscriptionId <String>
[-CloudProvider <AzureCloudProvider>]
-CertificateThumbprint <String>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>] Description
The New-SCAzureProfile commandlet creates an Azure Profile in VMM Library, which is used to Co-Manage workloads with Azure. Azure Profile provides VMM customers multiple Azure Co-Management options. Ex: Azure VM Management, Azure Update Management etc.
For more information about Azure Co-Management capabilities in VMM, see Add an Azure Subscription in VMM.
Examples
Example 1
PS C:> New-SCAzureProfile -Name <VMMgmtAzProfile> -SubscriptionId <AzSubID> -CloudProvider “AzurePublic" -AzureApplicationID <AzAppID> -AzureApplicationKey <AzAppKey> -AzureDirectoryID <AzDirectoryID>Creates an Azure Profile to manage Azure VMs.
Example 2
PS C:> New-SCAzureProfile -Name <VMUpdateAzProfile> -SubscriptionId <AzSubID> -AutomationAccount <AzAutoAcct> -AutomationAccountResourceGroup <AzRG> -WorkspaceId <LogAnalyticsWorkspaceID> -WorkspaceKey <LogAnalyticsWorkspaceKey>Creates an Azure Profile to manage updates for VMs using Azure Update Management service.
Example 3
PS C:> New-SCAzureProfile -Name “VMMgmtAzProfile” -SubscriptionId “AzSubID” -CertificateThumbprint “AzMgmtCertThumbprint”Creates an Azure Profile to manage Azure VMs, which uses management certificate to authenticate to Azure.
Note
If Management certificate is used to authenticate to Azure, you can manage only classic Azure VMs using this Azure profile.
Parameters
-AutomationAccount
Specifies the name of the Azure automation account that should be used for updating VMs managed by VMM.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AzureApplicationID
Specifies the ID of the application, whose Identity is used to authenticate to Azure subscription.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AzureApplicationKey
Specifies the authentication key for the application used to authenticate to Azure subscription.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| 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.
Note
Management certificate based authentication allows you to manage only Classic VMs.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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.
| 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.
| 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name for the Azure profile object.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| 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.
| 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.
| 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. 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.
| 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.
| 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserRole
Specifies a user role object.
| Type: | UserRole |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMMServer
Specifies a VMM server object.
| 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WorkspaceKey
Specifies the Workspace Key (primary or secondary) of the Log Analytics workspace.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Notes
This cmdlet returns an AzureProfile object.