New-SCAzureProfile

Module:

VirtualMachineManager Module

Creates an Azure Profile in Virtual Machine Manager, which can be used to co-manage your VMM managed workloads with Azure.

Syntax

ArmVMManagementProfile (Default)

New-SCAzureProfile
    [-Name] <String>
    -SubscriptionId <String>
    -AzureApplicationID <String>
    -AzureDirectoryID <String>
    -AzureApplicationKey <String>
    [-VMMServer <ServerConnection>]
    [-Description <String>]
    [-Owner <String>]
    [-UserRole <UserRole>]
    [-CloudProvider <AzureCloudProvider>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

UpdateManagementProfile

New-SCAzureProfile
    [-Name] <String>
    -SubscriptionId <String>
    -AutomationAccount <String>
    -AutomationAccountResourceGroup <String>
    -WorkspaceId <String>
    -WorkspaceKey <String>
    [-VMMServer <ServerConnection>]
    [-Description <String>]
    [-Owner <String>]
    [-UserRole <UserRole>]
    [-CloudProvider <AzureCloudProvider>]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

ClassicVMManagementProfile

New-SCAzureProfile
    [-Name] <String>
    -SubscriptionId <String>
    -CertificateThumbprint <String>
    [-VMMServer <ServerConnection>]
    [-Description <String>]
    [-Owner <String>]
    [-UserRole <UserRole>]
    [-CloudProvider <AzureCloudProvider>]
    [-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.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateManagementProfile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-AutomationAccountResourceGroup

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateManagementProfile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-AzureApplicationID

Specifies the ID of the application, whose Identity is used to authenticate to Azure subscription.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ArmVMManagementProfile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-AzureApplicationKey

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ArmVMManagementProfile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-AzureDirectoryID

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ArmVMManagementProfile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ClassicVMManagementProfile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CloudProvider

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

Parameter properties

Type:	AzureCloudProvider
Default value:	None
Accepted values:	AzurePublic, AzureGovernment, AzureChina, AzureGermany
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Description

Specifies a description for the Azure Profile.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-JobVariable

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Specifies the name for the Azure profile object.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OnBehalfOfUser

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	UserRole
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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”

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	Guid
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RunAsynchronously

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SubscriptionId

Specifies the ID of the Azure subscription.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UserRole

Specifies a user role object.

Parameter properties

Type:	UserRole
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VMMServer

Specifies a VMM server object.

Parameter properties

Type:	ServerConnection
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceId

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateManagementProfile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceKey

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateManagementProfile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

This cmdlet returns an AzureProfile object.

Related Links

• Get-SCAzureProfile
• Set-SCAzureProfile
• Remove-SCAzureProfile