From 3ff3183ce7da3c2c02f4bb751859a848066363ca Mon Sep 17 00:00:00 2001 From: Yufan Yang <95342181+CaptainFanZzz@users.noreply.github.com> Date: Tue, 1 Mar 2022 14:15:21 +0800 Subject: [PATCH] Split Az.DeviceProvisioningServices Examples (#17094) --- ...oTDeviceProvisioningServiceAccessPolicy.md | 10 ++++++--- ...IoTDeviceProvisioningServiceCertificate.md | 10 ++++++--- ...zIoTDeviceProvisioningServiceEnrollment.md | 18 +++++++-------- ...eviceProvisioningServiceEnrollmentGroup.md | 16 +++++++------- ...AzIoTDeviceProvisioningServiceLinkedHub.md | 10 ++++++--- .../Get-AzIoTDeviceProvisioningService.md | 14 ++++++++---- ...oTDeviceProvisioningServiceAccessPolicy.md | 10 ++++++--- ...IoTDeviceProvisioningServiceCertificate.md | 10 ++++++--- ...zIoTDeviceProvisioningServiceEnrollment.md | 6 ++--- ...eviceProvisioningServiceEnrollmentGroup.md | 6 ++--- ...AzIoTDeviceProvisioningServiceLinkedHub.md | 10 ++++++--- ...oTDeviceProvisioningServiceRegistration.md | 6 ++--- .../New-AzIoTDeviceProvisioningService.md | 14 +++++++----- ...oningServiceCertificateVerificationCode.md | 10 ++++++--- .../Remove-AzIoTDeviceProvisioningService.md | 10 +++++---- ...oTDeviceProvisioningServiceAccessPolicy.md | 10 +++++---- ...IoTDeviceProvisioningServiceCertificate.md | 6 +++-- ...zIoTDeviceProvisioningServiceEnrollment.md | 6 ++--- ...eviceProvisioningServiceEnrollmentGroup.md | 6 ++--- ...AzIoTDeviceProvisioningServiceLinkedHub.md | 10 +++++---- ...oTDeviceProvisioningServiceRegistration.md | 4 ++-- ...IoTDeviceProvisioningServiceCertificate.md | 10 ++++++--- ...zIoTDeviceProvisioningServiceEnrollment.md | 14 ++++++------ ...eviceProvisioningServiceEnrollmentGroup.md | 14 ++++++------ .../Update-AzIoTDeviceProvisioningService.md | 22 ++++++++++++------- ...oTDeviceProvisioningServiceAccessPolicy.md | 12 ++++++---- ...AzIoTDeviceProvisioningServiceLinkedHub.md | 6 +++-- 27 files changed, 171 insertions(+), 109 deletions(-) diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceAccessPolicy.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceAccessPolicy.md index 72b3b7fd4dd8..b131a1b78e93 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceAccessPolicy.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceAccessPolicy.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/add-aziotdeviceprovisioningserviceaccesspolicy @@ -38,9 +38,11 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +Add-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -Permissions "ServiceConfig, EnrollmentWrite" ``` -PS C:\> Add-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -Permissions "ServiceConfig, EnrollmentWrite" +```output ResourceGroupName : myresourcegroup Name : myiotdps KeyName : mypolicy @@ -52,9 +54,11 @@ Rights : ServiceConfig, EnrollmentWrite Add a new shared access policy in an Azure IoT Hub device provisioning service with EnrollmentWrite and ServiceConfig rights. ### Example 2 +```powershell +Add-AzIoTDpsAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy2" -Permissions "EnrollmentRead" ``` -PS C:\> Add-AzIoTDpsAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy2" -Permissions "EnrollmentRead" +```output KeyName Rights ------- ------ mypolicy1 ServiceConfig, EnrollmentWrite diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceCertificate.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceCertificate.md index b5a9b72a8361..226a42240264 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceCertificate.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceCertificate.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/add-aziotdeviceprovisioningservicecertificate @@ -40,9 +40,11 @@ For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioni ## EXAMPLES ### Example 1 +```powershell +Add-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" ``` -PS C:\> Add-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" +```output Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate ResourceGroupName : myresourcegroup Name : myiotdps @@ -58,9 +60,11 @@ Etag : AAAAAAFpGcA= Upload a CA certificate CER file to an Azure IoT Hub device provisioning service. ### Example 2 +```powershell +Add-AzIoTDpsCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" -Etag "AAAAAAFpGcA=" ``` -PS C:\> Add-AzIoTDpsCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" -Etag "AAAAAAFpGcA=" +```output Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiothub/certificates/mycertificate ResourceGroupName : myresourcegroup Name : myiotdps diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollment.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollment.md index ca83ea7d47e3..45c3cc055fef 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollment.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollment.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/add-aziotdeviceprovisioningserviceenrollment @@ -55,32 +55,32 @@ Create a device enrollment in an Azure IoT Hub Device Provisioning Service. ### Example 1 ```powershell -PS C:\> Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType SymmetricKey +Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType SymmetricKey ``` Create an enrollment with attestation type SymmetricKey ### Example 2 ```powershell -PS C:\> Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType Tpm -EndorsementKey "endorementkey" +Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType Tpm -EndorsementKey "endorementkey" ``` Create an enrollment with TPM attestation. ### Example 3 ```powershell -PS C:\> Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType X509 -PrimaryCertificate "D:/primary.cer" +Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType X509 -PrimaryCertificate "D:/primary.cer" ``` Create an enrollment with attestation type X509 ### Example 4 ```powershell -PS C:\> $tag = @{} -PS C:\> $tag.Add("environment","test") -PS C:\> $desired = @{} -PS C:\> $desired.add("version_dps", "dps1") -PS C:\> Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType SymmetricKey -tag $tag -Desired $desired +$tag = @{} +$tag.Add("environment","test") +$desired = @{} +$desired.add("version_dps", "dps1") +Add-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AttestationType SymmetricKey -tag $tag -Desired $desired ``` Create an enrollment with attestation type SymmetricKey and initial twin state. diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollmentGroup.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollmentGroup.md index 01eb1c83d289..e8cddb1281ec 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceEnrollmentGroup.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/add-aziotdeviceprovisioningserviceenrollmentgroup @@ -52,25 +52,25 @@ Create an enrollment group in an Azure IoT Hub Device Provisioning Service. ### Example 1 ```powershell -PS C:\> Add-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AttestationType SymmetricKey +Add-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AttestationType SymmetricKey ``` Create an enrollment with attestation type SymmetricKey ### Example 2 ```powershell -PS C:\> Add-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AttestationType X509 -PrimaryCertificate "D:/primary.cer" +Add-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AttestationType X509 -PrimaryCertificate "D:/primary.cer" ``` Create an enrollment with attestation type X509 ### Example 3 ```powershell -PS C:\> $tag = @{} -PS C:\> $tag.Add("environment","test") -PS C:\> $desired = @{} -PS C:\> $desired.add("version_dps", "dps1") -PS C:\> Add-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AttestationType SymmetricKey -tag $tag -Desired $desired +$tag = @{} +$tag.Add("environment","test") +$desired = @{} +$desired.add("version_dps", "dps1") +Add-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AttestationType SymmetricKey -tag $tag -Desired $desired ``` Create an enrollment with attestation type SymmetricKey and initial twin state. diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceLinkedHub.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceLinkedHub.md index 11566961f55a..04f7ecb69a2b 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceLinkedHub.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Add-AzIoTDeviceProvisioningServiceLinkedHub.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/add-aziotdeviceprovisioningservicelinkedhub @@ -39,9 +39,11 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +Add-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -IotHubConnectionString $hubConnectionString -IotHubLocation "eastus" ``` -PS C:\> Add-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -IotHubConnectionString $hubConnectionString -IotHubLocation "eastus" +```output ResourceGroupName : myresourcegroup Name : myiotdps LinkedHubName : myiothub.azure-devices.net @@ -54,9 +56,11 @@ Location : eastus Linked IoT hub to an Azure IoT Hub device provisioning service. ### Example 2 +```powershell +Add-AzIoTDpsHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -IotHubConnectionString $hubConnectionString -IotHubLocation "eastus" -AllocationWeight 10 -ApplyAllocationPolicy $false ``` -PS C:\> Add-AzIoTDpsHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -IotHubConnectionString $hubConnectionString -IotHubLocation "eastus" -AllocationWeight 10 -ApplyAllocationPolicy $false +```output LinkedHubName Location AllocationWeight ApplyAllocationPolicy ------------- -------- ---------------- --------------------- myiothub1.azure-devices.net eastus 2 true diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningService.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningService.md index 107c4d76d434..56b0d1729925 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningService.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningService.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningservice @@ -30,9 +30,11 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +Get-AzIoTDeviceProvisioningService ``` -PS C:\> Get-AzIoTDeviceProvisioningService +```output ResourceGroupName Name Location ServiceOperationsHostName IotHubs AllocationPolicy Tags State ----------------- ---- -------- ------------------------- ------- ---------------- ---- ----- myresourcegroup0 myiotdps0 eastus myiotdps0.azure-devices-provisioning.net 0 Static 0 Active @@ -43,9 +45,11 @@ myresourcegroup1 myiotdps2 westus myiotdps2.azure-devices-provisioning.net 4 List all Azure IoT Hub device provisioning services in a subscription. ### Example 2 +```powershell +Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" ``` -PS C:\> Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" +```output ResourceGroupName Name Location ServiceOperationsHostName IotHubs AllocationPolicy Tags State ----------------- ---- -------- ------------------------- ------- ---------------- ---- ----- myresourcegroup myiotdps1 eastus myiotdps1.azure-devices-provisioning.net 1 Hashed 0 Active @@ -55,9 +59,11 @@ myresourcegroup myiotdps2 westus myiotdps2.azure-devices-provisioning.net 4 List all Azure IoT Hub device provisioning services in the resource group 'myresourcegroup'. ### Example 3 +```powershell +Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" ``` -PS C:\> Get-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" +```output ResourceGroupName : myresourcegroup Name : myiotdps Location : eastus diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceAccessPolicy.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceAccessPolicy.md index aa082daf3931..2b21f85c9adc 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceAccessPolicy.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceAccessPolicy.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningserviceaccesspolicy @@ -36,9 +36,11 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +Get-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" ``` -PS C:\> Get-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" +```output KeyName Rights ------- ------ mypolicy1 ServiceConfig, DeviceConnect, EnrollmentWrite @@ -48,9 +50,11 @@ mypolicy2 EnrollmentWrite List all shared access policies in "myiotdps". ### Example 2 +```powershell +Get-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" ``` -PS C:\> Get-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" +```output ResourceGroupName : myresourcegroup Name : myiotdps KeyName : mypolicy diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceCertificate.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceCertificate.md index 6dee25d34075..3429b9e1710f 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceCertificate.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceCertificate.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningservicecertificate @@ -36,9 +36,11 @@ For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioni ## EXAMPLES ### Example 1 +```powershell +Get-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" ``` -PS C:\> Get-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" +```output Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate ResourceGroupName : myresourcegroup Name : myiotdps @@ -54,9 +56,11 @@ Etag : AAAAAAFpGcA= Show details about "mycertificate" in an Azure IoT Hub device provisioning service. ### Example 2 +```powershell +Get-AzIoTDps -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Get-AzIoTDpsCertificate ``` -PS C:\> Get-AzIoTDps -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Get-AzIoTDpsCertificate +```output ResourceGroupName Name CertificateName Status Expiry ----------------- ---- --------------- ------ ------ myresourcegroup myiotdps mycert1 Unverified 12/04/2027 13:12 diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollment.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollment.md index 08289f5a4939..41543041c311 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollment.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollment.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningserviceenrollment @@ -37,14 +37,14 @@ Get device enrollment details or List device enrollments in an Azure IoT Hub Dev ### Example 1 ```powershell -PS C:\> Get-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" +Get-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" ``` Get device enrollment details in an Azure IoT Hub Device Provisioning Service. ### Example 2 ```powershell -PS C:\> Get-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" +Get-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" ``` List device enrollments in an Azure IoT Hub Device Provisioning Service. diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollmentGroup.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollmentGroup.md index ddd76c91e783..7813b49c1ece 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceEnrollmentGroup.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningserviceenrollmentgroup @@ -37,14 +37,14 @@ Get the details of an enrollment group or list all enrollment groups in an Azure ### Example 1 ```powershell -PS C:\> Get-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" +Get-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" ``` Get device enrollment group in an Azure IoT Hub Device Provisioning Service. ### Example 2 ```powershell -PS C:\> Get-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" +Get-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" ``` List all device enrollment groups in an Azure IoT Hub Device Provisioning Service. diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceLinkedHub.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceLinkedHub.md index b7f755341fec..fbbdbd01acc0 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceLinkedHub.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceLinkedHub.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningservicelinkedhub @@ -36,9 +36,11 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +Get-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" ``` -PS C:\> Get-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" +```output LinkedHubName Location AllocationWeight ApplyAllocationPolicy ------------- -------- ---------------- --------------------- myiothub1.azure-devices.net eastus 2 @@ -48,9 +50,11 @@ myiothub2.azure-devices.net westus2 true List all linked IoT hubs in "myiotdps". ### Example 2 +```powershell +Get-AzIoTDpsHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub1" ``` -PS C:\> Get-AzIoTDpsHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub1" +```output ResourceGroupName : myresourcegroup Name : myiotdps LinkedHubName : myiothub1.azure-devices.net diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceRegistration.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceRegistration.md index 62182e61e304..ecc30934dfe0 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceRegistration.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Get-AzIoTDeviceProvisioningServiceRegistration.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/get-aziotdeviceprovisioningserviceregistration @@ -39,14 +39,14 @@ Get the device registration state or the registration state of devices under the ### Example 1 ```powershell -PS C:\> Get-AzIoTDeviceProvisioningServiceRegistration -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" +Get-AzIoTDeviceProvisioningServiceRegistration -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" ``` Get the device registration state details in an Azure IoT Hub Device Provisioning Service. ### Example 2 ```powershell -PS C:\> Get-AzIoTDeviceProvisioningServiceRegistration -ResourceGroupName "myresourcegroup" -DpsName "mydps" -EnrollmentId "grp-enroll1" +Get-AzIoTDeviceProvisioningServiceRegistration -ResourceGroupName "myresourcegroup" -DpsName "mydps" -EnrollmentId "grp-enroll1" ``` List all the registration state of devices in this enrollmentGroup. diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningService.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningService.md index a2d29acfb04c..aba885c6eca2 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningService.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningService.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/new-aziotdeviceprovisioningservice @@ -24,11 +24,13 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +$tags = @{} +$tags.Add('key1','value1') +New-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Tag $tags ``` -PS C:\> $tags = @{} -PS C:\> $tags.Add('key1','value1') -PS C:\> New-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Tag $tags +```output ResourceGroupName : myresourcegroup Name : myiotdps Location : westus @@ -46,9 +48,11 @@ Etag : AAAAAAAT52k= Create an Azure IoT Hub device provisioning service with the standard pricing tier S1 and tags, in the region of the resource group. ### Example 2 +```powershell +New-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Location "eastus" ``` -PS C:\> New-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Location "eastus" +```output ResourceGroupName : myresourcegroup Name : myiotdps Location : eastus diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningServiceCertificateVerificationCode.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningServiceCertificateVerificationCode.md index 1526fa0079d2..184c1269e38f 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningServiceCertificateVerificationCode.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/New-AzIoTDeviceProvisioningServiceCertificateVerificationCode.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/new-aziotdeviceprovisioningservicecertificateverificationcode @@ -38,9 +38,11 @@ For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioni ## EXAMPLES ### Example 1 +```powershell +New-AzIoTDeviceProvisioningServiceCertificateVerificationCode -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" ``` -PS C:\> New-AzIoTDeviceProvisioningServiceCertificateVerificationCode -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" +```output Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate ResourceGroupName : myresourcegroup Name : myiotdps @@ -57,9 +59,11 @@ Etag : AAAAAAFpGcA= Generate a verification code for "mycertificate". ### Example 2 +```powershell +Get-AzIoTDpsCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" | New-AzIoTDpsCVC ``` -PS C:\> Get-AzIoTDpsCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" | New-AzIoTDpsCVC +```output Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate ResourceGroupName : myresourcegroup Name : myiotdps diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningService.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningService.md index 76ef1646dd54..2e5115771b4a 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningService.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningService.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningservice @@ -36,17 +36,19 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +Remove-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -PassThru ``` -PS C:\> Remove-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -PassThru +```output True ``` Delete an Azure IoT Hub device provisioning service 'myiotdps'. ### Example 2 -``` -PS C:\> Get-AzIotDps -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Remove-AzIotDps +```powershell +Get-AzIotDps -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Remove-AzIotDps ``` Delete an Azure IoT Hub device provisioning service 'myiotdps' using pipeline. diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceAccessPolicy.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceAccessPolicy.md index 1b2c3d9603f1..8018095465bf 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceAccessPolicy.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceAccessPolicy.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningserviceaccesspolicy @@ -38,17 +38,19 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +Remove-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -PassThru ``` -PS C:\> Remove-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -PassThru +```output True ``` Delete shared access policy "mypolicy" in an Azure IoT Hub device provisioning service. ### Example 2 -``` -PS C:\> Get-AzIoTDpsAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" | Remove-AzIoTDpsAccessPolicy +```powershell +Get-AzIoTDpsAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" | Remove-AzIoTDpsAccessPolicy ``` Delete shared access policy "mypolicy" in an Azure IoT Hub device provisioning service using pipeline. diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceCertificate.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceCertificate.md index 216720dc1348..caa47ceaa806 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceCertificate.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceCertificate.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningservicecertificate @@ -37,9 +37,11 @@ For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioni ## EXAMPLES ### Example 1 +```powershell +Remove-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" -PassThru ``` -PS C:\> Remove-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Etag "AAAAAAFPazE=" -PassThru +```output True ``` diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollment.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollment.md index e5e04d901e30..6a7be22b8ac1 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollment.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollment.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningserviceenrollment @@ -39,14 +39,14 @@ Delete a device enrollment in an Azure IoT Hub Device Provisioning Service. ### Example 1 ```powershell -PS C:\> Remove-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -Passthru +Remove-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -Passthru ``` Delete a specified enrollment record. ### Example 2 ```powershell -PS C:\> Remove-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Passthru +Remove-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Passthru ``` Delete all enrollment records. diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup.md index 7d174ea35ff8..f73143ab6c4e 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningserviceenrollmentgroup @@ -39,14 +39,14 @@ Delete an enrollment group in an Azure IoT Hub Device Provisioning Service. ### Example 1 ```powershell -PS C:\> Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -Passthru +Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -Passthru ``` Delete a specified enrollment group. ### Example 2 ```powershell -PS C:\> Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Passthru +Remove-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Passthru ``` Delete all enrollment groups. diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceLinkedHub.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceLinkedHub.md index 13dfd7653c9c..c4b903ad5bc3 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceLinkedHub.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceLinkedHub.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningservicelinkedhub @@ -37,17 +37,19 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +Remove-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" -PassThru ``` -PS C:\> Remove-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" -PassThru +```output True ``` Delete linked IoT hub "myiothub" in an Azure IoT Hub device provisioning service. ### Example 2 -``` -PS C:\> Get-AzIoTDpsHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" | Remove-AzIoTDpsHub +```powershell +Get-AzIoTDpsHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" | Remove-AzIoTDpsHub ``` Delete linked IoT hub "myiothub" in an Azure IoT Hub device provisioning service using pipeline. diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceRegistration.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceRegistration.md index 7cce4dca9baf..90213313aa29 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceRegistration.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Remove-AzIoTDeviceProvisioningServiceRegistration.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/remove-aziotdeviceprovisioningserviceregistration @@ -39,7 +39,7 @@ Delete a device registration in an Azure IoT Hub Device Provisioning Service. ### Example 1 ```powershell -PS C:\> Remove-AzIoTDeviceProvisioningServiceRegistration -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -Passthru +Remove-AzIoTDeviceProvisioningServiceRegistration -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -Passthru ``` Delete a device registration in an Azure IoT Hub Device Provisioning Service. diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceCertificate.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceCertificate.md index 26b494fe6ac7..585537ada5bf 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceCertificate.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceCertificate.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/set-aziotdeviceprovisioningservicecertificate @@ -38,9 +38,11 @@ For a detailed explanation of CA certificates in Azure IoT Hub Device Provisioni ## EXAMPLES ### Example 1 +```powershell +Set-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" -Etag "AAAAAAFpGcA=" ``` -PS C:\> Set-AzIoTDeviceProvisioningServiceCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" -Path "c:\mycertificate.cer" -Etag "AAAAAAFpGcA=" +```output Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate ResourceGroupName : myresourcegroup Name : myiotdps @@ -56,9 +58,11 @@ Etag : AAAAAAFpGcA= Verify ownership of the "mycertificate" private key. ### Example 2 +```powershell +Get-AzIoTDpsCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" | Set-AzIoTDpsCertificate -Path "c:\mycertificate.cer" ``` -PS C:\> Get-AzIoTDpsCertificate -ResourceGroupName "myresourcegroup" -Name "myiotdps" -CertificateName "mycertificate" | Set-AzIoTDpsCertificate -Path "c:\mycertificate.cer" +```output Id : /subscriptions/377cxxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Devices/provisioningServices/myiotdps/certificates/mycertificate ResourceGroupName : myresourcegroup Name : myiotdps diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollment.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollment.md index cfb467b092a2..4ff522f551d9 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollment.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollment.md @@ -55,25 +55,25 @@ Update a device enrollment in an Azure IoT Hub Device Provisioning Service. ### Example 1 ```powershell -PS C:\> Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AllocationPolicy Hashed -IotHub "hub1","hub2" +Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -AllocationPolicy Hashed -IotHub "hub1","hub2" ``` Update allocation policy and hubs for an enrollment record. ### Example 2 ```powershell -PS C:\> $tag = @{} -PS C:\> $tag.Add("environment","updatedenv") -PS C:\> $desired = @{} -PS C:\> $desired.add("version_dps", "updateddps") -PS C:\> Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -tag $tag -Desired $desired +$tag = @{} +$tag.Add("environment","updatedenv") +$desired = @{} +$desired.add("version_dps", "updateddps") +Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -tag $tag -Desired $desired ``` Update an enrollment's initial twin state. ### Example 3 ```powershell -PS C:\> Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -PrimaryCertificate ".\primaryCertificate.cer" -SecondaryCertificate ".\secondaryCertificate.cer" +Set-AzIoTDeviceProvisioningServiceEnrollment -ResourceGroupName "myresourcegroup" -DpsName "mydps" -RegistrationId "enroll1" -PrimaryCertificate ".\primaryCertificate.cer" -SecondaryCertificate ".\secondaryCertificate.cer" ``` Update a symmetric key enrollment's primary and secondary certificates diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollmentGroup.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollmentGroup.md index 767a7e7ca385..ca6867d8256d 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollmentGroup.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Set-AzIoTDeviceProvisioningServiceEnrollmentGroup.md @@ -52,25 +52,25 @@ Update an enrollment group in an Azure IoT Hub Device Provisioning Service. ### Example 1 ```powershell -PS C:\> Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AllocationPolicy Hashed -IotHub "hub1","hub2" +Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AllocationPolicy Hashed -IotHub "hub1","hub2" ``` Update allocation policy and hubs for an enrollment group. ### Example 2 ```powershell -PS C:\> $tag = @{} -PS C:\> $tag.Add("environment","updatedenv") -PS C:\> $desired = @{} -PS C:\> $desired.add("version_dps", "updateddps") -PS C:\> Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -tag $tag -Desired $desired +$tag = @{} +$tag.Add("environment","updatedenv") +$desired = @{} +$desired.add("version_dps", "updateddps") +Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -tag $tag -Desired $desired ``` Update an enrollment group's initial twin state. ### Example 3 ```powershell -PS C:\> Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -PrimaryKey "newPrimaryKey" -SecondaryKey "newSecondaryKey" +Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -PrimaryKey "newPrimaryKey" -SecondaryKey "newSecondaryKey" ``` Update a symmetric key enrollment group's primary and secondary keys diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningService.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningService.md index ce99b1c49c8c..a4705fef61ad 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningService.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningService.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/update-aziotdeviceprovisioningservice @@ -56,9 +56,11 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +Update-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -AllocationPolicy "GeoLatency" ``` -PS C:\> Update-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -AllocationPolicy "GeoLatency" +```output ResourceGroupName : myresourcegroup Name : myiotdps Type : Microsoft.Devices/provisioningServices @@ -75,11 +77,13 @@ Etag : AAAAAAAT52k= Update Allocation Policy to "GeoLatency" of an Azure IoT Hub device provisioning service "myiotdps". ### Example 2 +```powershell +$tag = @{} +$tag.Add("key1","Value1") +Update-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Tag $tag ``` -PS C:\> $tag = @{} -PS C:\> $tag.Add("key1","Value1") -PS C:\> Update-AzIoTDeviceProvisioningService -ResourceGroupName "myresourcegroup" -Name "myiotdps" -Tag $tag +```output ResourceGroupName : myresourcegroup Name : myiotdps Type : Microsoft.Devices/provisioningServices @@ -96,11 +100,13 @@ Etag : AAAAAAAPoOk= Add tags to an Azure IoT Hub device provisioning service "myiotdps". ### Example 3 +```powershell +$tag = @{} +$tag.Add("key1","Value1") +Get-AzIoTDps -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Update-AzIoTDps -Tag $tag -Reset ``` -PS C:\> $tag = @{} -PS C:\> $tag.Add("key1","Value1") -PS C:\> Get-AzIoTDps -ResourceGroupName "myresourcegroup" -Name "myiotdps" | Update-AzIoTDps -Tag $tag -Reset +```output ResourceGroupName : myresourcegroup Name : myiotdps Type : Microsoft.Devices/provisioningServices diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceAccessPolicy.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceAccessPolicy.md index a1063b3cf12f..3dcc8594f683 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceAccessPolicy.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceAccessPolicy.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/update-aziotdeviceprovisioningserviceaccesspolicy @@ -38,9 +38,11 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +Update-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -Permissions "EnrollmentWrite" ``` -PS C:\> Update-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -Permissions "EnrollmentWrite" +```output ResourceGroupName : myresourcegroup Name : myiotdps KeyName : mypolicy @@ -51,10 +53,12 @@ Rights : EnrollmentWrite Update access policy "mypolicy" in an Azure IoT Hub device provisioning service with EnrollmentWrite right. -### Example 1 +### Example 2 +```powershell +Get-AzIoTDpsAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" | Update-AzIoTDpsAccessPolicy -Permissions "EnrollmentWrite" ``` -PS C:\> Get-AzIoTDpsAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" | Update-AzIoTDpsAccessPolicy -Permissions "EnrollmentWrite" +```output ResourceGroupName : myresourcegroup Name : myiotdps KeyName : mypolicy diff --git a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceLinkedHub.md b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceLinkedHub.md index e7f23e3fced5..ea6cfe5493df 100644 --- a/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceLinkedHub.md +++ b/src/DeviceProvisioningServices/DeviceProvisioningServices/help/Update-AzIoTDeviceProvisioningServiceLinkedHub.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.DeviceProvisioningServices.dll-Help.xml Module Name: Az.DeviceProvisioningServices online version: https://docs.microsoft.com/powershell/module/az.deviceprovisioningservices/update-aziotdeviceprovisioningservicelinkedhub @@ -39,9 +39,11 @@ For an introduction to Azure IoT Hub Device Provisioning Service, see https://do ## EXAMPLES ### Example 1 +```powershell +Update-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" -AllocationWeight 10 -ApplyAllocationPolicy $true ``` -PS C:\> Update-AzIoTDeviceProvisioningServiceLinkedHub -ResourceGroupName "myresourcegroup" -Name "myiotdps" -LinkedHubName "myiothub" -AllocationWeight 10 -ApplyAllocationPolicy $true +```output ResourceGroupName : myresourcegroup Name : myiotdps LinkedHubName : myiothub.azure-devices.net