Edit

Update-AzDiskPoolIscsiTarget

  • Reference
Module:
Az.DiskPool

Update an iSCSI Target.

Syntax

Update-AzDiskPoolIscsiTarget
      -DiskPoolName <String>
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-Lun <IIscsiLun[]>]
      [-ManagedBy <String>]
      [-ManagedByExtended <String[]>]
      [-StaticAcl <IAcl[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzDiskPoolIscsiTarget
      -InputObject <IDiskPoolIdentity>
      [-Lun <IIscsiLun[]>]
      [-ManagedBy <String>]
      [-ManagedByExtended <String[]>]
      [-StaticAcl <IAcl[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Update an iSCSI Target.

Examples

Example 1: Update an iSCSI target

$lun0 = New-AzDiskPoolIscsiLunObject -ManagedDiskAzureResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Compute/disks/disk1" -Name "lun0"
Update-AzDiskPoolIscsiTarget -Name 'target0' -DiskPoolName 'disk-pool-5' -ResourceGroupName 'storagepool-rg-test' -Lun @($lun0)

Name               Type
----               ----
target0 Microsoft.StoragePool/diskPools/iscsiTargets

This command updates an iSCSI target.

Example 2: Update an iSCSI target by object

$lun0 = New-AzDiskPoolIscsiLunObject -ManagedDiskAzureResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Compute/disks/disk1" -Name "lun0"
Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0' | Update-AzDiskPoolIscsiTarget -Lun @($lun0)

Name               Type
----               ----
target0 Microsoft.StoragePool/diskPools/iscsiTargets

This command updates an iSCSI target by object.

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DiskPoolName

The name of the Disk Pool.

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Lun

List of LUNs to be exposed through iSCSI Target. To construct, see NOTES section for LUN properties and create a hash table.

Type:IIscsiLun[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ManagedBy

Azure resource id. Indicates if this resource is managed by another Azure resource.

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

-ManagedByExtended

List of Azure resource ids that manage this resource.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

The name of the iSCSI Target.

Type:String
Aliases:IscsiTargetName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-StaticAcl

Access Control List (ACL) for an iSCSI Target; defines LUN masking policy To construct, see NOTES section for STATICACL properties and create a hash table.

Type:IAcl[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
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

IDiskPoolIdentity

Outputs

IIscsiTarget

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IDiskPoolIdentity>: Identity Parameter

  • [DiskPoolName <String>]: The name of the Disk Pool.
  • [Id <String>]: Resource identity path
  • [IscsiTargetName <String>]: The name of the iSCSI Target.
  • [Location <String>]: The location of the resource.
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [SubscriptionId <String>]: The ID of the target subscription.

LUN <IIscsiLun[]>: List of LUNs to be exposed through iSCSI Target.

  • ManagedDiskAzureResourceId <String>: Azure Resource ID of the Managed Disk.
  • Name <String>: User defined name for iSCSI LUN; example: "lun0"

STATICACL <IAcl[]>: Access Control List (ACL) for an iSCSI Target; defines LUN masking policy

  • InitiatorIqn <String>: iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client".
  • MappedLun <String[]>: List of LUN names mapped to the ACL.