Edit

Stop-CMCloudDistributionPoint

  • Reference
Module:
ConfigurationManager

Stops the cloud distribution point service.

Syntax

Stop-CMCloudDistributionPoint
    -InputObject <IResultObject>
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-CMCloudDistributionPoint
    -Id <String>
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-CMCloudDistributionPoint
    -Name <String>
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-CMCloudDistributionPoint cmdlet stops the cloud distribution point service.

If you use the Stop-CMCloudDistributionPoint cmdlet, Configuration Manager does not delete content from the distribution point and does not prevent the site server from transferring additional content to the distribution point. While the cloud distribution point service is stopped, the cloud distribution point does not distribute content. Use the Start-CMCloudDistributionPoint cmdlet to restart distribution.

For example, you might want to stop a cloud service when usage reaches a data threshold and then restart it at a later time.

Note

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

Examples

Example 1: Stop the cloud distribution point service using an ID

PS XYZ:\> Stop-CMCloudDistributionPoint -Id "16777242"

This command stops the cloud distribution point service for the cloud distribution point that has the specified identifier.

Example 2: Stop the cloud distribution point service using a name

PS XYZ:\> Stop-CMCloudDistributionPoint -Name "West01"

This command stops the cloud distribution point service for the cloud distribution point named West01.

Example 3: Stop the cloud distribution point service using an object

PS XYZ:\> $DistPnt = Get-CMCloudDistributionPoint -Id "16777242"
PS XYZ:\> Stop-CMCloudDistributionPoint -InputObject $DistPnt

The first command uses the Get-CMCloudDistributionPoint cmdlet to get the distribution point with the specified identifier, and then stores it in the $DistPnt variable.

The second command stops the cloud distribution point service for the distribution point stored in $DistPnt.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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

-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

-Id

Specifies an array of identifiers for cloud distribution points. You can use a comma separated list.

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

-InputObject

Specifies a cloud distribution point object. To get a cloud distribution point object, you can use the Get-CMCloudDistributionPoint cmdlet.

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

-Name

Specifies the name of a cloud distribution point.

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

-WhatIf

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

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object