Edit

Share via

Remove-AzIoTDeviceProvisioningServiceAccessPolicy

  • Reference
Module:
Az.DeviceProvisioningServices

Delete a shared access policies in an Azure IoT Hub device provisioning service.

Syntax

Remove-AzIoTDeviceProvisioningServiceAccessPolicy
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-KeyName] <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzIoTDeviceProvisioningServiceAccessPolicy
      [-InputObject] <PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzIoTDeviceProvisioningServiceAccessPolicy
      [-ResourceId] <String>
      [-KeyName] <String>
      [-PassThru]
      [-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

Remove-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" -PassThru

True

Delete shared access policy "mypolicy" in an Azure IoT Hub device provisioning service.

Example 2

Get-AzIoTDeviceProvisioningServiceAccessPolicy -ResourceGroupName "myresourcegroup" -Name "myiotdps" -KeyName "mypolicy" | Remove-AzIoTDeviceProvisioningServiceAccessPolicy

Delete shared access policy "mypolicy" in an Azure IoT Hub device provisioning service using pipeline.

Parameters

-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:PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-KeyName

IoT Device Provisioning Service access policy key name

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
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

-PassThru

{{Fill PassThru Description}}

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

-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

PSSharedAccessSignatureAuthorizationRuleAccessRightsDescription

String

Outputs

Boolean