Edit

Share via

Set-CMCloudManagementAzureService

Module:
ConfigurationManager Module

Modify the settings of the Azure service for Cloud Management in Configuration Manager.

Syntax

SearchByValueMandatory (Default) 

Set-CMCloudManagementAzureService
    -InputObject <IResultObject>
    [-AddGroupName <String[]>]
    [-DeleteGroupName <String[]>]
    [-Description <String>]
    [-EnableAADGroupSync <Boolean>]
    [-EnableGroupDeltaDiscovery <Boolean>]
    [-EnableGroupDiscovery <Boolean>]
    [-EnableUserDeltaDiscovery <Boolean>]
    [-EnableUserDiscovery <Boolean>]
    [-GroupDeltaDiscoveryMins <Int32>]
    [-GroupDiscoverySchedule <IResultObject>]
    [-NewName <String>]
    [-PassThru]
    [-UserDeltaDiscoveryMins <Int32>]
    [-UserDiscoverySchedule <IResultObject>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory 

Set-CMCloudManagementAzureService
    -Id <Int32>
    [-AddGroupName <String[]>]
    [-DeleteGroupName <String[]>]
    [-Description <String>]
    [-EnableAADGroupSync <Boolean>]
    [-EnableGroupDeltaDiscovery <Boolean>]
    [-EnableGroupDiscovery <Boolean>]
    [-EnableUserDeltaDiscovery <Boolean>]
    [-EnableUserDiscovery <Boolean>]
    [-GroupDeltaDiscoveryMins <Int32>]
    [-GroupDiscoverySchedule <IResultObject>]
    [-NewName <String>]
    [-PassThru]
    [-UserDeltaDiscoveryMins <Int32>]
    [-UserDiscoverySchedule <IResultObject>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByNameMandatory 

Set-CMCloudManagementAzureService
    -Name <String>
    [-AddGroupName <String[]>]
    [-DeleteGroupName <String[]>]
    [-Description <String>]
    [-EnableAADGroupSync <Boolean>]
    [-EnableGroupDeltaDiscovery <Boolean>]
    [-EnableGroupDiscovery <Boolean>]
    [-EnableUserDeltaDiscovery <Boolean>]
    [-EnableUserDiscovery <Boolean>]
    [-GroupDeltaDiscoveryMins <Int32>]
    [-GroupDiscoverySchedule <IResultObject>]
    [-NewName <String>]
    [-PassThru]
    [-UserDeltaDiscoveryMins <Int32>]
    [-UserDiscoverySchedule <IResultObject>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to modify the settings of an Azure service in Configuration Manager for Cloud Management.

For more information about the Cloud Management service, see CMG Overview.

Examples

Example 1

This example first uses the Get-CMAzureService cmdlet to get the service from the site. It then passes that object with the pipeline operator to Set-CMCloudManagementAzureService, which renames it and sets the description.

Get-CMAzureService -Name "Contoso" | Set-CMCloudManagementAzureService -NewName "CMG service" -Description "ConfigMgr connection to Contoso tenant for CMG"

Parameters

-AddGroupName

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:AddGroupNames

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

-DeleteGroupName

Specify a Microsoft Entra group name to remove from discovery.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:DeleteGroupNames

Parameter sets

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

-Description

Specify an optional description for the service.

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

-EnableAADGroupSync

Enable Configuration Manager to sync collections to groups in Microsoft Entra ID. For more information, see Synchronize members to Microsoft Entra groups.

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

-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.

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

-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.

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

-EnableUserDeltaDiscovery

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

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

-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.

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

-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

-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.

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

-GroupDiscoverySchedule

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

Parameter properties

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

-Id

Specify the site's ID for the Azure service. The Id is the integer value stored in the site database for the service. For example, run the following SQL query, and look at the ID column: select * from Azure_CloudService.

Parameter properties

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

Parameter sets

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

-InputObject

Specify an Azure service object to configure. To get this object, use the Get-CMAzureService cmdlet.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureService

Parameter sets

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

-Name

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

Parameter properties

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

Parameter sets

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

-NewName

Use this parameter to rename the Cloud Management service in Configuration Manager.

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

-PassThru

Returns an object representing the item with which you're working. By default, this cmdlet may not generate any output.

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

-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.

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

-UserDiscoverySchedule

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

Parameter properties

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

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object