Edit

New-CMCloudManagementAzureService

  • Reference
Module:
ConfigurationManager

Create the Azure service for Cloud Management in Configuration Manager.

Syntax

New-CMCloudManagementAzureService
   [-AddGroupName <String[]>]
   [-AzureEnvironmentOption <AzureEnvironment>]
   -ClientApp <IResultObject>
   [-Description <String>]
   [-EnableGroupDeltaDiscovery <Boolean>]
   [-EnableGroupDiscovery <Boolean>]
   [-EnableUserDeltaDiscovery <Boolean>]
   [-EnableUserDiscovery <Boolean>]
   [-GroupDeltaDiscoveryMins <Int32>]
   [-GroupDiscoverySchedule <IResultObject>]
   -Name <String>
   -ServerApp <IResultObject>
   [-UserDeltaDiscoveryMins <Int32>]
   [-UserDiscoverySchedule <IResultObject>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Use this cmdlet to create the Azure service in Configuration Manager for Cloud Management.

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 about the Cloud Management service, see CMG Overview.

Examples

Example 1

This example first gets the previously imported server and client apps using the Get-CMAADApplication cmdlet. It then creates the service in the site for the global Azure cloud.

$serverApp = Get-CMAADApplication -TenantName "Contoso" -AppType ServerApplication -AppName "CmgServerApp"

$clientApp = Get-CMAADApplication -TenantName "Contoso" -AppType ClientApplication -AppName "CmgClientApp"

New-CMCloudManagementAzureService -Name "Contoso" -Description "Azure Service" -ServerApp $serverApp -ClientApp $clientApp -AzureEnvironmentOption AzurePublicCloud

Parameters

-AddGroupName

Specify a Microsoft Entra group name to discover. Use this parameter with the EnableGroupDiscovery parameter.

Type:String[]
Aliases:AddGroupNames
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AzureEnvironmentOption

Specify whether this service is in the global Azure cloud (AzurePublicCloud), or the Azure Government cloud (AzureUSGovernmentCloud).

Type:AzureEnvironment
Accepted values:AzurePublicCloud, AzureUSGovernmentCloud
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ClientApp

Specify an object for the client app registration. To get this app, use the Get-CMAADApplication cmdlet.

Type:IResultObject
Aliases:ClientApplication, NativeClientApplication
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Description

Specify an optional description for the service.

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

-DisableWildcardHandling

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

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

-EnableGroupDeltaDiscovery

Set this parameter to true to enable delta discovery for Microsoft Entra group discovery. Use this parameter with the EnableGroupDiscovery parameter. Use the GroupDeltaDiscoveryMins parameter to configure the delta discovery interval.

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

-EnableGroupDiscovery

Set this parameter to true to enable Microsoft Entra group discovery. When you enable this discovery method, also configure the following parameters:

  • AddGroupName: Add Microsoft Entra groups to discover
  • EnableGroupDeltaDiscovery: Configure delta discovery
  • GroupDeltaDiscoveryMins: Delta discovery interval
  • GroupDiscoverySchedule: Full polling schedule

For more information on this discovery method, see Microsoft Entra user group discovery.

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

-EnableUserDeltaDiscovery

Set this parameter to true to enable delta discovery for Microsoft Entra user discovery. Use this parameter with the EnableUserDiscovery parameter.

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

-EnableUserDiscovery

Set this parameter to true to enable Microsoft Entra user discovery. When you enable this discovery method, also configure the following parameters:

  • EnableUserDeltaDiscovery: Configure delta discovery
  • UserDeltaDiscoveryMins: Delta discovery interval
  • UserDiscoverySchedule: Full polling schedule

For more information on this discovery method, see Microsoft Entra user discovery.

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

-ForceWildcardHandling

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

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

-GroupDeltaDiscoveryMins

When you enable delta discovery for Microsoft Entra group discovery with the EnableGroupDeltaDiscovery parameter, use this parameter to configure the delta discovery interval. The integer value you specify is the polling interval in minutes.

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

-GroupDiscoverySchedule

Specify a schedule object for the Microsoft Entra group discovery full polling schedule. To get this object, use the New-CMSchedule cmdlet.

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

-Name

Specify a name to distinguish the Cloud Management service in Configuration Manager.

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

-ServerApp

Specify an object for the server app registration. To get this app, use the Get-CMAADApplication cmdlet.

Type:IResultObject
Aliases:WebApp, WebApplication, ServerApplication
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-UserDeltaDiscoveryMins

When you enable delta discovery for Microsoft Entra user discovery with the EnableUserDeltaDiscovery parameter, use this parameter to configure the delta discovery interval. The integer value you specify is the polling interval in minutes.

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

-UserDiscoverySchedule

Specify a schedule object for the Microsoft Entra user discovery full polling schedule. To get this object, use the New-CMSchedule cmdlet.

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

-WhatIf

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

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

Inputs

None

Outputs

IResultObject

Notes

You can't enable Microsoft Entra group sync when you create the service. To enable group sync, use the Set-CMCloudManagementAzureService cmdlet with the EnableAADGroupSync parameter.