Remove-AzDiskAccess

Reference

Module:: Az.Compute

Removes a disk access resource.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Remove-AzDiskAccess
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzDiskAccess
      [-ResourceId] <String>
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzDiskAccess
      [-InputObject] <PSDiskAccess>
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzDiskAccess cmdlet removes a disk access resource.

Examples

Example 1: Remove Disk Access using Default Parameter Set

Remove-AzDiskAccess -ResourceGroupName "ResourceGroup01" -Name "DiskAccess01"

This command removes the disk access named "DiskAccess01" in resource group "ResourceGroup01"

Example 2: Remove Disk Access using Resource ID

$myDiskAccess = Get-AzDiskAccess -ResourceGroupName "ResourceGroup01" -Name "DiskAccess01"
Remove-AzDiskAccess -ResourceId $myDiskAccess.id

This command removes the disk access by Resource ID

Example 3: Remove Disk Access using Input Object

$myDiskAccess = Get-AzDiskAccess -ResourceGroupName "ResourceGroup01" -Name "DiskAccess01"
Remove-AzDiskAccess -InputObject $myDiskAccess

This command removes the disk access by InputObject

Example 4: Remove Disk Access by piping Input Object

Get-AzDiskAccess -ResourceGroupName "ResourceGroup01" -Name "DiskAccess01" | Remove-AzDiskAccess

This command removes the disk access by piping the InputObject

Parameters

-AsJob

Run cmdlet in the background

Type:	SwitchParameter
Position:	Named
Default value:	None
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
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
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

PowerShell Disk Access Object

Type:	PSDiskAccess
Aliases:	DiskAccess
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specifies the name of a disk access.

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

-ResourceGroupName

Specifies the name of a resource group.

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

-ResourceId

Resource ID for your disk access.

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

Inputs

String

PSDiskAccess

Outputs

PSOperationStatusResponse