Update-AzIoTDeviceProvisioningService

Reference

Module:: Az.DeviceProvisioningServices

Update an Azure IoT Hub device provisioning service.

Syntax

Update-AzIoTDeviceProvisioningService
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-Tag] <Hashtable>
      [-Reset]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzIoTDeviceProvisioningService
      [-InputObject] <PSProvisioningServiceDescription>
      [-Tag] <Hashtable>
      [-Reset]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzIoTDeviceProvisioningService
      [-InputObject] <PSProvisioningServiceDescription>
      [-AllocationPolicy] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzIoTDeviceProvisioningService
      [-ResourceId] <String>
      [-Tag] <Hashtable>
      [-Reset]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzIoTDeviceProvisioningService
      [-ResourceId] <String>
      [-AllocationPolicy] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzIoTDeviceProvisioningService
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-AllocationPolicy] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

For an introduction to Azure IoT Hub Device Provisioning Service, see https://learn.microsoft.com/azure/iot-dps/about-iot-dps.

Examples

Example 1

Update-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -AllocationPolicy "GeoLatency"

ResourceGroupName			: myresourcegroup
Name						: myiotdps
Type						: Microsoft.Devices/provisioningServices
ServiceOperationsHostName	: myiotdps.azure-devices-provisioning.net
IotHubs						: 0
State						: Active
AllocationPolicy			: GeoLatency
Tags						: {}
SkuName						: S1
SkuTier						: Standard
Etag						: AAAAAAAT52k=

Update Allocation Policy to "GeoLatency" of an Azure IoT Hub device provisioning service "myiotdps".

Example 2

$tag = @{}
$tag.Add("key1","Value1")
Update-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Tag $tag

ResourceGroupName			: myresourcegroup
Name						: myiotdps
Type						: Microsoft.Devices/provisioningServices
ServiceOperationsHostName	: myiotdps.azure-devices-provisioning.net
IotHubs						: 0
State						: Active
AllocationPolicy			: Hashed
Tags						: {['key1','Value1']}
SkuName						: S1
SkuTier						: Standard
Etag						: AAAAAAAPoOk=

Add tags to an Azure IoT Hub device provisioning service "myiotdps".

Example 3

$tag = @{}
$tag.Add("key1","Value1")
Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Update-AzIoTDeviceProvisioningService -Tag $tag -Reset

ResourceGroupName			: myresourcegroup
Name						: myiotdps
Type						: Microsoft.Devices/provisioningServices
ServiceOperationsHostName	: myiotdps.azure-devices-provisioning.net
IotHubs						: 0
State						: Active
AllocationPolicy			: Hashed
Tags						: {['key1','Value1']}
SkuName						: S1
SkuTier						: Standard
Etag						: AAAAAAAS1dY=

Delete Tag and add new tags to an Azure IoT Hub device provisioning service "myiotdps" using pipeline.

Parameters

-AllocationPolicy

IoT Device Provisioning Service Allocation policy

Type:	String
Accepted values:	Hashed, GeoLatency, Static
Position:	1
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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

IoT Device Provisioning Service Object

Type:	PSProvisioningServiceDescription
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Name of the IoT Device Provisioning Service

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

-Reset

Reset IoT Device Provisioning Service Tags

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

-ResourceGroupName

Name of the Resource Group

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

-ResourceId

IoT Device Provisioning Service Resource Id

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

-Tag

IoT Device Provisioning Service Tag collection

Type:	Hashtable
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

PSProvisioningServiceDescription

String

Outputs