Skip to content

Split Az.DiskPool Examples #17099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BethanyZhou merged 1 commit into from
Mar 3, 2022
Merged

Split Az.DiskPool Examples #17099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions src/DiskPool/help/Get-AzDiskPool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ Get a Disk pool.

### Example 1: List all Disk Pools in a resource group
```powershell
PS C:\> Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test'
Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test'
```

```output
Name Location Status ProvisioningState AvailabilityZone
---- -------- ------ ----------------- ----------------
disk-pool-1 eastus2euap Running Succeeded {3}
Expand All @@ -52,8 +55,10 @@ This command lists all Disk Pools in a resource group

### Example 2: Get a Disk Pool
```powershell
PS C:\> Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1'
Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1'
```

```output
Name Location Status ProvisioningState AvailabilityZone
---- -------- ------ ----------------- ----------------
disk-pool-1 eastus2euap Running Succeeded {3}
Expand All @@ -63,8 +68,10 @@ This command gets a Disk Pool.

### Example 3: List all Disk Pools under a subscription
```powershell
PS C:\> Get-AzDiskPool
Get-AzDiskPool
```

```output
Name Location Status ProvisioningState AvailabilityZone
---- -------- ------ ----------------- ----------------
disk-pool-1 eastus2euap Running Succeeded {3}
Expand All @@ -75,8 +82,10 @@ This command lists all the Disk Pools in a subscription.

### Example 4: Get a Disk Pool by object
```powershell
PS C:\> New-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' -Location 'westeurope' -SkuName 'Standard' -SkuTier 'Standard' -SubnetId '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Network/virtualNetworks/disk-pool-vnet/subnets/default' -AvailabilityZone "1" | Get-AzDiskPool
New-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' -Location 'westeurope' -SkuName 'Standard' -SkuTier 'Standard' -SubnetId '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Network/virtualNetworks/disk-pool-vnet/subnets/default' -AvailabilityZone "1" | Get-AzDiskPool
```

```output
Name Location Status ProvisioningState AvailabilityZone
---- -------- ------ ----------------- ----------------
disk-pool-1 eastus2euap Running Succeeded {3}
Expand Down
12 changes: 9 additions & 3 deletions src/DiskPool/help/Get-AzDiskPoolIscsiTarget.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@ Get an iSCSI Target.

### Example 1: List iSCSI targets in a Disk Pool
```powershell
PS C:\> Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5'
Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5'
```

```output
Name Type
---- ----
target0 Microsoft.StoragePool/diskPools/iscsiTargets
Expand All @@ -47,8 +49,10 @@ This command lists all iSCSI targets in a Disk Pool.

### Example 2: Get an iSCSI target
```powershell
PS C:\> Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0'
Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0'
```

```output
Name Type
---- ----
target0 Microsoft.StoragePool/diskPools/iscsiTargets
Expand All @@ -58,8 +62,10 @@ This command gets an iSCSI target.

### Example 3: Get an iSCSI target by object
```powershell
PS C:\> New-AzDiskPoolIscsiTarget -DiskPoolName 'disk-pool-5' -Name 'target1' -ResourceGroupName 'storagepool-rg-test' -AclMode 'Dynamic' | Get-AzDiskPoolIscsiTarget
New-AzDiskPoolIscsiTarget -DiskPoolName 'disk-pool-5' -Name 'target1' -ResourceGroupName 'storagepool-rg-test' -AclMode 'Dynamic' | Get-AzDiskPoolIscsiTarget
```

