Edit

Share via

New-CMCloudManagementGateway

Module:
ConfigurationManager Module

Create a cloud management gateway.

Syntax

Interactive 

New-CMCloudManagementGateway
    -ServiceCertPassword <SecureString>
    -ServiceCertPath <String>
    [-CARootCert <Hashtable>]
    [-CheckClientCertRevocation <Boolean>]
    [-Description <String>]
    [-EnableCloudDPFunction <Boolean>]
    [-EnableStorageQuota <Boolean>]
    [-EnableTrafficOut <Boolean>]
    [-EnforceProtocol <Boolean>]
    [-EnvironmentSetting <AzureEnvironment>]
    [-Force]
    [-GroupName <String>]
    [-IsUsingExistingGroup <Boolean>]
    [-Region <AzureRegion>]
    [-ServiceName <String>]
    [-StorageCriticalPct <Int32>]
    [-StorageQuotaGB <Int32>]
    [-StorageWarningPct <Int32>]
    [-SubscriptionId <String>]
    [-TrafficCriticalPct <Int32>]
    [-TrafficOutGB <Int32>]
    [-TrafficOutStopService <Boolean>]
    [-TrafficWarningPct <Int32>]
    [-VMInstanceCount <Int32>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Non-Interactive 

New-CMCloudManagementGateway
    -GroupName <String>
    -ServerAppClientId <String>
    -ServiceCertPassword <SecureString>
    -ServiceCertPath <String>
    -SubscriptionId <String>
    [-CARootCert <Hashtable>]
    [-CheckClientCertRevocation <Boolean>]
    [-Description <String>]
    [-EnableCloudDPFunction <Boolean>]
    [-EnableStorageQuota <Boolean>]
    [-EnableTrafficOut <Boolean>]
    [-EnforceProtocol <Boolean>]
    [-EnvironmentSetting <AzureEnvironment>]
    [-Force]
    [-Region <AzureRegion>]
    [-ServiceName <String>]
    [-StorageCriticalPct <Int32>]
    [-StorageQuotaGB <Int32>]
    [-StorageWarningPct <Int32>]
    [-TrafficCriticalPct <Int32>]
    [-TrafficOutGB <Int32>]
    [-TrafficOutStopService <Boolean>]
    [-TrafficWarningPct <Int32>]
    [-VMInstanceCount <Int32>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to create a cloud management gateway (CMG) service in Azure. For more information on how to use this cmdlet to create a cloud management gateway (CMG), see 2010 release notes: Cloud management gateway.

For more information, see CMG Overview.

Starting in version 2010, the following parameters were removed from this cmdlet:

  • GovernmentSubscription
  • ManagementCertificatePassword
  • ManagementCertificatePath
  • PassThru
  • RootCertificatePath
  • ServiceCertificatePassword
  • ServiceCertificatePath
  • ServiceCName

For more information on the other changes to this cmdlet in version 2010, see 2010 release notes.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1

$Path = "c:\TestPath\RootCA.cer"
$Type = [Microsoft.ConfigurationManagement.AdminConsole.AzureServices.CertificateStore]::RootCA
$Cert =@{$Path = $Type}

$Password = '0HNy*c@63kAe' | ConvertTo-SecureString -AsPlainText -Force

New-CMCloudManagementGateway -ServiceCertPath "c:\TestPath\ServiceCert.pfx" -EnvironmentSetting AzurePublicCloud -SubscriptionId "e517b8cb-a969-4d1e-b2ea-ae1e6c052020" -ServiceCertPassword $Password -ServiceName "GraniteFalls.CloudApp.Net" -Description "EastUS CMG for Contoso" -Region EastUS -VMInstanceCount 2 -CARootCert $Cert -CheckClientCertRevocation $False -EnforceProtocol $True -IsUsingExistingGroup $true -GroupName "Resource group 1"

Example 2

New-CMCloudManagementGateway -ServiceCertPath "c:\TestPath\ServiceCert.pfx" -EnvironmentSetting AzurePublicCloud -SubscriptionId "e517b8cb-a969-4d1e-b2ea-ae1e6c052020" -ServiceCertPassword $Password -ServiceName "GraniteFalls.CloudApp.Net" -Description "EastUS CMG for Contoso" -Region EastUS -VMInstanceCount 2 -CARootCert $Cert -CheckClientCertRevocation $False -EnforceProtocol $True -GroupName "Resource group 1" -EnableCloudDPFunction $true -EnableTrafficOut $true -TrafficOutStopService $true -TrafficOutGB 10000 -TrafficWarningPct 50 -TrafficCriticalPct 90 -EnableStorageQuota $true -StorageQuotaGB 2000 -StorageWarningPct 50 -StorageCriticalPct 90 -Force

Parameters

-CARootCert

Applies to version 2010 and later. Add root certificates to the cloud service.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CARootCertification, CARootCertifications

Parameter sets

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

-CheckClientCertRevocation

Set this parameter to true to verify client certificate revocation. A certificate revocation list (CRL) must be publicly published for this verification to work. For more information, see Publish the certificate revocation list.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:VerifyClientCertificateRevocation

Parameter sets

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

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

Parameter sets

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

-Description

An optional description of the CMG, to better identify it in the Configuration Manager console.

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

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-EnableCloudDPFunction

Applies to version 2010 and later. Enable or disable the option to Allow CMG to function as a cloud distribution point and serve content from Azure storage.

Parameter properties

Type:Boolean
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

-EnableStorageQuota

Applies to version 2010 and later. Enable or disable the option to Specify storage alert threshold.

Parameter properties

Type:Boolean
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

-EnableTrafficOut

Applies to version 2010 and later. Enable or disable the option to Turn on 14-day threshold and alerts for monitoring outbound data transfer.

Parameter properties

Type:Boolean
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

-EnforceProtocol

Applies to version 2010 and later. Enable or disable the option to Enforce TLS 1.2.

Parameter properties

Type:Boolean
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

-EnvironmentSetting

Specify Azure environment to deploy the CMG: in the global Azure cloud (AzurePublicCloud) or the Azure Government cloud (AzureUSGovernmentCloud).

Parameter properties

Type:AzureEnvironment
Default value:None
Accepted values:AzurePublicCloud, AzureUSGovernmentCloud
Supports wildcards:False
DontShow:False
Aliases:AzureEnvironmentOption

Parameter sets

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

-Force

Applies to version 2010 and later. Run the command without asking for confirmation. If the service certificate contains multiple DNS names, use this parameter to avoid warnings from the cmdlet.

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

-GroupName

Applies to version 2010 and later. Specify the name of the Azure resource group.

Parameter properties

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

Parameter sets

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

-IsUsingExistingGroup

Applies to version 2010 and later. Specify if the Azure resource group already exists.

Parameter properties

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

Parameter sets

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

-Region

Specify the Azure service region, for example: WestUS2.

Parameter properties

Type:AzureRegion
Default value:None
Accepted values:EastUS, SouthCentralUS, WestEurope, SoutheastAsia, WestUS2, WestCentralUS
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

-ServerAppClientId

Applies to version 2010 and later. Specify the client ID of the Microsoft Entra server app. Use this parameter for non-user interaction mode. In the CMG properties, this value is the Microsoft Entra app name.

Parameter properties

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

Parameter sets

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

-ServiceCertPassword

Applies to version 2010 and later. Specify the password for the service certificate.

Parameter properties

Type:SecureString
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ServiceCertificatePassword

Parameter sets

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

-ServiceCertPath

Applies to version 2010 and later. Specify the path to the service certificate. For more information, see CMG server authentication certificate.

Parameter properties

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

Parameter sets

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

-ServiceName

Applies to version 2010 and later. Specify the Azure service name. If you don't specify this parameter, Configuration Manager uses the service certificate's first DNS name. If the certificate has more than one DNS name, use this parameter to specify which one to use.

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

-StorageCriticalPct

Applies to version 2010 and later. Specify an integer value for the Generate Critical alert (% of storage alert threshold). For example, 90.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:StorageCriticalPercent

Parameter sets

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

-StorageQuotaGB

Applies to version 2010 and later. Specify an integer value for the Storage alert threshold (GB). For example, 2.

Parameter properties

Type:Int32
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

-StorageWarningPct

Applies to version 2010 and later. Specify an integer value for the Generate Warning alert (% of storage alert threshold). For example, 50.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:StorageWarningPercent

Parameter sets

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

-SubscriptionId

Specify the ID of the Azure subscription where you want to deploy this new cloud service. The format of this value is a standard GUID.

Parameter properties

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

Parameter sets

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

-TenantId

Mandatory parameter where tenantId needs to be added while creating cmg.

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

-TrafficCriticalPct

If you enable alerts for monitoring outbound data transfer, specify the percentage of threshold for raising a Critical alert. This value is 90 by default.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:TrafficCriticalPercent

Parameter sets

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

-TrafficOutGB

If you enable storage alerts, use this parameter to specify the storage alert threshold in GB. The default value is 2.

Parameter properties

Type:Int32
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

-TrafficOutStopService

Applies to version 2010 and later. Enable or disable the option to Stop this service when the critical threshold is exceeded.

Parameter properties

Type:Boolean
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

-TrafficWarningPct

If you enable alerts for monitoring outbound data transfer, specify the percentage of threshold for raising a Warning alert. This value is 50 by default.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:TrafficWarningPercent

Parameter sets

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

-VMInstanceCount

Specify the instance count of virtual machines for the CMG in Azure.

Parameter properties

Type:Int32
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet isn't run.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
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.

Inputs

None

Outputs

IResultObject