external help file | Module Name | ms.date | online version | schema |
---|---|---|---|---|
AdminUI.PS.dll-Help.xml |
ConfigurationManager |
11/20/2020 |
2.0.0 |
Create the Azure service for Cloud Management in Configuration Manager.
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>]
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.
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
Specify a Microsoft Entra group name to discover. Use this parameter with the EnableGroupDiscovery parameter.
Type: String[]
Parameter Sets: (All)
Aliases: AddGroupNames
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify whether this service is in the global Azure cloud (AzurePublicCloud
), or the Azure Government cloud (AzureUSGovernmentCloud
).
Type: AzureEnvironment
Parameter Sets: (All)
Aliases:
Accepted values: AzurePublicCloud, AzureUSGovernmentCloud
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify an object for the client app registration. To get this app, use the Get-CMAADApplication cmdlet.
Type: IResultObject
Parameter Sets: (All)
Aliases: ClientApplication, NativeClientApplication
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify an optional description for the service.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Set this parameter to true
to enable delta discovery for Microsoft Entra user discovery. Use this parameter with the EnableUserDiscovery parameter.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a schedule object for the Microsoft Entra group discovery full polling schedule. To get this object, use the New-CMSchedule cmdlet.
Type: IResultObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a name to distinguish the Cloud Management service in Configuration Manager.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify an object for the server app registration. To get this app, use the Get-CMAADApplication cmdlet.
Type: IResultObject
Parameter Sets: (All)
Aliases: WebApp, WebApplication, ServerApplication
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a schedule object for the Microsoft Entra user discovery full polling schedule. To get this object, use the New-CMSchedule cmdlet.
Type: IResultObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.
Add-CMCloudManagementGatewayConnectionPoint