Set-CMCloudManagementAzureService
Modify the settings of the Azure service for Cloud Management in Configuration Manager.
Syntax
Set-CMCloudManagementAzureService
[-AddGroupName <String[]>]
[-DeleteGroupName <String[]>]
[-Description <String>]
[-EnableAADGroupSync <Boolean>]
[-EnableGroupDeltaDiscovery <Boolean>]
[-EnableGroupDiscovery <Boolean>]
[-EnableUserDeltaDiscovery <Boolean>]
[-EnableUserDiscovery <Boolean>]
[-GroupDeltaDiscoveryMins <Int32>]
[-GroupDiscoverySchedule <IResultObject>]
-InputObject <IResultObject>
[-NewName <String>]
[-PassThru]
[-UserDeltaDiscoveryMins <Int32>]
[-UserDiscoverySchedule <IResultObject>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMCloudManagementAzureService
[-AddGroupName <String[]>]
[-DeleteGroupName <String[]>]
[-Description <String>]
[-EnableAADGroupSync <Boolean>]
[-EnableGroupDeltaDiscovery <Boolean>]
[-EnableGroupDiscovery <Boolean>]
[-EnableUserDeltaDiscovery <Boolean>]
[-EnableUserDiscovery <Boolean>]
[-GroupDeltaDiscoveryMins <Int32>]
[-GroupDiscoverySchedule <IResultObject>]
-Id <Int32>
[-NewName <String>]
[-PassThru]
[-UserDeltaDiscoveryMins <Int32>]
[-UserDiscoverySchedule <IResultObject>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMCloudManagementAzureService
[-AddGroupName <String[]>]
[-DeleteGroupName <String[]>]
[-Description <String>]
[-EnableAADGroupSync <Boolean>]
[-EnableGroupDeltaDiscovery <Boolean>]
[-EnableGroupDiscovery <Boolean>]
[-EnableUserDeltaDiscovery <Boolean>]
[-EnableUserDiscovery <Boolean>]
[-GroupDeltaDiscoveryMins <Int32>]
[-GroupDiscoverySchedule <IResultObject>]
-Name <String>
[-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.
| Type: | String[] |
| Aliases: | AddGroupNames |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-DeleteGroupName
Specify a Microsoft Entra group name to remove from discovery.
| Type: | String[] |
| Aliases: | DeleteGroupNames |
| 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 |
-EnableAADGroupSync
Enable Configuration Manager to sync collections to groups in Microsoft Entra ID. For more information, see Synchronize members to Microsoft Entra groups.
| Type: | Boolean |
| 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 |
-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.
| Type: | Int32 |
| Aliases: | AzureServiceId |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specify an Azure service object to configure. To get this object, use the Get-CMAzureService cmdlet.
| Type: | IResultObject |
| Aliases: | AzureService |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specify a name to distinguish the Cloud Management service in Configuration Manager.
| Type: | String |
| Aliases: | AzureServiceName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NewName
Use this parameter to rename the Cloud Management service in Configuration Manager.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you're working. By default, this cmdlet may not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
System.Object