```output
Name Type
---- ----
target1 Microsoft.StoragePool/diskPools/iscsiTargets
Expand Down
4 changes: 3 additions & 1 deletion src/DiskPool/help/Get-AzDiskPoolOutboundNetworkDependencyEndpoint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ Gets the network endpoints of all outbound dependencies of a Disk Pool

### Example 1: List network dependency endpoints for a Disk pool
```powershell
PS C:\> Get-AzDiskPoolOutboundNetworkDependencyEndpoint -DiskPoolName disk-pool-1 -ResourceGroupName storagepool-rg-test | ft -Wrap
Get-AzDiskPoolOutboundNetworkDependencyEndpoint -DiskPoolName disk-pool-1 -ResourceGroupName storagepool-rg-test | ft -Wrap
```

```output
Category Endpoint
-------- --------
Microsoft Event Hub {{
Expand Down
4 changes: 3 additions & 1 deletion src/DiskPool/help/Get-AzDiskPoolResourceSku.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ Lists available StoragePool resources and skus in an Azure location.

### Example 1: Lists all resources and skus in a location
```powershell
PS C:\> Get-AzDiskPoolResourceSku -Location AustraliaEast
Get-AzDiskPoolResourceSku -Location AustraliaEast
```

```output
ApiVersion Name ResourceType Tier
---------- ---- ------------ ----
2021-08-01 Standard_S1 diskPools Standard
Expand Down
4 changes: 3 additions & 1 deletion src/DiskPool/help/Get-AzDiskPoolZone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ Lists available Disk Pool Skus in an Azure location.

### Example 1: List availability zones for a location
```powershell
PS C:\> Get-AzDiskPoolZone -Location eastus
Get-AzDiskPoolZone -Location eastus
```

```output
SkuName SkuTier AvailabilityZone AdditionalCapability
------- ------- ---------------- --------------------
Basic Basic {3, 1, 2}
Expand Down
6 changes: 2 additions & 4 deletions src/DiskPool/help/Invoke-AzDiskPoolRedeployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,14 @@ This is expected service behavior.

### Example 1: Redeploy a Disk Pool
```powershell
PS C:\> Invoke-AzDiskPoolRedeployment -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test'

Invoke-AzDiskPoolRedeployment -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test'
```

This command redeploys a Disk Pool.

### Example 2: Redeploy a Disk Pool by object
```powershell
PS C:\> Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1' | Invoke-AzDiskPoolRedeployment

Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1' | Invoke-AzDiskPoolRedeployment
```

This command redeploys a Disk Pool by object.
Expand Down
4 changes: 3 additions & 1 deletion src/DiskPool/help/New-AzDiskPool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ This is expected service behavior.

### Example 1: Create a Disk Pool
```powershell
PS C:\> New-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' -Location 'eastus2euap' -SkuName 'Standard' -SkuTier 'Standard' -SubnetId '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Network/virtualNetworks/disk-pool-vnet/subnets/default' -AvailabilityZone "1"
New-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' -Location 'eastus2euap' -SkuName 'Standard' -SkuTier 'Standard' -SubnetId '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Network/virtualNetworks/disk-pool-vnet/subnets/default' -AvailabilityZone "1"
```

```output
Name Location Status ProvisioningState AvailabilityZone
---- -------- ------ ----------------- ----------------
disk-pool-1 eastus2euap Running Succeeded {3}
Expand Down
4 changes: 3 additions & 1 deletion src/DiskPool/help/New-AzDiskPoolAclObject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ Create a in-memory object for Acl

### Example 1: Create an acl object
```powershell
PS C:\> New-AzDiskPoolAclObject -InitiatorIqn 'iqn.2021-05.com.microsoft:target0' -MappedLun @('lun0')
New-AzDiskPoolAclObject -InitiatorIqn 'iqn.2021-05.com.microsoft:target0' -MappedLun @('lun0')
```

```output
InitiatorIqn MappedLun
------------ ---------
iqn.2021-05.com.microsoft:target0 {lun0}
Expand Down
3 changes: 1 addition & 2 deletions src/DiskPool/help/New-AzDiskPoolIscsiLunObject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ Create a in-memory object for IscsiLun

### Example 1: Create an iSCSI lun object
```powershell
PS C:\> New-AzDiskPoolIscsiLunObject -ManagedDiskAzureResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Compute/disks/disk-pool-disk-1" -Name 'lun0'

New-AzDiskPoolIscsiLunObject -ManagedDiskAzureResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Compute/disks/disk-pool-disk-1" -Name 'lun0'
```

This command creates an iSCSI lun object.
Expand Down
4 changes: 3 additions & 1 deletion src/DiskPool/help/New-AzDiskPoolIscsiTarget.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ Create or Update an iSCSI Target.

### Example 1: Create an iSCSI target
```powershell
PS C:\> New-AzDiskPoolIscsiTarget -DiskPoolName 'disk-pool-1' -Name 'target1' -ResourceGroupName 'storagepool-rg-test' -AclMode 'Dynamic'
New-AzDiskPoolIscsiTarget -DiskPoolName 'disk-pool-1' -Name 'target1' -ResourceGroupName 'storagepool-rg-test' -AclMode 'Dynamic'
```

```output
Name Type
---- ----
target1 Microsoft.StoragePool/diskPools/iscsiTargets
Expand Down
6 changes: 2 additions & 4 deletions src/DiskPool/help/Remove-AzDiskPool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,14 @@ This is expected service behavior.

### Example 1: Delete a Disk Pool
```powershell
PS C:\> Remove-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test'

Remove-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test'
```

This command deletes a Disk Pool.

### Example 2: Delete a Disk Pool by object
```powershell
PS C:\> Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1' | Remove-AzDiskPool

Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1' | Remove-AzDiskPool
```

This command deletes a Disk Pool by object.
Expand Down
6 changes: 2 additions & 4 deletions src/DiskPool/help/Remove-AzDiskPoolIscsiTarget.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,14 @@ Delete an iSCSI Target.

### Example 1: Remove an iSCSI target
```powershell
PS C:\> Remove-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0'

Remove-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0'
```

This command removes an iSCSI target.

### Example 2: Remove an iSCSI target by object
```powershell
PS C:\> Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0' | Remove-AzDiskPoolIscsiTarget

Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0' | Remove-AzDiskPoolIscsiTarget
```

This command removes an iSCSI target by object.
Expand Down
6 changes: 2 additions & 4 deletions src/DiskPool/help/Start-AzDiskPool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,14 @@ This is expected service behavior.

### Example 1: Start a Disk Pool
```powershell
PS C:\> Start-AzDiskPool -DiskPoolName 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test'

Start-AzDiskPool -DiskPoolName 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test'
```

This command starts a Disk Pool.

### Example 2: Start a Disk Pool by object
```powershell
PS C:\> Get-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' | Start-AzDiskPool

Get-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' | Start-AzDiskPool
```

This command starts a Disk Pool by object.
Expand Down
6 changes: 2 additions & 4 deletions src/DiskPool/help/Stop-AzDiskPool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,14 @@ This is expected service behavior.

### Example 1: Stop a Disk Pool
```powershell
PS C:\> Stop-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test'

Stop-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test'
```

This command deallocates a Disk Pool.

### Example 2: Stop a Disk Pool by object
```powershell
PS C:\> Get-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' | Stop-AzDiskPool

Get-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' | Stop-AzDiskPool
```

This command deallocates a Disk Pool by object.
Expand Down
8 changes: 6 additions & 2 deletions src/DiskPool/help/Update-AzDiskPool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@ Update a Disk pool.

### Example 1: Update a Disk Pool
```powershell
PS C:\> Update-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' -DiskId @()
Update-AzDiskPool -Name 'disk-pool-1' -ResourceGroupName 'storagepool-rg-test' -DiskId @()
```

```output
Name Location Status ProvisioningState AvailabilityZone
---- -------- ------ ----------------- ----------------
disk-pool-1 eastus2euap Running Succeeded {3}
Expand All @@ -44,8 +46,10 @@ This command updates a Disk Pool.

### Example 2: Update a Disk Pool by object
```powershell
PS C:\> Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1' | Update-AzDiskPool -DiskId @()
Get-AzDiskPool -ResourceGroupName 'storagepool-rg-test' -Name 'disk-pool-1' | Update-AzDiskPool -DiskId @()
```

```output
Name Location Status ProvisioningState AvailabilityZone
---- -------- ------ ----------------- ----------------
disk-pool-1 eastus2euap Running Succeeded {3}
Expand Down
12 changes: 8 additions & 4 deletions src/DiskPool/help/Update-AzDiskPoolIscsiTarget.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,11 @@ Update an iSCSI Target.

### Example 1: Update an iSCSI target
```powershell
PS C:\> $lun0 = New-AzDiskPoolIscsiLunObject -ManagedDiskAzureResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Compute/disks/disk1" -Name "lun0"
PS C:\> Update-AzDiskPoolIscsiTarget -Name 'target0' -DiskPoolName 'disk-pool-5' -ResourceGroupName 'storagepool-rg-test' -Lun @($lun0)
$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)
```

```output
Name Type
---- ----
target0 Microsoft.StoragePool/diskPools/iscsiTargets
Expand All @@ -46,9 +48,11 @@ This command updates an iSCSI target.

### Example 2: Update an iSCSI target by object
```powershell
PS C:\> $lun0 = New-AzDiskPoolIscsiLunObject -ManagedDiskAzureResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/storagepool-rg-test/providers/Microsoft.Compute/disks/disk1" -Name "lun0"
PS C:\> Get-AzDiskPoolIscsiTarget -ResourceGroupName 'storagepool-rg-test' -DiskPoolName 'disk-pool-5' -Name 'target0' | Update-AzDiskPoolIscsiTarget -Lun @($lun0)
$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)
```

```output
Name Type
---- ----
target0 Microsoft.StoragePool/diskPools/iscsiTargets
Expand Down