Get-AzIoTDeviceProvisioningService
This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.
List all or show details of Azure IoT Hub device provisioning services.
Syntax
ListIotDpsByResourceGroup (Default)
Get-AzIoTDeviceProvisioningService
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetIotDpsByName
Get-AzIoTDeviceProvisioningService
[-Name] <String>
-ResourceGroupName <String>
[-DefaultProfile <IAzureContextContainer>]
[<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
Get-AzIoTDeviceProvisioningService
ResourceGroupName Name Location ServiceOperationsHostName IotHubs AllocationPolicy Tags State
----------------- ---- -------- ------------------------- ------- ---------------- ---- -----
myresourcegroup0 myiotdps0 eastus myiotdps0.azure-devices-provisioning.net 0 Static 0 Active
myresourcegroup1 myiotdps1 eastus myiotdps1.azure-devices-provisioning.net 4 Hashed 0 Active
myresourcegroup1 myiotdps2 westus myiotdps2.azure-devices-provisioning.net 4 GeoLatency 0 Active
List all Azure IoT Hub device provisioning services in a subscription.
Example 2
Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup"
ResourceGroupName Name Location ServiceOperationsHostName IotHubs AllocationPolicy Tags State
----------------- ---- -------- ------------------------- ------- ---------------- ---- -----
myresourcegroup myiotdps1 eastus myiotdps1.azure-devices-provisioning.net 1 Hashed 0 Active
myresourcegroup myiotdps2 westus myiotdps2.azure-devices-provisioning.net 4 GeoLatency 0 Active
List all Azure IoT Hub device provisioning services in the resource group 'myresourcegroup'.
Example 3
Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps"
ResourceGroupName : myresourcegroup
Name : myiotdps
Location : eastus
Type : Microsoft.Devices/provisioningServices
ServiceOperationsHostName : myiotdps.azure-devices-provisioning.net
IotHubs : 0
State : Active
AllocationPolicy : Hashed
Tags : {}
SkuName : S1
SkuTier : Standard
Etag : AAAAAAAT52k=
Show details of an Azure IoT Hub device provisioning service 'myiotdps'.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Name of the IoT Device Provisioning Service
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetIotDpsByName
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
Name of the Resource Group
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ListIotDpsByResourceGroup
| 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.
