diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/.gitattributes b/src/PureStorageBlock/PureStorageBlock.Autorest/.gitattributes new file mode 100644 index 000000000000..2125666142eb --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/.gitattributes @@ -0,0 +1 @@ +* text=auto \ No newline at end of file diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/.gitignore b/src/PureStorageBlock/PureStorageBlock.Autorest/.gitignore new file mode 100644 index 000000000000..6ec158bd9768 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/.gitignore @@ -0,0 +1,16 @@ +bin +obj +.vs +generated +internal +exports +tools +test/*-TestResults.xml +license.txt +/*.ps1 +/*.psd1 +/*.ps1xml +/*.psm1 +/*.snk +/*.csproj +/*.nuspec \ No newline at end of file diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/Properties/AssemblyInfo.cs b/src/PureStorageBlock/PureStorageBlock.Autorest/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..53cc0483490a --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/Properties/AssemblyInfo.cs @@ -0,0 +1,27 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the Apache License, Version 2.0 (the ""License""); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ""AS IS"" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +// is regenerated. + +using System; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")] +[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] +[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] +[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - PureStorageBlock")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0")] +[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0")] +[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] +[assembly: System.CLSCompliantAttribute(false)] + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/README.md b/src/PureStorageBlock/PureStorageBlock.Autorest/README.md new file mode 100644 index 000000000000..31b4543fe1ba --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/README.md @@ -0,0 +1,74 @@ + +# Az.PureStorageBlock +This directory contains the PowerShell module for the PureStorageBlock service. + +--- +## Info +- Modifiable: yes +- Generated: all +- Committed: yes +- Packaged: yes + +--- +## Detail +This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension. + +## Module Requirements +- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater + +## Authentication +AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent. + +## Development +For information on how to develop for `Az.PureStorageBlock`, see [how-to.md](how-to.md). + + +### AutoRest Configuration +> see https://aka.ms/autorest + +```yaml +# pin the swagger version by using the commit id instead of branch name +commit: ca475ee541c3ff57778c0ff1bfc953a47ef3b0ca +require: +# readme.azure.noprofile.md is the common configuration file + - $(this-folder)/../../readme.azure.noprofile.md + - $(repo)/specification/purestorage/resource-manager/readme.md +# If the swagger has not been put in the repo, you may uncomment the following line and refer to it locally +# - (this-folder)/relative-path-to-your-local-readme.md + +try-require: + - $(repo)/specification/purestorage/resource-manager/readme.powershell.md + +# For new RP, the version is 0.1.0 +module-version: 0.2.0 +# Normally, title is the service name +title: PureStorageBlock +service-name: PureStorageBlock +subject-prefix: $(service-name) + +# The next three configurations are exclusive to v3, and in v4, they are activated by default. If you are still using v3, please uncomment them. +# identity-correction-for-post: true +# resourcegroup-append: true +# nested-object-to-string: true + +directive: + # Following are common directives which are normally required in all the RPs + # 1. Remove the unexpanded parameter set + # 2. For New-* cmdlets, ViaIdentity is not required + # Following two directives are v4 specific + - where: + variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString)) + remove: true + - where: + variant: ^CreateViaIdentity.*$ + remove: true + # Follow directive is v3 specific. If you are using v3, uncomment following directive and comments out two directives above + #- where: + # variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$ + # remove: true + + # Remove the set-* cmdlet + - where: + verb: Set + remove: true +``` diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/reservations.json b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/reservations.json new file mode 100644 index 000000000000..e06b4bd1ee0f --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/reservations.json @@ -0,0 +1,199 @@ +{ + "resourceType": "reservations", + "apiVersion": "2024-11-01-preview", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock" + }, + "commands": [ + { + "name": "Get-AzPureStorageBlockReservationBillingReport", + "description": "Provides a summarized report along with actions for resources billed via given reservation", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/reservations/{reservationName}/getBillingReport", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservationbillingreport" + }, + "parameterSets": [ + { + "parameters": [ + "-ReservationName ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Provides a summarized report along with actions for resources billed via given reservation", + "parameters": [ + { + "name": "-ReservationName", + "value": "[Path.reservationName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Get-AzPureStorageBlockReservationBillingStatus", + "description": "Provides various statistics about resources billed via given reservation.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/reservations/{reservationName}/getBillingStatus", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservationbillingstatus" + }, + "parameterSets": [ + { + "parameters": [ + "-ReservationName ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Provides various statistics about resources billed via given reservation.", + "parameters": [ + { + "name": "-ReservationName", + "value": "[Path.reservationName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Get-AzPureStorageBlockReservationResourceLimit", + "description": "Limits constraining certain resource properties.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/reservations/{reservationName}/getResourceLimits", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservationresourcelimit" + }, + "parameterSets": [ + { + "parameters": [ + "-ReservationName ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Limits constraining certain resource properties.", + "parameters": [ + { + "name": "-ReservationName", + "value": "[Path.reservationName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Get-AzPureStorageBlockReservation", + "description": "Get a reservation", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/reservations/{reservationName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservation" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get a reservation", + "parameters": [ + { + "name": "-Name", + "value": "[Path.reservationName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPureStorageBlockReservation", + "description": "Delete a reservation", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/reservations/{reservationName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockreservation" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete a reservation", + "parameters": [ + { + "name": "-Name", + "value": "[Path.reservationName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsStorageContainers-volumes.json b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsStorageContainers-volumes.json new file mode 100644 index 000000000000..3d58814a71d6 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsStorageContainers-volumes.json @@ -0,0 +1,105 @@ +{ + "resourceType": "storagePools/avsStorageContainers/volumes", + "apiVersion": "2024-11-01-preview", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock" + }, + "commands": [ + { + "name": "Get-AzPureStorageBlockAvsStorageContainerVolume", + "description": "Get a volume in an AVS storage container", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsStorageContainers/{storageContainerName}/volumes/{volumeId}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsstoragecontainervolume" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-StorageContainerName ", + "-StoragePoolName ", + "[-SubscriptionId ]", + "-VolumeId " + ] + } + ] + }, + "examples": [ + { + "description": "Get a volume in an AVS storage container", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StorageContainerName", + "value": "[Path.storageContainerName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + }, + { + "name": "-VolumeId", + "value": "[Path.volumeId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPureStorageBlockAvsStorageContainerVolume", + "description": "Delete a volume in an AVS storage container", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsStorageContainers/{storageContainerName}/volumes/{volumeId}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsstoragecontainervolume" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-StorageContainerName ", + "-StoragePoolName ", + "[-SubscriptionId ]", + "-VolumeId " + ] + } + ] + }, + "examples": [ + { + "description": "Delete a volume in an AVS storage container", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StorageContainerName", + "value": "[Path.storageContainerName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + }, + { + "name": "-VolumeId", + "value": "[Path.volumeId]" + } + ] + } + ] + } + ] +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsStorageContainers.json b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsStorageContainers.json new file mode 100644 index 000000000000..d27bb84037b5 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsStorageContainers.json @@ -0,0 +1,95 @@ +{ + "resourceType": "storagePools/avsStorageContainers", + "apiVersion": "2024-11-01-preview", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock" + }, + "commands": [ + { + "name": "Get-AzPureStorageBlockAvsStorageContainer", + "description": "Get an AVS storage container", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsStorageContainers/{storageContainerName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsstoragecontainer" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-StorageContainerName ", + "-StoragePoolName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get an AVS storage container", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StorageContainerName", + "value": "[Path.storageContainerName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPureStorageBlockAvsStorageContainer", + "description": "Delete an AVS storage container", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsStorageContainers/{storageContainerName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsstoragecontainer" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-StorageContainerName ", + "-StoragePoolName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete an AVS storage container", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StorageContainerName", + "value": "[Path.storageContainerName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsVms-avsVmVolumes.json b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsVms-avsVmVolumes.json new file mode 100644 index 000000000000..d2ae8e81c374 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsVms-avsVmVolumes.json @@ -0,0 +1,105 @@ +{ + "resourceType": "storagePools/avsVms/avsVmVolumes", + "apiVersion": "2024-11-01-preview", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock" + }, + "commands": [ + { + "name": "Get-AzPureStorageBlockAvsVMVolume", + "description": "Get a volume in an AVS VM", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms/{avsVmId}/avsVmVolumes/{volumeId}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsvmvolume" + }, + "parameterSets": [ + { + "parameters": [ + "-AvsVMId ", + "-ResourceGroupName ", + "-StoragePoolName ", + "[-SubscriptionId ]", + "-VolumeId " + ] + } + ] + }, + "examples": [ + { + "description": "Get a volume in an AVS VM", + "parameters": [ + { + "name": "-AvsVMId", + "value": "[Path.avsVmId]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + }, + { + "name": "-VolumeId", + "value": "[Path.volumeId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPureStorageBlockAvsVMVolume", + "description": "Delete a volume in an AVS VM", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms/{avsVmId}/avsVmVolumes/{volumeId}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsvmvolume" + }, + "parameterSets": [ + { + "parameters": [ + "-AvsVMId ", + "-ResourceGroupName ", + "-StoragePoolName ", + "[-SubscriptionId ]", + "-VolumeId " + ] + } + ] + }, + "examples": [ + { + "description": "Delete a volume in an AVS VM", + "parameters": [ + { + "name": "-AvsVMId", + "value": "[Path.avsVmId]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + }, + { + "name": "-VolumeId", + "value": "[Path.volumeId]" + } + ] + } + ] + } + ] +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsVms.json b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsVms.json new file mode 100644 index 000000000000..96acdca0b591 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools-avsVms.json @@ -0,0 +1,95 @@ +{ + "resourceType": "storagePools/avsVms", + "apiVersion": "2024-11-01-preview", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock" + }, + "commands": [ + { + "name": "Get-AzPureStorageBlockAvsVM", + "description": "Get an AVS VM", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms/{avsVmId}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsvm" + }, + "parameterSets": [ + { + "parameters": [ + "-Id ", + "-ResourceGroupName ", + "-StoragePoolName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get an AVS VM", + "parameters": [ + { + "name": "-Id", + "value": "[Path.avsVmId]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPureStorageBlockAvsVM", + "description": "Delete an AVS VM", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/avsVms/{avsVmId}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsvm" + }, + "parameterSets": [ + { + "parameters": [ + "-Id ", + "-ResourceGroupName ", + "-StoragePoolName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete an AVS VM", + "parameters": [ + { + "name": "-Id", + "value": "[Path.avsVmId]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools.json b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools.json new file mode 100644 index 000000000000..85a1613afd80 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/UX/PureStorage.Block/storagePools.json @@ -0,0 +1,275 @@ +{ + "resourceType": "storagePools", + "apiVersion": "2024-11-01-preview", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock" + }, + "commands": [ + { + "name": "Disable-AzPureStorageBlockStoragePoolAvConnection", + "description": "Disable the existing AVS connection", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/disableAvsConnection", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/disable-azpurestorageblockstoragepoolavconnection" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-StoragePoolName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Disable the existing AVS connection", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Get-AzPureStorageBlockStoragePoolAvConnection", + "description": "Returns current information about an on-going connection to an AVS instance", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/getAvsConnection", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepoolavconnection" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-StoragePoolName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Returns current information about an on-going connection to an AVS instance", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Get-AzPureStorageBlockStoragePoolAvStatus", + "description": "Returns the status of the storage pool connection to AVS", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/getAvsStatus", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepoolavstatus" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-StoragePoolName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Returns the status of the storage pool connection to AVS", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Get-AzPureStorageBlockStoragePoolHealthStatus", + "description": "Retrieve health metrics of a storage pool", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/getHealthStatus", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepoolhealthstatus" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-StoragePoolName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Retrieve health metrics of a storage pool", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Get-AzPureStorageBlockStoragePool", + "description": "Get a storage pool", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepool" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get a storage pool", + "parameters": [ + { + "name": "-Name", + "value": "[Path.storagePoolName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPureStorageBlockStoragePool", + "description": "Delete a storage pool", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockstoragepool" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete a storage pool", + "parameters": [ + { + "name": "-Name", + "value": "[Path.storagePoolName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Repair-AzPureStorageBlockStoragePoolAvConnection", + "description": "Test and repair, if needed, all configuration elements of the storage pool connection to the AVS instance", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PureStorage.Block/storagePools/{storagePoolName}/repairAvsConnection", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.purestorageblock/repair-azpurestorageblockstoragepoolavconnection" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-StoragePoolName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Test and repair, if needed, all configuration elements of the storage pool connection to the AVS instance", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-StoragePoolName", + "value": "[Path.storagePoolName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/custom/Az.PureStorageBlock.custom.psm1 b/src/PureStorageBlock/PureStorageBlock.Autorest/custom/Az.PureStorageBlock.custom.psm1 new file mode 100644 index 000000000000..0712d8fb38c6 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/custom/Az.PureStorageBlock.custom.psm1 @@ -0,0 +1,17 @@ +# region Generated + # Load the private module dll + $null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '../bin/Az.PureStorageBlock.private.dll') + + # Load the internal module + $internalModulePath = Join-Path $PSScriptRoot '../internal/Az.PureStorageBlock.internal.psm1' + if(Test-Path $internalModulePath) { + $null = Import-Module -Name $internalModulePath + } + + # Export nothing to clear implicit exports + Export-ModuleMember + + # Export script cmdlets + Get-ChildItem -Path $PSScriptRoot -Recurse -Include '*.ps1' -File | ForEach-Object { . $_.FullName } + Export-ModuleMember -Function (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot) -Alias (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot -AsAlias) +# endregion diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/custom/README.md b/src/PureStorageBlock/PureStorageBlock.Autorest/custom/README.md new file mode 100644 index 000000000000..eba85cb2890e --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/custom/README.md @@ -0,0 +1,41 @@ +# Custom +This directory contains custom implementation for non-generated cmdlets for the `Az.PureStorageBlock` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.PureStorageBlock.custom.psm1`. This file should not be modified. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: yes + +## Details +For `Az.PureStorageBlock` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*. + +For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.PureStorageBlock.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder. + +For script cmdlets, these are loaded via the `Az.PureStorageBlock.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build. + +## Purpose +This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder. + +## Usage +The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters: +- Break +- DefaultProfile +- HttpPipelineAppend +- HttpPipelinePrepend +- Proxy +- ProxyCredential +- ProxyUseDefaultCredentials + +These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.PureStorageBlock`. For C#, follow the usage seen in the `ProcessRecordAsync` method. + +### Attributes +For processing the cmdlets, we've created some additional attributes: +- `Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.DescriptionAttribute` + - Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts. +- `Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.DoNotExportAttribute` + - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.PureStorageBlock`. +- `Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.InternalExportAttribute` + - Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.PureStorageBlock`. For more information, see [README.md](../internal/README.md) in the `../internal` folder. +- `Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.ProfileAttribute` + - Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules. \ No newline at end of file diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Az.PureStorageBlock.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Az.PureStorageBlock.md new file mode 100644 index 000000000000..df1d345ba2f9 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Az.PureStorageBlock.md @@ -0,0 +1,100 @@ +--- +Module Name: Az.PureStorageBlock +Module Guid: 35360b27-fb12-436f-8c08-333dab981654 +Download Help Link: https://learn.microsoft.com/powershell/module/az.purestorageblock +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.PureStorageBlock Module +## Description +Microsoft Azure PowerShell: PureStorageBlock cmdlets + +## Az.PureStorageBlock Cmdlets +### [Disable-AzPureStorageBlockStoragePoolAvConnection](Disable-AzPureStorageBlockStoragePoolAvConnection.md) +Disable the existing AVS connection + +### [Enable-AzPureStorageBlockStoragePoolAvConnection](Enable-AzPureStorageBlockStoragePoolAvConnection.md) +Initiate a connection between the storage pool and a specified AVS SDDC resource + +### [Get-AzPureStorageBlockAvsStorageContainer](Get-AzPureStorageBlockAvsStorageContainer.md) +Get an AVS storage container + +### [Get-AzPureStorageBlockAvsStorageContainerVolume](Get-AzPureStorageBlockAvsStorageContainerVolume.md) +Get a volume in an AVS storage container + +### [Get-AzPureStorageBlockAvsVM](Get-AzPureStorageBlockAvsVM.md) +Get an AVS VM + +### [Get-AzPureStorageBlockAvsVMVolume](Get-AzPureStorageBlockAvsVMVolume.md) +Get a volume in an AVS VM + +### [Get-AzPureStorageBlockReservation](Get-AzPureStorageBlockReservation.md) +Get a reservation + +### [Get-AzPureStorageBlockReservationBillingReport](Get-AzPureStorageBlockReservationBillingReport.md) +Provides a summarized report along with actions for resources billed via given reservation + +### [Get-AzPureStorageBlockReservationBillingStatus](Get-AzPureStorageBlockReservationBillingStatus.md) +Provides various statistics about resources billed via given reservation. + +### [Get-AzPureStorageBlockReservationResourceLimit](Get-AzPureStorageBlockReservationResourceLimit.md) +Limits constraining certain resource properties. + +### [Get-AzPureStorageBlockStoragePool](Get-AzPureStorageBlockStoragePool.md) +Get a storage pool + +### [Get-AzPureStorageBlockStoragePoolAvConnection](Get-AzPureStorageBlockStoragePoolAvConnection.md) +Returns current information about an on-going connection to an AVS instance + +### [Get-AzPureStorageBlockStoragePoolAvStatus](Get-AzPureStorageBlockStoragePoolAvStatus.md) +Returns the status of the storage pool connection to AVS + +### [Get-AzPureStorageBlockStoragePoolHealthStatus](Get-AzPureStorageBlockStoragePoolHealthStatus.md) +Retrieve health metrics of a storage pool + +### [Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection](Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.md) +Finalize an already started AVS connection to a specific AVS SDDC + +### [New-AzPureStorageBlockReservation](New-AzPureStorageBlockReservation.md) +Create a reservation + +### [New-AzPureStorageBlockStoragePool](New-AzPureStorageBlockStoragePool.md) +Create a storage pool + +### [Remove-AzPureStorageBlockAvsStorageContainer](Remove-AzPureStorageBlockAvsStorageContainer.md) +Delete an AVS storage container + +### [Remove-AzPureStorageBlockAvsStorageContainerVolume](Remove-AzPureStorageBlockAvsStorageContainerVolume.md) +Delete a volume in an AVS storage container + +### [Remove-AzPureStorageBlockAvsVM](Remove-AzPureStorageBlockAvsVM.md) +Delete an AVS VM + +### [Remove-AzPureStorageBlockAvsVMVolume](Remove-AzPureStorageBlockAvsVMVolume.md) +Delete a volume in an AVS VM + +### [Remove-AzPureStorageBlockReservation](Remove-AzPureStorageBlockReservation.md) +Delete a reservation + +### [Remove-AzPureStorageBlockStoragePool](Remove-AzPureStorageBlockStoragePool.md) +Delete a storage pool + +### [Repair-AzPureStorageBlockStoragePoolAvConnection](Repair-AzPureStorageBlockStoragePoolAvConnection.md) +Test and repair, if needed, all configuration elements of the storage pool connection to the AVS instance + +### [Update-AzPureStorageBlockAvsStorageContainerVolume](Update-AzPureStorageBlockAvsStorageContainerVolume.md) +Update a volume in an AVS storage container + +### [Update-AzPureStorageBlockAvsVM](Update-AzPureStorageBlockAvsVM.md) +Update an AVS VM + +### [Update-AzPureStorageBlockAvsVMVolume](Update-AzPureStorageBlockAvsVMVolume.md) +Update a volume in an AVS VM + +### [Update-AzPureStorageBlockReservation](Update-AzPureStorageBlockReservation.md) +Update a reservation + +### [Update-AzPureStorageBlockStoragePool](Update-AzPureStorageBlockStoragePool.md) +Update a storage pool + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Disable-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Disable-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..14f0ab8aa7e9 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Disable-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/disable-azpurestorageblockstoragepoolavconnection +schema: 2.0.0 +--- + +# Disable-AzPureStorageBlockStoragePoolAvConnection + +## SYNOPSIS +Disable the existing AVS connection + +## SYNTAX + +### Disable (Default) +``` +Disable-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DisableViaIdentity +``` +Disable-AzPureStorageBlockStoragePoolAvConnection -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Disable the existing AVS connection + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DisableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Enable-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Enable-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..c30196e9e667 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Enable-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,316 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/enable-azpurestorageblockstoragepoolavconnection +schema: 2.0.0 +--- + +# Enable-AzPureStorageBlockStoragePoolAvConnection + +## SYNOPSIS +Initiate a connection between the storage pool and a specified AVS SDDC resource + +## SYNTAX + +### EnableExpanded (Default) +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + -SddcResourceId [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Enable +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + -Property [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### EnableViaIdentity +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -InputObject + -Property [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### EnableViaIdentityExpanded +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -InputObject + -SddcResourceId [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### EnableViaJsonFilePath +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### EnableViaJsonString +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Initiate a connection between the storage pool and a specified AVS SDDC resource + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: EnableViaIdentity, EnableViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Enable operation + +```yaml +Type: System.String +Parameter Sets: EnableViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Enable operation + +```yaml +Type: System.String +Parameter Sets: EnableViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +EnableAvsConnection payload information + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePoolEnableAvsConnectionPost +Parameter Sets: Enable, EnableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Enable, EnableExpanded, EnableViaJsonFilePath, EnableViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SddcResourceId +Azure resource ID of the AVS SDDC to connect to + +```yaml +Type: System.String +Parameter Sets: EnableExpanded, EnableViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Enable, EnableExpanded, EnableViaJsonFilePath, EnableViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Enable, EnableExpanded, EnableViaJsonFilePath, EnableViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePoolEnableAvsConnectionPost + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsStorageContainer.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsStorageContainer.md new file mode 100644 index 000000000000..3406def44a60 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsStorageContainer.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsstoragecontainer +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockAvsStorageContainer + +## SYNOPSIS +Get an AVS storage container + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockAvsStorageContainer -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPureStorageBlockAvsStorageContainer -ResourceGroupName -StorageContainerName + -StoragePoolName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockAvsStorageContainer -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityStoragePool +``` +Get-AzPureStorageBlockAvsStorageContainer -StorageContainerName + -StoragePoolInputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get an AVS storage container + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the storage container + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsStorageContainer + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsStorageContainerVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsStorageContainerVolume.md new file mode 100644 index 000000000000..875eeb145e90 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsStorageContainerVolume.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsstoragecontainervolume +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockAvsStorageContainerVolume + +## SYNOPSIS +Get a volume in an AVS storage container + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName -VolumeId [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockAvsStorageContainerVolume -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityAvsStorageContainer +``` +Get-AzPureStorageBlockAvsStorageContainerVolume -AvsStorageContainerInputObject + -VolumeId [-DefaultProfile ] [] +``` + +### GetViaIdentityStoragePool +``` +Get-AzPureStorageBlockAvsStorageContainerVolume -StorageContainerName + -StoragePoolInputObject -VolumeId [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get a volume in an AVS storage container + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AvsStorageContainerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityAvsStorageContainer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the storage container + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityStoragePool, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the storage container + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityAvsStorageContainer, GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsStorageContainerVolume + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsVM.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsVM.md new file mode 100644 index 000000000000..03193748ef19 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsVM.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsvm +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockAvsVM + +## SYNOPSIS +Get an AVS VM + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockAvsVM -ResourceGroupName -StoragePoolName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPureStorageBlockAvsVM -Id -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockAvsVM -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityStoragePool +``` +Get-AzPureStorageBlockAvsVM -Id -StoragePoolInputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityStoragePool +Aliases: AvsVMId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsVM + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsVMVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsVMVolume.md new file mode 100644 index 000000000000..28331b2bb728 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockAvsVMVolume.md @@ -0,0 +1,226 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsvmvolume +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockAvsVMVolume + +## SYNOPSIS +Get a volume in an AVS VM + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + -VolumeId [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockAvsVMVolume -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityAvsVM +``` +Get-AzPureStorageBlockAvsVMVolume -AvsVMInputObject -VolumeId + [-DefaultProfile ] [] +``` + +### GetViaIdentityStoragePool +``` +Get-AzPureStorageBlockAvsVMVolume -AvsVMId -StoragePoolInputObject + -VolumeId [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a volume in an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AvsVMId +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityStoragePool, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsVMInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityAvsVM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the AVS VM + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityAvsVM, GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsVMVolume + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..1c0276283f72 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservation.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservation +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockReservation + +## SYNOPSIS +Get a reservation + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockReservation [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPureStorageBlockReservation -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockReservation -InputObject [-DefaultProfile ] + [] +``` + +### List1 +``` +Get-AzPureStorageBlockReservation -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a reservation + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ReservationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IReservation + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservationBillingReport.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservationBillingReport.md new file mode 100644 index 000000000000..7164638ce21f --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservationBillingReport.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservationbillingreport +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockReservationBillingReport + +## SYNOPSIS +Provides a summarized report along with actions for resources billed via given reservation + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockReservationBillingReport -ReservationName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockReservationBillingReport -InputObject + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Provides a summarized report along with actions for resources billed via given reservation + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReservationName +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IReservationBillingUsageReport + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservationBillingStatus.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservationBillingStatus.md new file mode 100644 index 000000000000..952d5722d346 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservationBillingStatus.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservationbillingstatus +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockReservationBillingStatus + +## SYNOPSIS +Provides various statistics about resources billed via given reservation. + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockReservationBillingStatus -ReservationName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockReservationBillingStatus -InputObject + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Provides various statistics about resources billed via given reservation. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReservationName +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IReservationBillingStatus + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservationResourceLimit.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservationResourceLimit.md new file mode 100644 index 000000000000..fe5c0ca9b5d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockReservationResourceLimit.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservationresourcelimit +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockReservationResourceLimit + +## SYNOPSIS +Limits constraining certain resource properties. + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockReservationResourceLimit -ReservationName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockReservationResourceLimit -InputObject + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Limits constraining certain resource properties. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReservationName +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.ILimitDetails + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..5f20d45e6475 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePool.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepool +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockStoragePool + +## SYNOPSIS +Get a storage pool + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockStoragePool [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPureStorageBlockStoragePool -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockStoragePool -InputObject [-DefaultProfile ] + [] +``` + +### List1 +``` +Get-AzPureStorageBlockStoragePool -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a storage pool + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: StoragePoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePool + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..49d65191e49b --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepoolavconnection +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockStoragePoolAvConnection + +## SYNOPSIS +Returns current information about an on-going connection to an AVS instance + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockStoragePoolAvConnection -InputObject + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Returns current information about an on-going connection to an AVS instance + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsConnection + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePoolAvStatus.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePoolAvStatus.md new file mode 100644 index 000000000000..5115cb1f8a0a --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePoolAvStatus.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepoolavstatus +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockStoragePoolAvStatus + +## SYNOPSIS +Returns the status of the storage pool connection to AVS + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockStoragePoolAvStatus -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockStoragePoolAvStatus -InputObject + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Returns the status of the storage pool connection to AVS + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsStatus + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePoolHealthStatus.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePoolHealthStatus.md new file mode 100644 index 000000000000..fb0b182115d5 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Get-AzPureStorageBlockStoragePoolHealthStatus.md @@ -0,0 +1,179 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepoolhealthstatus +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockStoragePoolHealthStatus + +## SYNOPSIS +Retrieve health metrics of a storage pool + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockStoragePoolHealthStatus -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockStoragePoolHealthStatus -InputObject + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Retrieve health metrics of a storage pool + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IHealthResponse + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.md new file mode 100644 index 000000000000..5fa94346506d --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.md @@ -0,0 +1,381 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/invoke-azpurestorageblockfinalizestoragepoolavconnection +schema: 2.0.0 +--- + +# Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection + +## SYNOPSIS +Finalize an already started AVS connection to a specific AVS SDDC + +## SYNTAX + +### FinalizeExpanded (Default) +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-ServiceInitializationDataEnc ] + [-ServiceInitializationDataServiceAccountPassword ] + [-ServiceInitializationDataServiceAccountUsername ] + [-ServiceInitializationDataVSphereCertificate ] [-ServiceInitializationDataVSphereIP ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Finalize +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -ResourceGroupName -StoragePoolName + -Property [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### FinalizeViaIdentity +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -InputObject + -Property [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### FinalizeViaIdentityExpanded +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -InputObject + [-ServiceInitializationDataEnc ] [-ServiceInitializationDataServiceAccountPassword ] + [-ServiceInitializationDataServiceAccountUsername ] + [-ServiceInitializationDataVSphereCertificate ] [-ServiceInitializationDataVSphereIP ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### FinalizeViaJsonFilePath +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -ResourceGroupName -StoragePoolName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### FinalizeViaJsonString +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -ResourceGroupName -StoragePoolName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Finalize an already started AVS connection to a specific AVS SDDC + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: FinalizeViaIdentity, FinalizeViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Finalize operation + +```yaml +Type: System.String +Parameter Sets: FinalizeViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Finalize operation + +```yaml +Type: System.String +Parameter Sets: FinalizeViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +FinalizeAvsConnection payload information, either encoded or explicit + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePoolFinalizeAvsConnectionPost +Parameter Sets: Finalize, FinalizeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Finalize, FinalizeExpanded, FinalizeViaJsonFilePath, FinalizeViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceInitializationDataEnc +Encoded AVS connection information + +```yaml +Type: System.String +Parameter Sets: FinalizeExpanded, FinalizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceInitializationDataServiceAccountPassword +Service account password + +```yaml +Type: System.Security.SecureString +Parameter Sets: FinalizeExpanded, FinalizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceInitializationDataServiceAccountUsername +Service account username + +```yaml +Type: System.String +Parameter Sets: FinalizeExpanded, FinalizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceInitializationDataVSphereCertificate +AVS instance's vSphere certificate + +```yaml +Type: System.String +Parameter Sets: FinalizeExpanded, FinalizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceInitializationDataVSphereIP +AVS instance's vSphere IP address + +```yaml +Type: System.String +Parameter Sets: FinalizeExpanded, FinalizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Finalize, FinalizeExpanded, FinalizeViaJsonFilePath, FinalizeViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Finalize, FinalizeExpanded, FinalizeViaJsonFilePath, FinalizeViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePoolFinalizeAvsConnectionPost + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/New-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/New-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..6559c11d8de1 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/New-AzPureStorageBlockReservation.md @@ -0,0 +1,551 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/new-azpurestorageblockreservation +schema: 2.0.0 +--- + +# New-AzPureStorageBlockReservation + +## SYNOPSIS +Create a reservation + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPureStorageBlockReservation -Name -ResourceGroupName -Location + [-SubscriptionId ] [-AddressCity ] [-AddressCountry ] [-AddressLine1 ] + [-AddressLine2 ] [-AddressPostalCode ] [-AddressState ] + [-CompanyDetailCompanyName ] [-MarketplaceSubscriptionStatus ] [-OfferDetailOfferId ] + [-OfferDetailPlanId ] [-OfferDetailPlanName ] [-OfferDetailPublisherId ] + [-OfferDetailTermId ] [-OfferDetailTermUnit ] [-Tag ] [-UserEmailAddress ] + [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] [-UserUpn ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPureStorageBlockReservation -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzPureStorageBlockReservation -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create a reservation + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AddressCity +Name of the city + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressCountry +Name of the country + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressLine1 +Address line 1 + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressLine2 +Address line 2 + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressPostalCode +Postal code + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressState +State (if any) + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyDetailCompanyName +Company name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSubscriptionStatus +Marketplace subscription status + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ReservationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailOfferId +Offer ID for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanId +Plan ID for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanName +Plan Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPublisherId +Publisher ID for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermId +Term ID for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermUnit +Term Unit for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email address + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +Phone number + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserUpn +Principal name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IReservation + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/New-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/New-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..53c250c5a308 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/New-AzPureStorageBlockStoragePool.md @@ -0,0 +1,369 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/new-azpurestorageblockstoragepool +schema: 2.0.0 +--- + +# New-AzPureStorageBlockStoragePool + +## SYNOPSIS +Create a storage pool + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPureStorageBlockStoragePool -Name -ResourceGroupName -Location + [-SubscriptionId ] [-AvailabilityZone ] [-EnableSystemAssignedIdentity] + [-ProvisionedBandwidthMbPerSec ] [-ReservationResourceId ] [-Tag ] + [-UserAssignedIdentity ] [-VnetInjectionSubnetId ] [-VnetInjectionVnetId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPureStorageBlockStoragePool -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzPureStorageBlockStoragePool -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create a storage pool + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityZone +Azure Availability Zone the Pool is located in + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StoragePoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisionedBandwidthMbPerSec +Total bandwidth provisioned for the pool, in MB/s + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationResourceId +Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetInjectionSubnetId +Azure resource ID of the Virtual Network subnet where the storage pool will be connected + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetInjectionVnetId +Azure resource ID of the Virtual Network in which the subnet is located + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePool + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/README.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/README.md new file mode 100644 index 000000000000..339cebaec45c --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/README.md @@ -0,0 +1,11 @@ +# Docs +This directory contains the documentation of the cmdlets for the `Az.PureStorageBlock` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `../examples` folder. + +## Info +- Modifiable: no +- Generated: all +- Committed: yes +- Packaged: yes + +## Details +The process of documentation generation loads `Az.PureStorageBlock` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder. \ No newline at end of file diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsStorageContainer.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsStorageContainer.md new file mode 100644 index 000000000000..2e257eed82a0 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsStorageContainer.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsstoragecontainer +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockAvsStorageContainer + +## SYNOPSIS +Delete an AVS storage container + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockAvsStorageContainer -ResourceGroupName -StorageContainerName + -StoragePoolName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockAvsStorageContainer -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityStoragePool +``` +Remove-AzPureStorageBlockAvsStorageContainer -StorageContainerName + -StoragePoolInputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete an AVS storage container + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the storage container + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsStorageContainerVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsStorageContainerVolume.md new file mode 100644 index 000000000000..7c834e37920e --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsStorageContainerVolume.md @@ -0,0 +1,299 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsstoragecontainervolume +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockAvsStorageContainerVolume + +## SYNOPSIS +Delete a volume in an AVS storage container + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName -VolumeId [-SubscriptionId ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockAvsStorageContainerVolume -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityAvsStorageContainer +``` +Remove-AzPureStorageBlockAvsStorageContainerVolume -AvsStorageContainerInputObject + -VolumeId [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentityStoragePool +``` +Remove-AzPureStorageBlockAvsStorageContainerVolume -StorageContainerName + -StoragePoolInputObject -VolumeId [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a volume in an AVS storage container + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsStorageContainerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityAvsStorageContainer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the storage container + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the storage container + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityAvsStorageContainer, DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsVM.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsVM.md new file mode 100644 index 000000000000..613979cf7b48 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsVM.md @@ -0,0 +1,261 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsvm +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockAvsVM + +## SYNOPSIS +Delete an AVS VM + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockAvsVM -Id -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockAvsVM -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityStoragePool +``` +Remove-AzPureStorageBlockAvsVM -Id -StoragePoolInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStoragePool +Aliases: AvsVMId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsVMVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsVMVolume.md new file mode 100644 index 000000000000..46ae99d48619 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockAvsVMVolume.md @@ -0,0 +1,298 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsvmvolume +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockAvsVMVolume + +## SYNOPSIS +Delete a volume in an AVS VM + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + -VolumeId [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockAvsVMVolume -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityAvsVM +``` +Remove-AzPureStorageBlockAvsVMVolume -AvsVMInputObject -VolumeId + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityStoragePool +``` +Remove-AzPureStorageBlockAvsVMVolume -AvsVMId -StoragePoolInputObject + -VolumeId [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Delete a volume in an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsVMId +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsVMInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityAvsVM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the AVS VM + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityAvsVM, DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..6be91c497750 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockReservation.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockreservation +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockReservation + +## SYNOPSIS +Delete a reservation + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockReservation -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockReservation -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a reservation + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ReservationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..e9e0435b78fa --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Remove-AzPureStorageBlockStoragePool.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockstoragepool +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockStoragePool + +## SYNOPSIS +Delete a storage pool + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockStoragePool -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockStoragePool -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a storage pool + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: StoragePoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Repair-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Repair-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..c41ba6eb3d31 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Repair-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/repair-azpurestorageblockstoragepoolavconnection +schema: 2.0.0 +--- + +# Repair-AzPureStorageBlockStoragePoolAvConnection + +## SYNOPSIS +Test and repair, if needed, all configuration elements of the storage pool connection to the AVS instance + +## SYNTAX + +### Repair (Default) +``` +Repair-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### RepairViaIdentity +``` +Repair-AzPureStorageBlockStoragePoolAvConnection -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Test and repair, if needed, all configuration elements of the storage pool connection to the AVS instance + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: RepairViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Repair +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Repair +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Repair +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockAvsStorageContainerVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockAvsStorageContainerVolume.md new file mode 100644 index 000000000000..b0a7ba854952 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockAvsStorageContainerVolume.md @@ -0,0 +1,344 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/update-azpurestorageblockavsstoragecontainervolume +schema: 2.0.0 +--- + +# Update-AzPureStorageBlockAvsStorageContainerVolume + +## SYNOPSIS +Update a volume in an AVS storage container + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName -VolumeId [-SubscriptionId ] [-SoftDeletionDestroyed] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityAvsStorageContainerExpanded +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -AvsStorageContainerInputObject + -VolumeId [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -InputObject + [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityStoragePoolExpanded +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -StorageContainerName + -StoragePoolInputObject -VolumeId [-SoftDeletionDestroyed] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName -VolumeId -JsonFilePath [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName -VolumeId -JsonString [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a volume in an AVS storage container + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsStorageContainerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityAvsStorageContainerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletionDestroyed +If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityAvsStorageContainerExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityStoragePoolExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the storage container + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityStoragePoolExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityStoragePoolExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the storage container + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAvsStorageContainerExpanded, UpdateViaIdentityStoragePoolExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsStorageContainerVolume + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockAvsVM.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockAvsVM.md new file mode 100644 index 000000000000..02ba76971c04 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockAvsVM.md @@ -0,0 +1,306 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/update-azpurestorageblockavsvm +schema: 2.0.0 +--- + +# Update-AzPureStorageBlockAvsVM + +## SYNOPSIS +Update an AVS VM + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPureStorageBlockAvsVM -Id -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPureStorageBlockAvsVM -InputObject [-SoftDeletionDestroyed] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityStoragePoolExpanded +``` +Update-AzPureStorageBlockAvsVM -Id -StoragePoolInputObject + [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPureStorageBlockAvsVM -Id -ResourceGroupName -StoragePoolName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzPureStorageBlockAvsVM -Id -ResourceGroupName -StoragePoolName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Update an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityStoragePoolExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: AvsVMId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletionDestroyed +If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityStoragePoolExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityStoragePoolExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsVM + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockAvsVMVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockAvsVMVolume.md new file mode 100644 index 000000000000..695ce9d5398d --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockAvsVMVolume.md @@ -0,0 +1,343 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/update-azpurestorageblockavsvmvolume +schema: 2.0.0 +--- + +# Update-AzPureStorageBlockAvsVMVolume + +## SYNOPSIS +Update a volume in an AVS VM + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + -VolumeId [-SubscriptionId ] [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityAvsVMExpanded +``` +Update-AzPureStorageBlockAvsVMVolume -AvsVMInputObject -VolumeId + [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPureStorageBlockAvsVMVolume -InputObject [-SoftDeletionDestroyed] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityStoragePoolExpanded +``` +Update-AzPureStorageBlockAvsVMVolume -AvsVMId -StoragePoolInputObject + -VolumeId [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + -VolumeId -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + -VolumeId -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a volume in an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsVMId +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityStoragePoolExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsVMInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityAvsVMExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletionDestroyed +If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityAvsVMExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityStoragePoolExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityStoragePoolExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the AVS VM + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAvsVMExpanded, UpdateViaIdentityStoragePoolExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsVMVolume + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..2690a249b429 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockReservation.md @@ -0,0 +1,455 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/update-azpurestorageblockreservation +schema: 2.0.0 +--- + +# Update-AzPureStorageBlockReservation + +## SYNOPSIS +Update a reservation + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPureStorageBlockReservation -Name -ResourceGroupName [-SubscriptionId ] + [-AddressCity ] [-AddressCountry ] [-AddressLine1 ] [-AddressLine2 ] + [-AddressPostalCode ] [-AddressState ] [-CompanyDetailCompanyName ] + [-Tag ] [-UserEmailAddress ] [-UserFirstName ] [-UserLastName ] + [-UserPhoneNumber ] [-UserUpn ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPureStorageBlockReservation -InputObject [-AddressCity ] + [-AddressCountry ] [-AddressLine1 ] [-AddressLine2 ] [-AddressPostalCode ] + [-AddressState ] [-CompanyDetailCompanyName ] [-Tag ] [-UserEmailAddress ] + [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] [-UserUpn ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPureStorageBlockReservation -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonString +``` +Update-AzPureStorageBlockReservation -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update a reservation + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AddressCity +Name of the city + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressCountry +Name of the country + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressLine1 +Address line 1 + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressLine2 +Address line 2 + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressPostalCode +Postal code + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressState +State (if any) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyDetailCompanyName +Company name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: ReservationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email address + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +Phone number + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserUpn +Principal name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IReservation + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..e1479a00f85d --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/docs/Update-AzPureStorageBlockStoragePool.md @@ -0,0 +1,274 @@ +--- +external help file: +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/update-azpurestorageblockstoragepool +schema: 2.0.0 +--- + +# Update-AzPureStorageBlockStoragePool + +## SYNOPSIS +Update a storage pool + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPureStorageBlockStoragePool -Name -ResourceGroupName [-SubscriptionId ] + [-EnableSystemAssignedIdentity ] [-ProvisionedBandwidthMbPerSec ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPureStorageBlockStoragePool -InputObject + [-EnableSystemAssignedIdentity ] [-ProvisionedBandwidthMbPerSec ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update a storage pool + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: StoragePoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisionedBandwidthMbPerSec +Total bandwidth provisioned for the pool, in MB/s + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePool + +## NOTES + +## RELATED LINKS + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Disable-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Disable-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Disable-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Enable-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Enable-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Enable-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsStorageContainer.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsStorageContainer.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsStorageContainer.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsStorageContainerVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsStorageContainerVolume.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsStorageContainerVolume.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsVM.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsVM.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsVM.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsVMVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsVMVolume.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockAvsVMVolume.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..8d1bd3c63c80 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservation.md @@ -0,0 +1,47 @@ +### Example 1: {{ Get specific Reservation details in ResourceGroup }} +```powershell + Get-AzPureStorageBlockReservation -Name testreservation_support_tags -ResourceGroupName dalSUK +``` + +```output +AddressCity : Redmond +AddressCountry : US +AddressLine1 : A-313, SVS Palms 2, Chinnapanhalli Main Road, Next To Ekya ITPL School + Chinnapanhalli, Marathahalli, Bengaluru, Karnataka 560037 +AddressLine2 : A-313 3rd Floor +AddressPostalCode : 98052-8300 +AddressState : wa +CompanyDetailCompanyName : nn +Id : /subscriptions/834be33e-67e6-45ed-a454-c25a34cdec1f/resourceGroups/dalSUK/pro + viders/PureStorage.Block/reservations/testreservation_support_tags +InternalId : 28422588-aa48-4beb-9b62-505d858687ba +Location : Central US +MarketplaceSubscriptionId : f58b0d40-98b2-4963-cf53-f9ef81640f8c +MarketplaceSubscriptionStatus : Subscribed +Name : testreservation_support_tags +OfferDetailOfferId : krypton_3_plan +OfferDetailPlanId : private_preview_zero +OfferDetailPlanName : Preview Plan +OfferDetailPublisherId : purestoragemarketplaceadmin +OfferDetailTermId : gmz7xq9ge3py +OfferDetailTermUnit : P1M +ProvisioningState : Succeeded +ResourceGroupName : dalSUK +SystemDataCreatedAt : 7/8/2025 12:41:07 PM +SystemDataCreatedBy : ritikajoshi@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/8/2025 12:41:07 PM +SystemDataLastModifiedBy : ritikajoshi@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + } +Type : purestorage.block/reservations +UserEmailAddress : ritikajoshi@microsoft.com +UserFirstName : Ritika +UserLastName : Joshi +UserPhoneNumber : +UserUpn : +``` + +This command will give details of reservation resource present in the resource group in a given subscription. + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservationBillingReport.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservationBillingReport.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservationBillingReport.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservationBillingStatus.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservationBillingStatus.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservationBillingStatus.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservationResourceLimit.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservationResourceLimit.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockReservationResourceLimit.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePool.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePoolAvStatus.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePoolAvStatus.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePoolAvStatus.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePoolHealthStatus.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePoolHealthStatus.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Get-AzPureStorageBlockStoragePoolHealthStatus.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/New-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/New-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/New-AzPureStorageBlockReservation.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/New-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/New-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/New-AzPureStorageBlockStoragePool.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsStorageContainer.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsStorageContainer.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsStorageContainer.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsStorageContainerVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsStorageContainerVolume.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsStorageContainerVolume.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsVM.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsVM.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsVM.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsVMVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsVMVolume.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockAvsVMVolume.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockReservation.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Remove-AzPureStorageBlockStoragePool.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Repair-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Repair-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Repair-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockAvsStorageContainerVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockAvsStorageContainerVolume.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockAvsStorageContainerVolume.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockAvsVM.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockAvsVM.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockAvsVM.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockAvsVMVolume.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockAvsVMVolume.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockAvsVMVolume.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockReservation.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/examples/Update-AzPureStorageBlockStoragePool.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/generate-info.json b/src/PureStorageBlock/PureStorageBlock.Autorest/generate-info.json new file mode 100644 index 000000000000..75f183fec646 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/generate-info.json @@ -0,0 +1,3 @@ +{ + "generate_Id": "4b9cd6e1-385b-4b33-bc60-caf252954b2b" +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/how-to.md b/src/PureStorageBlock/PureStorageBlock.Autorest/how-to.md new file mode 100644 index 000000000000..4bdc6e5dd5c6 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/how-to.md @@ -0,0 +1,58 @@ +# How-To +This document describes how to develop for `Az.PureStorageBlock`. + +## Building `Az.PureStorageBlock` +To build, run the `build-module.ps1` at the root of the module directory. This will generate the proxy script cmdlets that are the cmdlets being exported by this module. After the build completes, the proxy script cmdlets will be output to the `exports` folder. To read more about the proxy script cmdlets, look at the [README.md](exports/README.md) in the `exports` folder. + +## Creating custom cmdlets +To add cmdlets that were not generated by the REST specification, use the `custom` folder. This folder allows you to add handwritten `.ps1` and `.cs` files. Currently, we support using `.ps1` scripts as new cmdlets or as additional low-level variants (via `ParameterSet`), and `.cs` files as low-level (variants) cmdlets that the exported script cmdlets call. We do not support exporting any `.cs` (dll) cmdlets directly. To read more about custom cmdlets, look at the [README.md](custom/README.md) in the `custom` folder. + +## Generating documentation +To generate documentation, the process is now integrated into the `build-module.ps1` script. If you don't want to run this process as part of `build-module.ps1`, you can provide the `-NoDocs` switch. If you want to run documentation generation after the build process, you may still run the `generate-help.ps1` script. Overall, the process will look at the documentation comments in the generated and custom cmdlets and types, and create `.md` files into the `docs` folder. Additionally, this pulls in any examples from the `examples` folder and adds them to the generated help markdown documents. To read more about examples, look at the [README.md](examples/README.md) in the `examples` folder. To read more about documentation, look at the [README.md](docs/README.md) in the `docs` folder. + +## Testing `Az.PureStorageBlock` +To test the cmdlets, we use [Pester](https://github.com/pester/Pester). Tests scripts (`.ps1`) should be added to the `test` folder. To execute the Pester tests, run the `test-module.ps1` script. This will run all tests in `playback` mode within the `test` folder. To read more about testing cmdlets, look at the [README.md](examples/README.md) in the `examples` folder. + +## Packing `Az.PureStorageBlock` +To pack `Az.PureStorageBlock` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://learn.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team. + +## Module Script Details +There are multiple scripts created for performing different actions for developing `Az.PureStorageBlock`. +- `build-module.ps1` + - Builds the module DLL (`./bin/Az.PureStorageBlock.private.dll`), creates the exported cmdlets and documentation, generates custom cmdlet test stubs and exported cmdlet example stubs, and updates `./Az.PureStorageBlock.psd1` with Azure profile information. + - **Parameters**: [`Switch` parameters] + - `-Run`: After building, creates an isolated PowerShell session and loads `Az.PureStorageBlock`. + - `-Test`: After building, runs the `Pester` tests defined in the `test` folder. + - `-Docs`: After building, generates the Markdown documents for the modules into the `docs` folder. + - `-Pack`: After building, packages the module into a `.nupkg`. + - `-Code`: After building, opens a VSCode window with the module's directory and runs (see `-Run`) the module. + - `-Release`: Builds the module in `Release` configuration (as opposed to `Debug` configuration). + - `-NoDocs`: Supresses writing the documentation markdown files as part of the cmdlet exporting process. + - `-Debugger`: Used when attaching the debugger in Visual Studio to the PowerShell session, and running the build process without recompiling the DLL. This suppresses running the script as an isolated process. +- `run-module.ps1` + - Creates an isolated PowerShell session and loads `Az.PureStorageBlock` into the session. + - Same as `-Run` in `build-module.ps1`. + - **Parameters**: [`Switch` parameters] + - `-Code`: Opens a VSCode window with the module's directory. + - Same as `-Code` in `build-module.ps1`. +- `generate-help.ps1` + - Generates the Markdown documents for the modules into the `docs` folder. + - Same as `-Docs` in `build-module.ps1`. +- `test-module.ps1` + - Runs the `Pester` tests defined in the `test` folder. + - Same as `-Test` in `build-module.ps1`. +- `pack-module.ps1` + - Packages the module into a `.nupkg` for distribution. + - Same as `-Pack` in `build-module.ps1`. +- `generate-help.ps1` + - Generates the Markdown documents for the modules into the `docs` folder. + - Same as `-Docs` in `build-module.ps1`. + - This process is now integrated into `build-module.ps1` automatically. To disable, use `-NoDocs` when running `build-module.ps1`. +- `export-surface.ps1` + - Generates Markdown documents for both the cmdlet surface and the model (class) surface of the module. + - These files are placed into the `resources` folder. + - Used for investigating the surface of your module. These are *not* documentation for distribution. +- `check-dependencies.ps1` + - Used in `run-module.ps1` and `test-module.ps1` to verify dependent modules are available to run those tasks. + - It will download local (within the module's directory structure) versions of those modules as needed. + - This script *does not* need to be ran by-hand. \ No newline at end of file diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/resources/README.md b/src/PureStorageBlock/PureStorageBlock.Autorest/resources/README.md new file mode 100644 index 000000000000..736492341e3d --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/resources/README.md @@ -0,0 +1,11 @@ +# Resources +This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `../custom` folder. + +## Info +- Modifiable: yes +- Generated: no +- Committed: yes +- Packaged: no + +## Purpose +Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact. \ No newline at end of file diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Disable-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Disable-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 new file mode 100644 index 000000000000..9569c11d618e --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Disable-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Disable-AzPureStorageBlockStoragePoolAvConnection')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Disable-AzPureStorageBlockStoragePoolAvConnection.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Disable-AzPureStorageBlockStoragePoolAvConnection' { + It 'Disable' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DisableViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Enable-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Enable-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 new file mode 100644 index 000000000000..f29834a29195 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Enable-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 @@ -0,0 +1,41 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Enable-AzPureStorageBlockStoragePoolAvConnection')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Enable-AzPureStorageBlockStoragePoolAvConnection.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Enable-AzPureStorageBlockStoragePoolAvConnection' { + It 'EnableExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'EnableViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'EnableViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Enable' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'EnableViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'EnableViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsStorageContainer.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsStorageContainer.Tests.ps1 new file mode 100644 index 000000000000..65eda9e8b3ef --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsStorageContainer.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockAvsStorageContainer')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockAvsStorageContainer.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockAvsStorageContainer' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityStoragePool' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsStorageContainerVolume.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsStorageContainerVolume.Tests.ps1 new file mode 100644 index 000000000000..b939440fed05 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsStorageContainerVolume.Tests.ps1 @@ -0,0 +1,37 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockAvsStorageContainerVolume')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockAvsStorageContainerVolume.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockAvsStorageContainerVolume' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityStoragePool' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityAvsStorageContainer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsVM.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsVM.Tests.ps1 new file mode 100644 index 000000000000..edc740aa96c3 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsVM.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockAvsVM')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockAvsVM.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockAvsVM' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityStoragePool' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsVMVolume.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsVMVolume.Tests.ps1 new file mode 100644 index 000000000000..4de32297d421 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockAvsVMVolume.Tests.ps1 @@ -0,0 +1,37 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockAvsVMVolume')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockAvsVMVolume.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockAvsVMVolume' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityStoragePool' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityAvsVM' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservation.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservation.Tests.ps1 new file mode 100644 index 000000000000..cf67d05d13c8 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservation.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockReservation')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockReservation.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockReservation' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List1' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservationBillingReport.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservationBillingReport.Tests.ps1 new file mode 100644 index 000000000000..761ad177b248 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservationBillingReport.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockReservationBillingReport')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockReservationBillingReport.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockReservationBillingReport' { + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservationBillingStatus.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservationBillingStatus.Tests.ps1 new file mode 100644 index 000000000000..664c45d76d26 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservationBillingStatus.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockReservationBillingStatus')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockReservationBillingStatus.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockReservationBillingStatus' { + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservationResourceLimit.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservationResourceLimit.Tests.ps1 new file mode 100644 index 000000000000..f755696b4ea3 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockReservationResourceLimit.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockReservationResourceLimit')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockReservationResourceLimit.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockReservationResourceLimit' { + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePool.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePool.Tests.ps1 new file mode 100644 index 000000000000..82007fa9ec81 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePool.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockStoragePool')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockStoragePool.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockStoragePool' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List1' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 new file mode 100644 index 000000000000..fd2e9a2c74e8 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockStoragePoolAvConnection')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockStoragePoolAvConnection.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockStoragePoolAvConnection' { + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePoolAvStatus.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePoolAvStatus.Tests.ps1 new file mode 100644 index 000000000000..9c13246ed8b2 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePoolAvStatus.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockStoragePoolAvStatus')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockStoragePoolAvStatus.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockStoragePoolAvStatus' { + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePoolHealthStatus.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePoolHealthStatus.Tests.ps1 new file mode 100644 index 000000000000..fdb31a6fb373 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Get-AzPureStorageBlockStoragePoolHealthStatus.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPureStorageBlockStoragePoolHealthStatus')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPureStorageBlockStoragePoolHealthStatus.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzPureStorageBlockStoragePoolHealthStatus' { + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.Tests.ps1 new file mode 100644 index 000000000000..f3689525688d --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.Tests.ps1 @@ -0,0 +1,41 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection' { + It 'FinalizeExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'FinalizeViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'FinalizeViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Finalize' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'FinalizeViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'FinalizeViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/New-AzPureStorageBlockReservation.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/New-AzPureStorageBlockReservation.Tests.ps1 new file mode 100644 index 000000000000..c43e05a15d85 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/New-AzPureStorageBlockReservation.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzPureStorageBlockReservation')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzPureStorageBlockReservation.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'New-AzPureStorageBlockReservation' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/New-AzPureStorageBlockStoragePool.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/New-AzPureStorageBlockStoragePool.Tests.ps1 new file mode 100644 index 000000000000..28fbccebca47 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/New-AzPureStorageBlockStoragePool.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzPureStorageBlockStoragePool')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzPureStorageBlockStoragePool.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'New-AzPureStorageBlockStoragePool' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/README.md b/src/PureStorageBlock/PureStorageBlock.Autorest/test/README.md new file mode 100644 index 000000000000..1969200c6a09 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/README.md @@ -0,0 +1,17 @@ +# Test +This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `../custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: no + +## Details +We allow three testing modes: *live*, *record*, and *playback*. These can be selected using the `-Live`, `-Record`, and `-Playback` switches respectively on the `test-module.ps1` script. This script will run through any `.Tests.ps1` scripts in the `test` folder. If you choose the *record* mode, it will create a `.Recording.json` file of the REST calls between the client and server. Then, when you choose *playback* mode, it will use the `.Recording.json` file to mock the communication between server and client. The *live* mode runs the same as the *record* mode; however, it doesn't create the `.Recording.json` file. + +## Purpose +Custom cmdlets generally encompass additional functionality not described in the REST specification, or combines functionality generated from the REST spec. To validate this functionality continues to operate as intended, creating tests that can be ran and re-ran against custom cmdlets is part of the framework. + +## Usage +To execute tests, run the `test-module.ps1`. To write tests, [this example](https://github.com/pester/Pester/blob/8b9cf4248315e44f1ac6673be149f7e0d7f10466/Examples/Planets/Get-Planet.Tests.ps1#L1) from the Pester repository is very useful for getting started. \ No newline at end of file diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsStorageContainer.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsStorageContainer.Tests.ps1 new file mode 100644 index 000000000000..7eb4cec87bb8 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsStorageContainer.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPureStorageBlockAvsStorageContainer')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPureStorageBlockAvsStorageContainer.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzPureStorageBlockAvsStorageContainer' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityStoragePool' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsStorageContainerVolume.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsStorageContainerVolume.Tests.ps1 new file mode 100644 index 000000000000..b0bb5f6201a8 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsStorageContainerVolume.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPureStorageBlockAvsStorageContainerVolume')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPureStorageBlockAvsStorageContainerVolume.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzPureStorageBlockAvsStorageContainerVolume' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityStoragePool' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityAvsStorageContainer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsVM.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsVM.Tests.ps1 new file mode 100644 index 000000000000..1f576aba6af5 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsVM.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPureStorageBlockAvsVM')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPureStorageBlockAvsVM.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzPureStorageBlockAvsVM' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityStoragePool' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsVMVolume.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsVMVolume.Tests.ps1 new file mode 100644 index 000000000000..2a639d75fe44 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockAvsVMVolume.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPureStorageBlockAvsVMVolume')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPureStorageBlockAvsVMVolume.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzPureStorageBlockAvsVMVolume' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityStoragePool' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityAvsVM' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockReservation.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockReservation.Tests.ps1 new file mode 100644 index 000000000000..d545500db84f --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockReservation.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPureStorageBlockReservation')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPureStorageBlockReservation.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzPureStorageBlockReservation' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockStoragePool.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockStoragePool.Tests.ps1 new file mode 100644 index 000000000000..b15281d9aa31 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Remove-AzPureStorageBlockStoragePool.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPureStorageBlockStoragePool')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPureStorageBlockStoragePool.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzPureStorageBlockStoragePool' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Repair-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Repair-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 new file mode 100644 index 000000000000..0c18beafa10e --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Repair-AzPureStorageBlockStoragePoolAvConnection.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Repair-AzPureStorageBlockStoragePoolAvConnection')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Repair-AzPureStorageBlockStoragePoolAvConnection.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Repair-AzPureStorageBlockStoragePoolAvConnection' { + It 'Repair' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RepairViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockAvsStorageContainerVolume.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockAvsStorageContainerVolume.Tests.ps1 new file mode 100644 index 000000000000..d3412ccfb37f --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockAvsStorageContainerVolume.Tests.ps1 @@ -0,0 +1,41 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzPureStorageBlockAvsStorageContainerVolume')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzPureStorageBlockAvsStorageContainerVolume.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzPureStorageBlockAvsStorageContainerVolume' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityStoragePoolExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityAvsStorageContainerExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockAvsVM.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockAvsVM.Tests.ps1 new file mode 100644 index 000000000000..d965e2e9611f --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockAvsVM.Tests.ps1 @@ -0,0 +1,37 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzPureStorageBlockAvsVM')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzPureStorageBlockAvsVM.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzPureStorageBlockAvsVM' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityStoragePoolExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockAvsVMVolume.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockAvsVMVolume.Tests.ps1 new file mode 100644 index 000000000000..f4e96d913805 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockAvsVMVolume.Tests.ps1 @@ -0,0 +1,41 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzPureStorageBlockAvsVMVolume')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzPureStorageBlockAvsVMVolume.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzPureStorageBlockAvsVMVolume' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityStoragePoolExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityAvsVMExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockReservation.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockReservation.Tests.ps1 new file mode 100644 index 000000000000..0e9c757e8167 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockReservation.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzPureStorageBlockReservation')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzPureStorageBlockReservation.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzPureStorageBlockReservation' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockStoragePool.Tests.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockStoragePool.Tests.ps1 new file mode 100644 index 000000000000..1b5699baf4af --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/Update-AzPureStorageBlockStoragePool.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzPureStorageBlockStoragePool')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzPureStorageBlockStoragePool.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzPureStorageBlockStoragePool' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/loadEnv.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/loadEnv.ps1 new file mode 100644 index 000000000000..6a7c385c6b7d --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/loadEnv.ps1 @@ -0,0 +1,29 @@ +# ---------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +# is regenerated. +# ---------------------------------------------------------------------------------- +$envFile = 'env.json' +if ($TestMode -eq 'live') { + $envFile = 'localEnv.json' +} + +if (Test-Path -Path (Join-Path $PSScriptRoot $envFile)) { + $envFilePath = Join-Path $PSScriptRoot $envFile +} else { + $envFilePath = Join-Path $PSScriptRoot '..\$envFile' +} +$env = @{} +if (Test-Path -Path $envFilePath) { + $env = Get-Content (Join-Path $PSScriptRoot $envFile) | ConvertFrom-Json + $PSDefaultParameterValues=@{"*:Tenant"=$env.Tenant} +} \ No newline at end of file diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/test/utils.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/test/utils.ps1 new file mode 100644 index 000000000000..f8497fbd7da0 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/test/utils.ps1 @@ -0,0 +1,56 @@ +function RandomString([bool]$allChars, [int32]$len) { + if ($allChars) { + return -join ((33..126) | Get-Random -Count $len | % {[char]$_}) + } else { + return -join ((48..57) + (97..122) | Get-Random -Count $len | % {[char]$_}) + } +} +function Start-TestSleep { + [CmdletBinding(DefaultParameterSetName = 'SleepBySeconds')] + param( + [parameter(Mandatory = $true, Position = 0, ParameterSetName = 'SleepBySeconds')] + [ValidateRange(0.0, 2147483.0)] + [double] $Seconds, + + [parameter(Mandatory = $true, ParameterSetName = 'SleepByMilliseconds')] + [ValidateRange('NonNegative')] + [Alias('ms')] + [int] $Milliseconds + ) + + if ($TestMode -ne 'playback') { + switch ($PSCmdlet.ParameterSetName) { + 'SleepBySeconds' { + Start-Sleep -Seconds $Seconds + } + 'SleepByMilliseconds' { + Start-Sleep -Milliseconds $Milliseconds + } + } + } +} + +$env = @{} +if ($UsePreviousConfigForRecord) { + $previousEnv = Get-Content (Join-Path $PSScriptRoot 'env.json') | ConvertFrom-Json + $previousEnv.psobject.properties | Foreach-Object { $env[$_.Name] = $_.Value } +} +# Add script method called AddWithCache to $env, when useCache is set true, it will try to get the value from the $env first. +# example: $val = $env.AddWithCache('key', $val, $true) +$env | Add-Member -Type ScriptMethod -Value { param( [string]$key, [object]$val, [bool]$useCache) if ($this.Contains($key) -and $useCache) { return $this[$key] } else { $this[$key] = $val; return $val } } -Name 'AddWithCache' +function setupEnv() { + # Preload subscriptionId and tenant from context, which will be used in test + # as default. You could change them if needed. + $env.SubscriptionId = (Get-AzContext).Subscription.Id + $env.Tenant = (Get-AzContext).Tenant.Id + # For any resources you created for test, you should add it to $env here. + $envFile = 'env.json' + if ($TestMode -eq 'live') { + $envFile = 'localEnv.json' + } + set-content -Path (Join-Path $PSScriptRoot $envFile) -Value (ConvertTo-Json $env) +} +function cleanupEnv() { + # Clean resources you create for testing +} + diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 new file mode 100644 index 000000000000..5319862d3372 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 @@ -0,0 +1,7 @@ +param() +if ($env:AzPSAutorestTestPlaybackMode) { + $loadEnvPath = Join-Path $PSScriptRoot '..' 'test' 'loadEnv.ps1' + . ($loadEnvPath) + return $env.SubscriptionId +} +return (Get-AzContext).Subscription.Id \ No newline at end of file diff --git a/src/PureStorageBlock/PureStorageBlock.Autorest/utils/Unprotect-SecureString.ps1 b/src/PureStorageBlock/PureStorageBlock.Autorest/utils/Unprotect-SecureString.ps1 new file mode 100644 index 000000000000..cb05b51a6220 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.Autorest/utils/Unprotect-SecureString.ps1 @@ -0,0 +1,16 @@ +#This script converts securestring to plaintext + +param( + [Parameter(Mandatory, ValueFromPipeline)] + [System.Security.SecureString] + ${SecureString} +) + +$ssPtr = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($SecureString) +try { + $plaintext = [System.Runtime.InteropServices.Marshal]::PtrToStringBSTR($ssPtr) +} finally { + [System.Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ssPtr) +} + +return $plaintext \ No newline at end of file diff --git a/src/PureStorageBlock/PureStorageBlock.sln b/src/PureStorageBlock/PureStorageBlock.sln new file mode 100644 index 000000000000..f1e85996d9cd --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock.sln @@ -0,0 +1,74 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31903.59 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Accounts", "Accounts", "{1C36342E-6569-4840-94A9-A9EF5A76E6D5}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Accounts", "..\Accounts\Accounts\Accounts.csproj", "{84621752-BF9A-4689-B54F-6040474CCCA5}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssemblyLoading", "..\Accounts\AssemblyLoading\AssemblyLoading.csproj", "{1BB9269A-F8AF-4983-B191-9495BE03777C}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication", "..\Accounts\Authentication\Authentication.csproj", "{C150D4E4-65FC-4C98-811A-5CB6006AD71D}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication.ResourceManager", "..\Accounts\Authentication.ResourceManager\Authentication.ResourceManager.csproj", "{49BA6D1B-EA4A-43CC-831E-FE5CCBFEEC8D}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AuthenticationAssemblyLoadContext", "..\Accounts\AuthenticationAssemblyLoadContext\AuthenticationAssemblyLoadContext.csproj", "{59A10BA8-F3B4-4C72-B284-0F83BA2512E1}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authenticators", "..\Accounts\Authenticators\Authenticators.csproj", "{3E4C2C1C-1BE2-4599-A683-046EDD884AE5}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PureStorageBlock", "PureStorageBlock\PureStorageBlock.csproj", "{19E54104-D16D-4EE8-B996-94A62F32094E}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.PureStorageBlock", "PureStorageBlock.Autorest\Az.PureStorageBlock.csproj", "{B57BD0D2-5BFE-4745-A7D9-7516A614015C}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {84621752-BF9A-4689-B54F-6040474CCCA5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {84621752-BF9A-4689-B54F-6040474CCCA5}.Debug|Any CPU.Build.0 = Debug|Any CPU + {84621752-BF9A-4689-B54F-6040474CCCA5}.Release|Any CPU.ActiveCfg = Release|Any CPU + {84621752-BF9A-4689-B54F-6040474CCCA5}.Release|Any CPU.Build.0 = Release|Any CPU + {1BB9269A-F8AF-4983-B191-9495BE03777C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {1BB9269A-F8AF-4983-B191-9495BE03777C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1BB9269A-F8AF-4983-B191-9495BE03777C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {1BB9269A-F8AF-4983-B191-9495BE03777C}.Release|Any CPU.Build.0 = Release|Any CPU + {C150D4E4-65FC-4C98-811A-5CB6006AD71D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {C150D4E4-65FC-4C98-811A-5CB6006AD71D}.Debug|Any CPU.Build.0 = Debug|Any CPU + {C150D4E4-65FC-4C98-811A-5CB6006AD71D}.Release|Any CPU.ActiveCfg = Release|Any CPU + {C150D4E4-65FC-4C98-811A-5CB6006AD71D}.Release|Any CPU.Build.0 = Release|Any CPU + {49BA6D1B-EA4A-43CC-831E-FE5CCBFEEC8D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {49BA6D1B-EA4A-43CC-831E-FE5CCBFEEC8D}.Debug|Any CPU.Build.0 = Debug|Any CPU + {49BA6D1B-EA4A-43CC-831E-FE5CCBFEEC8D}.Release|Any CPU.ActiveCfg = Release|Any CPU + {49BA6D1B-EA4A-43CC-831E-FE5CCBFEEC8D}.Release|Any CPU.Build.0 = Release|Any CPU + {59A10BA8-F3B4-4C72-B284-0F83BA2512E1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {59A10BA8-F3B4-4C72-B284-0F83BA2512E1}.Debug|Any CPU.Build.0 = Debug|Any CPU + {59A10BA8-F3B4-4C72-B284-0F83BA2512E1}.Release|Any CPU.ActiveCfg = Release|Any CPU + {59A10BA8-F3B4-4C72-B284-0F83BA2512E1}.Release|Any CPU.Build.0 = Release|Any CPU + {3E4C2C1C-1BE2-4599-A683-046EDD884AE5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {3E4C2C1C-1BE2-4599-A683-046EDD884AE5}.Debug|Any CPU.Build.0 = Debug|Any CPU + {3E4C2C1C-1BE2-4599-A683-046EDD884AE5}.Release|Any CPU.ActiveCfg = Release|Any CPU + {3E4C2C1C-1BE2-4599-A683-046EDD884AE5}.Release|Any CPU.Build.0 = Release|Any CPU + {19E54104-D16D-4EE8-B996-94A62F32094E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {19E54104-D16D-4EE8-B996-94A62F32094E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {19E54104-D16D-4EE8-B996-94A62F32094E}.Release|Any CPU.ActiveCfg = Release|Any CPU + {19E54104-D16D-4EE8-B996-94A62F32094E}.Release|Any CPU.Build.0 = Release|Any CPU + {B57BD0D2-5BFE-4745-A7D9-7516A614015C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B57BD0D2-5BFE-4745-A7D9-7516A614015C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B57BD0D2-5BFE-4745-A7D9-7516A614015C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B57BD0D2-5BFE-4745-A7D9-7516A614015C}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {84621752-BF9A-4689-B54F-6040474CCCA5} = {1C36342E-6569-4840-94A9-A9EF5A76E6D5} + {1BB9269A-F8AF-4983-B191-9495BE03777C} = {1C36342E-6569-4840-94A9-A9EF5A76E6D5} + {C150D4E4-65FC-4C98-811A-5CB6006AD71D} = {1C36342E-6569-4840-94A9-A9EF5A76E6D5} + {49BA6D1B-EA4A-43CC-831E-FE5CCBFEEC8D} = {1C36342E-6569-4840-94A9-A9EF5A76E6D5} + {59A10BA8-F3B4-4C72-B284-0F83BA2512E1} = {1C36342E-6569-4840-94A9-A9EF5A76E6D5} + {3E4C2C1C-1BE2-4599-A683-046EDD884AE5} = {1C36342E-6569-4840-94A9-A9EF5A76E6D5} + EndGlobalSection +EndGlobal diff --git a/src/PureStorageBlock/PureStorageBlock/Az.PureStorageBlock.psd1 b/src/PureStorageBlock/PureStorageBlock/Az.PureStorageBlock.psd1 new file mode 100644 index 000000000000..ed6247276144 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/Az.PureStorageBlock.psd1 @@ -0,0 +1,159 @@ +# +# Module manifest for module 'Az.PureStorageBlock' +# +# Generated by: Microsoft Corporation +# +# Generated on: 7/12/2025 +# + +@{ + +# Script module or binary module file associated with this manifest. +# RootModule = '' + +# Version number of this module. +ModuleVersion = '0.1.0' + +# Supported PSEditions +CompatiblePSEditions = 'Core', 'Desktop' + +# ID used to uniquely identify this module +GUID = 'accceef6-8113-453a-a31c-4f2ce57893d6' + +# Author of this module +Author = 'Microsoft Corporation' + +# Company or vendor of this module +CompanyName = 'Microsoft Corporation' + +# Copyright statement for this module +Copyright = 'Microsoft Corporation. All rights reserved.' + +# Description of the functionality provided by this module +Description = 'Microsoft Azure PowerShell: PureStorageBlock cmdlets' + +# Minimum version of the PowerShell engine required by this module +PowerShellVersion = '5.1' + +# Name of the PowerShell host required by this module +# PowerShellHostName = '' + +# Minimum version of the PowerShell host required by this module +# PowerShellHostVersion = '' + +# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +DotNetFrameworkVersion = '4.7.2' + +# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +# ClrVersion = '' + +# Processor architecture (None, X86, Amd64) required by this module +# ProcessorArchitecture = '' + +# Modules that must be imported into the global environment prior to importing this module +RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '5.1.1'; }) + +# Assemblies that must be loaded prior to importing this module +RequiredAssemblies = 'PureStorageBlock.Autorest/bin/Az.PureStorageBlock.private.dll' + +# Script files (.ps1) that are run in the caller's environment prior to importing this module. +ScriptsToProcess = @() + +# Type files (.ps1xml) to be loaded when importing this module +TypesToProcess = @() + +# Format files (.ps1xml) to be loaded when importing this module +FormatsToProcess = 'PureStorageBlock.Autorest/Az.PureStorageBlock.format.ps1xml' + +# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess +NestedModules = @('PureStorageBlock.Autorest/Az.PureStorageBlock.psm1') + +# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. +FunctionsToExport = 'Disable-AzPureStorageBlockStoragePoolAvConnection', + 'Enable-AzPureStorageBlockStoragePoolAvConnection', + 'Get-AzPureStorageBlockAvsStorageContainer', + 'Get-AzPureStorageBlockAvsStorageContainerVolume', + 'Get-AzPureStorageBlockAvsVM', 'Get-AzPureStorageBlockAvsVMVolume', + 'Get-AzPureStorageBlockReservation', + 'Get-AzPureStorageBlockReservationBillingReport', + 'Get-AzPureStorageBlockReservationBillingStatus', + 'Get-AzPureStorageBlockReservationResourceLimit', + 'Get-AzPureStorageBlockStoragePool', + 'Get-AzPureStorageBlockStoragePoolAvConnection', + 'Get-AzPureStorageBlockStoragePoolAvStatus', + 'Get-AzPureStorageBlockStoragePoolHealthStatus', + 'Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection', + 'New-AzPureStorageBlockReservation', + 'New-AzPureStorageBlockStoragePool', + 'Remove-AzPureStorageBlockAvsStorageContainer', + 'Remove-AzPureStorageBlockAvsStorageContainerVolume', + 'Remove-AzPureStorageBlockAvsVM', + 'Remove-AzPureStorageBlockAvsVMVolume', + 'Remove-AzPureStorageBlockReservation', + 'Remove-AzPureStorageBlockStoragePool', + 'Repair-AzPureStorageBlockStoragePoolAvConnection', + 'Update-AzPureStorageBlockAvsStorageContainerVolume', + 'Update-AzPureStorageBlockAvsVM', + 'Update-AzPureStorageBlockAvsVMVolume', + 'Update-AzPureStorageBlockReservation', + 'Update-AzPureStorageBlockStoragePool' + +# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. +CmdletsToExport = @() + +# Variables to export from this module +# VariablesToExport = @() + +# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. +AliasesToExport = @() + +# DSC resources to export from this module +# DscResourcesToExport = @() + +# List of all modules packaged with this module +# ModuleList = @() + +# List of all files packaged with this module +# FileList = @() + +# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. +PrivateData = @{ + + PSData = @{ + + # Tags applied to this module. These help with module discovery in online galleries. + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'PureStorageBlock' + + # A URL to the license for this module. + LicenseUri = 'https://aka.ms/azps-license' + + # A URL to the main website for this project. + ProjectUri = 'https://github.com/Azure/azure-powershell' + + # A URL to an icon representing this module. + # IconUri = '' + + # ReleaseNotes of this module + # ReleaseNotes = '' + + # Prerelease string of this module + # Prerelease = '' + + # Flag to indicate whether the module requires explicit user acceptance for install/update/save + # RequireLicenseAcceptance = $false + + # External dependent modules of this module + # ExternalModuleDependencies = @() + + } # End of PSData hashtable + +} # End of PrivateData hashtable + +# HelpInfo URI of this module +# HelpInfoURI = '' + +# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. +# DefaultCommandPrefix = '' + +} + diff --git a/src/PureStorageBlock/PureStorageBlock/ChangeLog.md b/src/PureStorageBlock/PureStorageBlock/ChangeLog.md new file mode 100644 index 000000000000..be233f69fc84 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/ChangeLog.md @@ -0,0 +1,24 @@ + +## Upcoming Release + +## Version 0.1.0 +* First preview release for module Az.PureStorageBlock + diff --git a/src/PureStorageBlock/PureStorageBlock/Properties/AssemblyInfo.cs b/src/PureStorageBlock/PureStorageBlock/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..8c2fad277e5f --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/Properties/AssemblyInfo.cs @@ -0,0 +1,28 @@ +// ---------------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------------- + +using System; +using System.Reflection; +using System.Runtime.InteropServices; + +[assembly: AssemblyTitle("Microsoft Azure Powershell - PureStorageBlock")] +[assembly: AssemblyCompany(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyCompany)] +[assembly: AssemblyProduct(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyProduct)] +[assembly: AssemblyCopyright(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyCopyright)] + +[assembly: ComVisible(false)] +[assembly: CLSCompliant(false)] +[assembly: Guid("8f59a82f-bd44-425d-b274-9f8d4b564b44")] +[assembly: AssemblyVersion("0.1.0")] +[assembly: AssemblyFileVersion("0.1.0")] diff --git a/src/PureStorageBlock/PureStorageBlock/PureStorageBlock.csproj b/src/PureStorageBlock/PureStorageBlock/PureStorageBlock.csproj new file mode 100644 index 000000000000..f9f3eea9f971 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/PureStorageBlock.csproj @@ -0,0 +1,28 @@ + + + + + + + PureStorageBlock + + + + netstandard2.0 + $(AzAssemblyPrefix)$(PsModuleName) + $(AzAssemblyPrefix)$(PsModuleName) + true + false + $(RepoArtifacts)$(Configuration)\Az.$(PsModuleName)\ + $(OutputPath) + + + + + + + + + + + diff --git a/src/PureStorageBlock/PureStorageBlock/help/Az.PureStorageBlock.md b/src/PureStorageBlock/PureStorageBlock/help/Az.PureStorageBlock.md new file mode 100644 index 000000000000..8cefd4806046 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Az.PureStorageBlock.md @@ -0,0 +1,100 @@ +--- +Module Name: Az.PureStorageBlock +Module Guid: accceef6-8113-453a-a31c-4f2ce57893d6 +Download Help Link: https://learn.microsoft.com/powershell/module/az.purestorageblock +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.PureStorageBlock Module +## Description +Microsoft Azure PowerShell: PureStorageBlock cmdlets + +## Az.PureStorageBlock Cmdlets +### [Disable-AzPureStorageBlockStoragePoolAvConnection](Disable-AzPureStorageBlockStoragePoolAvConnection.md) +Disable the existing AVS connection + +### [Enable-AzPureStorageBlockStoragePoolAvConnection](Enable-AzPureStorageBlockStoragePoolAvConnection.md) +Initiate a connection between the storage pool and a specified AVS SDDC resource + +### [Get-AzPureStorageBlockAvsStorageContainer](Get-AzPureStorageBlockAvsStorageContainer.md) +Get an AVS storage container + +### [Get-AzPureStorageBlockAvsStorageContainerVolume](Get-AzPureStorageBlockAvsStorageContainerVolume.md) +Get a volume in an AVS storage container + +### [Get-AzPureStorageBlockAvsVM](Get-AzPureStorageBlockAvsVM.md) +Get an AVS VM + +### [Get-AzPureStorageBlockAvsVMVolume](Get-AzPureStorageBlockAvsVMVolume.md) +Get a volume in an AVS VM + +### [Get-AzPureStorageBlockReservation](Get-AzPureStorageBlockReservation.md) +Get a reservation + +### [Get-AzPureStorageBlockReservationBillingReport](Get-AzPureStorageBlockReservationBillingReport.md) +Provides a summarized report along with actions for resources billed via given reservation + +### [Get-AzPureStorageBlockReservationBillingStatus](Get-AzPureStorageBlockReservationBillingStatus.md) +Provides various statistics about resources billed via given reservation. + +### [Get-AzPureStorageBlockReservationResourceLimit](Get-AzPureStorageBlockReservationResourceLimit.md) +Limits constraining certain resource properties. + +### [Get-AzPureStorageBlockStoragePool](Get-AzPureStorageBlockStoragePool.md) +Get a storage pool + +### [Get-AzPureStorageBlockStoragePoolAvConnection](Get-AzPureStorageBlockStoragePoolAvConnection.md) +Returns current information about an on-going connection to an AVS instance + +### [Get-AzPureStorageBlockStoragePoolAvStatus](Get-AzPureStorageBlockStoragePoolAvStatus.md) +Returns the status of the storage pool connection to AVS + +### [Get-AzPureStorageBlockStoragePoolHealthStatus](Get-AzPureStorageBlockStoragePoolHealthStatus.md) +Retrieve health metrics of a storage pool + +### [Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection](Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.md) +Finalize an already started AVS connection to a specific AVS SDDC + +### [New-AzPureStorageBlockReservation](New-AzPureStorageBlockReservation.md) +Create a reservation + +### [New-AzPureStorageBlockStoragePool](New-AzPureStorageBlockStoragePool.md) +Create a storage pool + +### [Remove-AzPureStorageBlockAvsStorageContainer](Remove-AzPureStorageBlockAvsStorageContainer.md) +Delete an AVS storage container + +### [Remove-AzPureStorageBlockAvsStorageContainerVolume](Remove-AzPureStorageBlockAvsStorageContainerVolume.md) +Delete a volume in an AVS storage container + +### [Remove-AzPureStorageBlockAvsVM](Remove-AzPureStorageBlockAvsVM.md) +Delete an AVS VM + +### [Remove-AzPureStorageBlockAvsVMVolume](Remove-AzPureStorageBlockAvsVMVolume.md) +Delete a volume in an AVS VM + +### [Remove-AzPureStorageBlockReservation](Remove-AzPureStorageBlockReservation.md) +Delete a reservation + +### [Remove-AzPureStorageBlockStoragePool](Remove-AzPureStorageBlockStoragePool.md) +Delete a storage pool + +### [Repair-AzPureStorageBlockStoragePoolAvConnection](Repair-AzPureStorageBlockStoragePoolAvConnection.md) +Test and repair, if needed, all configuration elements of the storage pool connection to the AVS instance + +### [Update-AzPureStorageBlockAvsStorageContainerVolume](Update-AzPureStorageBlockAvsStorageContainerVolume.md) +Update a volume in an AVS storage container + +### [Update-AzPureStorageBlockAvsVM](Update-AzPureStorageBlockAvsVM.md) +Update an AVS VM + +### [Update-AzPureStorageBlockAvsVMVolume](Update-AzPureStorageBlockAvsVMVolume.md) +Update a volume in an AVS VM + +### [Update-AzPureStorageBlockReservation](Update-AzPureStorageBlockReservation.md) +Update a reservation + +### [Update-AzPureStorageBlockStoragePool](Update-AzPureStorageBlockStoragePool.md) +Update a storage pool + diff --git a/src/PureStorageBlock/PureStorageBlock/help/Disable-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock/help/Disable-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..b0919b741834 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Disable-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,224 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/disable-azpurestorageblockstoragepoolavconnection +schema: 2.0.0 +--- + +# Disable-AzPureStorageBlockStoragePoolAvConnection + +## SYNOPSIS +Disable the existing AVS connection + +## SYNTAX + +### Disable (Default) +``` +Disable-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### DisableViaIdentity +``` +Disable-AzPureStorageBlockStoragePoolAvConnection -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Disable the existing AVS connection + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DisableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Disable +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Enable-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock/help/Enable-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..ce9e5c912eb6 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Enable-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,315 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/enable-azpurestorageblockstoragepoolavconnection +schema: 2.0.0 +--- + +# Enable-AzPureStorageBlockStoragePoolAvConnection + +## SYNOPSIS +Initiate a connection between the storage pool and a specified AVS SDDC resource + +## SYNTAX + +### EnableExpanded (Default) +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -SddcResourceId [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### EnableViaJsonString +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### EnableViaJsonFilePath +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### Enable +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -Property [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### EnableViaIdentityExpanded +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -InputObject + -SddcResourceId [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### EnableViaIdentity +``` +Enable-AzPureStorageBlockStoragePoolAvConnection -InputObject + -Property [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Initiate a connection between the storage pool and a specified AVS SDDC resource + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: EnableViaIdentityExpanded, EnableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Enable operation + +```yaml +Type: System.String +Parameter Sets: EnableViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Enable operation + +```yaml +Type: System.String +Parameter Sets: EnableViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +EnableAvsConnection payload information + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePoolEnableAvsConnectionPost +Parameter Sets: Enable, EnableViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: EnableExpanded, EnableViaJsonString, EnableViaJsonFilePath, Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SddcResourceId +Azure resource ID of the AVS SDDC to connect to + +```yaml +Type: System.String +Parameter Sets: EnableExpanded, EnableViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: EnableExpanded, EnableViaJsonString, EnableViaJsonFilePath, Enable +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: EnableExpanded, EnableViaJsonString, EnableViaJsonFilePath, Enable +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePoolEnableAvsConnectionPost + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsStorageContainer.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsStorageContainer.md new file mode 100644 index 000000000000..fab21b6bce2c --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsStorageContainer.md @@ -0,0 +1,189 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsstoragecontainer +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockAvsStorageContainer + +## SYNOPSIS +Get an AVS storage container + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockAvsStorageContainer -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPureStorageBlockAvsStorageContainer -ResourceGroupName -StorageContainerName + -StoragePoolName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentityStoragePool +``` +Get-AzPureStorageBlockAvsStorageContainer -StorageContainerName + -StoragePoolInputObject [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockAvsStorageContainer -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get an AVS storage container + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the storage container + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsStorageContainer + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsStorageContainerVolume.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsStorageContainerVolume.md new file mode 100644 index 000000000000..030584bb99ad --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsStorageContainerVolume.md @@ -0,0 +1,226 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsstoragecontainervolume +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockAvsStorageContainerVolume + +## SYNOPSIS +Get a volume in an AVS storage container + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName [-SubscriptionId ] -VolumeId [-DefaultProfile ] + [] +``` + +### GetViaIdentityStoragePool +``` +Get-AzPureStorageBlockAvsStorageContainerVolume -StorageContainerName -VolumeId + -StoragePoolInputObject [-DefaultProfile ] [] +``` + +### GetViaIdentityAvsStorageContainer +``` +Get-AzPureStorageBlockAvsStorageContainerVolume -VolumeId + -AvsStorageContainerInputObject [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockAvsStorageContainerVolume -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a volume in an AVS storage container + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AvsStorageContainerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityAvsStorageContainer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the storage container + +```yaml +Type: System.String +Parameter Sets: List, Get, GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the storage container + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityStoragePool, GetViaIdentityAvsStorageContainer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsStorageContainerVolume + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsVM.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsVM.md new file mode 100644 index 000000000000..e59d4f5fcf11 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsVM.md @@ -0,0 +1,189 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsvm +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockAvsVM + +## SYNOPSIS +Get an AVS VM + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockAvsVM -ResourceGroupName -StoragePoolName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentityStoragePool +``` +Get-AzPureStorageBlockAvsVM -Id -StoragePoolInputObject + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPureStorageBlockAvsVM -Id -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockAvsVM -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityStoragePool, Get +Aliases: AvsVMId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsVM + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsVMVolume.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsVMVolume.md new file mode 100644 index 000000000000..6dc660bec8f3 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockAvsVMVolume.md @@ -0,0 +1,225 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockavsvmvolume +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockAvsVMVolume + +## SYNOPSIS +Get a volume in an AVS VM + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentityStoragePool +``` +Get-AzPureStorageBlockAvsVMVolume -AvsVMId -VolumeId + -StoragePoolInputObject [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -VolumeId [-DefaultProfile ] [] +``` + +### GetViaIdentityAvsVM +``` +Get-AzPureStorageBlockAvsVMVolume -VolumeId -AvsVMInputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockAvsVMVolume -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get a volume in an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AvsVMId +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: List, GetViaIdentityStoragePool, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsVMInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityAvsVM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the AVS VM + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityStoragePool, Get, GetViaIdentityAvsVM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsVMVolume + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..494954fc91e5 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservation.md @@ -0,0 +1,159 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservation +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockReservation + +## SYNOPSIS +Get a reservation + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockReservation [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPureStorageBlockReservation -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzPureStorageBlockReservation -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockReservation -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get a reservation + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ReservationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IReservation + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservationBillingReport.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservationBillingReport.md new file mode 100644 index 000000000000..cc509dee0836 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservationBillingReport.md @@ -0,0 +1,178 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservationbillingreport +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockReservationBillingReport + +## SYNOPSIS +Provides a summarized report along with actions for resources billed via given reservation + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockReservationBillingReport -ReservationName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockReservationBillingReport -InputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Provides a summarized report along with actions for resources billed via given reservation + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReservationName +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IReservationBillingUsageReport + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservationBillingStatus.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservationBillingStatus.md new file mode 100644 index 000000000000..7890100e2337 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservationBillingStatus.md @@ -0,0 +1,178 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservationbillingstatus +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockReservationBillingStatus + +## SYNOPSIS +Provides various statistics about resources billed via given reservation. + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockReservationBillingStatus -ReservationName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockReservationBillingStatus -InputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Provides various statistics about resources billed via given reservation. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReservationName +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IReservationBillingStatus + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservationResourceLimit.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservationResourceLimit.md new file mode 100644 index 000000000000..83f9df7079a5 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockReservationResourceLimit.md @@ -0,0 +1,178 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockreservationresourcelimit +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockReservationResourceLimit + +## SYNOPSIS +Limits constraining certain resource properties. + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockReservationResourceLimit -ReservationName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockReservationResourceLimit -InputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Limits constraining certain resource properties. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ReservationName +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.ILimitDetails + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..9068d446feae --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePool.md @@ -0,0 +1,159 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepool +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockStoragePool + +## SYNOPSIS +Get a storage pool + +## SYNTAX + +### List (Default) +``` +Get-AzPureStorageBlockStoragePool [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPureStorageBlockStoragePool -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzPureStorageBlockStoragePool -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockStoragePool -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get a storage pool + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: StoragePoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePool + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..ee1a6f15cbbd --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,178 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepoolavconnection +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockStoragePoolAvConnection + +## SYNOPSIS +Returns current information about an on-going connection to an AVS instance + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockStoragePoolAvConnection -InputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Returns current information about an on-going connection to an AVS instance + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsConnection + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePoolAvStatus.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePoolAvStatus.md new file mode 100644 index 000000000000..394652d9c270 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePoolAvStatus.md @@ -0,0 +1,178 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepoolavstatus +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockStoragePoolAvStatus + +## SYNOPSIS +Returns the status of the storage pool connection to AVS + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockStoragePoolAvStatus -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockStoragePoolAvStatus -InputObject [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Returns the status of the storage pool connection to AVS + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsStatus + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePoolHealthStatus.md b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePoolHealthStatus.md new file mode 100644 index 000000000000..16e6057004d3 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Get-AzPureStorageBlockStoragePoolHealthStatus.md @@ -0,0 +1,178 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/get-azpurestorageblockstoragepoolhealthstatus +schema: 2.0.0 +--- + +# Get-AzPureStorageBlockStoragePoolHealthStatus + +## SYNOPSIS +Retrieve health metrics of a storage pool + +## SYNTAX + +### Get (Default) +``` +Get-AzPureStorageBlockStoragePoolHealthStatus -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### GetViaIdentity +``` +Get-AzPureStorageBlockStoragePoolHealthStatus -InputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Retrieve health metrics of a storage pool + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IHealthResponse + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock/help/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.md new file mode 100644 index 000000000000..078a587a4094 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection.md @@ -0,0 +1,380 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/invoke-azpurestorageblockfinalizestoragepoolavconnection +schema: 2.0.0 +--- + +# Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection + +## SYNOPSIS +Finalize an already started AVS connection to a specific AVS SDDC + +## SYNTAX + +### FinalizeExpanded (Default) +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-ServiceInitializationDataEnc ] + [-ServiceInitializationDataServiceAccountPassword ] + [-ServiceInitializationDataServiceAccountUsername ] + [-ServiceInitializationDataVSphereCertificate ] [-ServiceInitializationDataVSphereIP ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### FinalizeViaJsonString +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### FinalizeViaJsonFilePath +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### Finalize +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -Property [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### FinalizeViaIdentityExpanded +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -InputObject + [-ServiceInitializationDataEnc ] [-ServiceInitializationDataServiceAccountPassword ] + [-ServiceInitializationDataServiceAccountUsername ] + [-ServiceInitializationDataVSphereCertificate ] [-ServiceInitializationDataVSphereIP ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### FinalizeViaIdentity +``` +Invoke-AzPureStorageBlockFinalizeStoragePoolAvConnection -InputObject + -Property [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Finalize an already started AVS connection to a specific AVS SDDC + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: FinalizeViaIdentityExpanded, FinalizeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Finalize operation + +```yaml +Type: System.String +Parameter Sets: FinalizeViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Finalize operation + +```yaml +Type: System.String +Parameter Sets: FinalizeViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property +FinalizeAvsConnection payload information, either encoded or explicit + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePoolFinalizeAvsConnectionPost +Parameter Sets: Finalize, FinalizeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: FinalizeExpanded, FinalizeViaJsonString, FinalizeViaJsonFilePath, Finalize +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceInitializationDataEnc +Encoded AVS connection information + +```yaml +Type: System.String +Parameter Sets: FinalizeExpanded, FinalizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceInitializationDataServiceAccountPassword +Service account password + +```yaml +Type: System.Security.SecureString +Parameter Sets: FinalizeExpanded, FinalizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceInitializationDataServiceAccountUsername +Service account username + +```yaml +Type: System.String +Parameter Sets: FinalizeExpanded, FinalizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceInitializationDataVSphereCertificate +AVS instance's vSphere certificate + +```yaml +Type: System.String +Parameter Sets: FinalizeExpanded, FinalizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceInitializationDataVSphereIP +AVS instance's vSphere IP address + +```yaml +Type: System.String +Parameter Sets: FinalizeExpanded, FinalizeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: FinalizeExpanded, FinalizeViaJsonString, FinalizeViaJsonFilePath, Finalize +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: FinalizeExpanded, FinalizeViaJsonString, FinalizeViaJsonFilePath, Finalize +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePoolFinalizeAvsConnectionPost + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/New-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock/help/New-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..c8107c8c5034 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/New-AzPureStorageBlockReservation.md @@ -0,0 +1,549 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/new-azpurestorageblockreservation +schema: 2.0.0 +--- + +# New-AzPureStorageBlockReservation + +## SYNOPSIS +Create a reservation + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPureStorageBlockReservation -Name -ResourceGroupName [-SubscriptionId ] + -Location [-AddressCity ] [-AddressCountry ] [-AddressLine1 ] + [-AddressLine2 ] [-AddressPostalCode ] [-AddressState ] + [-CompanyDetailCompanyName ] [-MarketplaceSubscriptionStatus ] [-OfferDetailOfferId ] + [-OfferDetailPlanId ] [-OfferDetailPlanName ] [-OfferDetailPublisherId ] + [-OfferDetailTermId ] [-OfferDetailTermUnit ] [-Tag ] [-UserEmailAddress ] + [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] [-UserUpn ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPureStorageBlockReservation -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonString +``` +New-AzPureStorageBlockReservation -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a reservation + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AddressCity +Name of the city + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressCountry +Name of the country + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressLine1 +Address line 1 + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressLine2 +Address line 2 + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressPostalCode +Postal code + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressState +State (if any) + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyDetailCompanyName +Company name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MarketplaceSubscriptionStatus +Marketplace subscription status + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ReservationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailOfferId +Offer ID for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanId +Plan ID for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPlanName +Plan Name for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailPublisherId +Publisher ID for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermId +Term ID for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfferDetailTermUnit +Term Unit for the marketplace offer + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email address + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +Phone number + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserUpn +Principal name + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IReservation + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/New-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock/help/New-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..8ea70f75b841 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/New-AzPureStorageBlockStoragePool.md @@ -0,0 +1,367 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/new-azpurestorageblockstoragepool +schema: 2.0.0 +--- + +# New-AzPureStorageBlockStoragePool + +## SYNOPSIS +Create a storage pool + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPureStorageBlockStoragePool -Name -ResourceGroupName [-SubscriptionId ] + -Location [-AvailabilityZone ] [-EnableSystemAssignedIdentity] + [-ProvisionedBandwidthMbPerSec ] [-ReservationResourceId ] [-Tag ] + [-UserAssignedIdentity ] [-VnetInjectionSubnetId ] [-VnetInjectionVnetId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPureStorageBlockStoragePool -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonString +``` +New-AzPureStorageBlockStoragePool -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a storage pool + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityZone +Azure Availability Zone the Pool is located in + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StoragePoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisionedBandwidthMbPerSec +Total bandwidth provisioned for the pool, in MB/s + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservationResourceId +Azure resource ID of the Pure Storage Cloud service (reservation resource) this storage pool belongs to + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetInjectionSubnetId +Azure resource ID of the Virtual Network subnet where the storage pool will be connected + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VnetInjectionVnetId +Azure resource ID of the Virtual Network in which the subnet is located + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePool + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsStorageContainer.md b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsStorageContainer.md new file mode 100644 index 000000000000..f13a36240b38 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsStorageContainer.md @@ -0,0 +1,261 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsstoragecontainer +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockAvsStorageContainer + +## SYNOPSIS +Delete an AVS storage container + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockAvsStorageContainer -ResourceGroupName -StorageContainerName + -StoragePoolName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityStoragePool +``` +Remove-AzPureStorageBlockAvsStorageContainer -StorageContainerName + -StoragePoolInputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockAvsStorageContainer -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete an AVS storage container + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the storage container + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsStorageContainerVolume.md b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsStorageContainerVolume.md new file mode 100644 index 000000000000..ea8793b41726 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsStorageContainerVolume.md @@ -0,0 +1,298 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsstoragecontainervolume +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockAvsStorageContainerVolume + +## SYNOPSIS +Delete a volume in an AVS storage container + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName [-SubscriptionId ] -VolumeId [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityStoragePool +``` +Remove-AzPureStorageBlockAvsStorageContainerVolume -StorageContainerName -VolumeId + -StoragePoolInputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityAvsStorageContainer +``` +Remove-AzPureStorageBlockAvsStorageContainerVolume -VolumeId + -AvsStorageContainerInputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockAvsStorageContainerVolume -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a volume in an AVS storage container + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsStorageContainerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityAvsStorageContainer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the storage container + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the storage container + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStoragePool, DeleteViaIdentityAvsStorageContainer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsVM.md b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsVM.md new file mode 100644 index 000000000000..57f00ebbe9de --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsVM.md @@ -0,0 +1,260 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsvm +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockAvsVM + +## SYNOPSIS +Delete an AVS VM + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockAvsVM -Id -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### DeleteViaIdentityStoragePool +``` +Remove-AzPureStorageBlockAvsVM -Id -StoragePoolInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockAvsVM -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStoragePool +Aliases: AvsVMId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsVMVolume.md b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsVMVolume.md new file mode 100644 index 000000000000..3c243e6d4aad --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockAvsVMVolume.md @@ -0,0 +1,297 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockavsvmvolume +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockAvsVMVolume + +## SYNOPSIS +Delete a volume in an AVS VM + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -VolumeId [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityStoragePool +``` +Remove-AzPureStorageBlockAvsVMVolume -AvsVMId -VolumeId + -StoragePoolInputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityAvsVM +``` +Remove-AzPureStorageBlockAvsVMVolume -VolumeId -AvsVMInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockAvsVMVolume -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a volume in an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsVMId +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsVMInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityAvsVM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentityStoragePool +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the AVS VM + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityStoragePool, DeleteViaIdentityAvsVM +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..6221ec836e59 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockReservation.md @@ -0,0 +1,223 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockreservation +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockReservation + +## SYNOPSIS +Delete a reservation + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockReservation -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockReservation -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a reservation + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ReservationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..7f363d748fb7 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Remove-AzPureStorageBlockStoragePool.md @@ -0,0 +1,223 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/remove-azpurestorageblockstoragepool +schema: 2.0.0 +--- + +# Remove-AzPureStorageBlockStoragePool + +## SYNOPSIS +Delete a storage pool + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPureStorageBlockStoragePool -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPureStorageBlockStoragePool -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Delete a storage pool + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: StoragePoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Repair-AzPureStorageBlockStoragePoolAvConnection.md b/src/PureStorageBlock/PureStorageBlock/help/Repair-AzPureStorageBlockStoragePoolAvConnection.md new file mode 100644 index 000000000000..c6476c34a217 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Repair-AzPureStorageBlockStoragePoolAvConnection.md @@ -0,0 +1,224 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/repair-azpurestorageblockstoragepoolavconnection +schema: 2.0.0 +--- + +# Repair-AzPureStorageBlockStoragePoolAvConnection + +## SYNOPSIS +Test and repair, if needed, all configuration elements of the storage pool connection to the AVS instance + +## SYNTAX + +### Repair (Default) +``` +Repair-AzPureStorageBlockStoragePoolAvConnection -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### RepairViaIdentity +``` +Repair-AzPureStorageBlockStoragePoolAvConnection -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Test and repair, if needed, all configuration elements of the storage pool connection to the AVS instance + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: RepairViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Repair +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: Repair +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Repair +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockAvsStorageContainerVolume.md b/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockAvsStorageContainerVolume.md new file mode 100644 index 000000000000..cb16d941b3d5 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockAvsStorageContainerVolume.md @@ -0,0 +1,343 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/update-azpurestorageblockavsstoragecontainervolume +schema: 2.0.0 +--- + +# Update-AzPureStorageBlockAvsStorageContainerVolume + +## SYNOPSIS +Update a volume in an AVS storage container + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName [-SubscriptionId ] -VolumeId [-SoftDeletionDestroyed] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonString +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName [-SubscriptionId ] -VolumeId -JsonString + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -ResourceGroupName -StorageContainerName + -StoragePoolName [-SubscriptionId ] -VolumeId -JsonFilePath + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityStoragePoolExpanded +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -StorageContainerName -VolumeId + -StoragePoolInputObject [-SoftDeletionDestroyed] [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityAvsStorageContainerExpanded +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -VolumeId + -AvsStorageContainerInputObject [-SoftDeletionDestroyed] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPureStorageBlockAvsStorageContainerVolume -InputObject + [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Update a volume in an AVS storage container + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsStorageContainerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityAvsStorageContainerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletionDestroyed +If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityStoragePoolExpanded, UpdateViaIdentityAvsStorageContainerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageContainerName +Name of the storage container + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityStoragePoolExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityStoragePoolExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the storage container + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityStoragePoolExpanded, UpdateViaIdentityAvsStorageContainerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsStorageContainerVolume + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockAvsVM.md b/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockAvsVM.md new file mode 100644 index 000000000000..6807ed648cc4 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockAvsVM.md @@ -0,0 +1,305 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/update-azpurestorageblockavsvm +schema: 2.0.0 +--- + +# Update-AzPureStorageBlockAvsVM + +## SYNOPSIS +Update an AVS VM + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPureStorageBlockAvsVM -Id -ResourceGroupName -StoragePoolName + [-SubscriptionId ] [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [] +``` + +### UpdateViaJsonString +``` +Update-AzPureStorageBlockAvsVM -Id -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPureStorageBlockAvsVM -Id -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] + [-Confirm] [] +``` + +### UpdateViaIdentityStoragePoolExpanded +``` +Update-AzPureStorageBlockAvsVM -Id -StoragePoolInputObject + [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPureStorageBlockAvsVM -InputObject [-SoftDeletionDestroyed] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityStoragePoolExpanded +Aliases: AvsVMId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletionDestroyed +If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityStoragePoolExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityStoragePoolExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsVM + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockAvsVMVolume.md b/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockAvsVMVolume.md new file mode 100644 index 000000000000..974f5876ad5d --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockAvsVMVolume.md @@ -0,0 +1,342 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/update-azpurestorageblockavsvmvolume +schema: 2.0.0 +--- + +# Update-AzPureStorageBlockAvsVMVolume + +## SYNOPSIS +Update a volume in an AVS VM + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -VolumeId [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonString +``` +Update-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -VolumeId -JsonString [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPureStorageBlockAvsVMVolume -AvsVMId -ResourceGroupName -StoragePoolName + [-SubscriptionId ] -VolumeId -JsonFilePath [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityStoragePoolExpanded +``` +Update-AzPureStorageBlockAvsVMVolume -AvsVMId -VolumeId + -StoragePoolInputObject [-SoftDeletionDestroyed] [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityAvsVMExpanded +``` +Update-AzPureStorageBlockAvsVMVolume -VolumeId -AvsVMInputObject + [-SoftDeletionDestroyed] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPureStorageBlockAvsVMVolume -InputObject [-SoftDeletionDestroyed] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a volume in an AVS VM + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsVMId +ID of the AVS VM + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityStoragePoolExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvsVMInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityAvsVMExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletionDestroyed +If false, the resource is active; if true, the resource has been destroyed; resources can be soft-deleted by setting destroyed to true, and recovered by setting it to false + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: UpdateExpanded, UpdateViaIdentityStoragePoolExpanded, UpdateViaIdentityAvsVMExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StoragePoolInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityStoragePoolExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -StoragePoolName +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeId +ID of the volume in the AVS VM + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityStoragePoolExpanded, UpdateViaIdentityAvsVMExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IAvsVMVolume + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockReservation.md b/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockReservation.md new file mode 100644 index 000000000000..e71d1d17e011 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockReservation.md @@ -0,0 +1,452 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/update-azpurestorageblockreservation +schema: 2.0.0 +--- + +# Update-AzPureStorageBlockReservation + +## SYNOPSIS +Update a reservation + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPureStorageBlockReservation -Name -ResourceGroupName [-SubscriptionId ] + [-AddressCity ] [-AddressCountry ] [-AddressLine1 ] [-AddressLine2 ] + [-AddressPostalCode ] [-AddressState ] [-CompanyDetailCompanyName ] [-Tag ] + [-UserEmailAddress ] [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] + [-UserUpn ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonString +``` +Update-AzPureStorageBlockReservation -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPureStorageBlockReservation -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPureStorageBlockReservation -InputObject [-AddressCity ] + [-AddressCountry ] [-AddressLine1 ] [-AddressLine2 ] [-AddressPostalCode ] + [-AddressState ] [-CompanyDetailCompanyName ] [-Tag ] [-UserEmailAddress ] + [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] [-UserUpn ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a reservation + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AddressCity +Name of the city + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressCountry +Name of the country + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressLine1 +Address line 1 + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressLine2 +Address line 2 + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressPostalCode +Postal code + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddressState +State (if any) + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompanyDetailCompanyName +Company name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the reservation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: ReservationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserEmailAddress +Email address + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserFirstName +First name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLastName +Last name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPhoneNumber +Phone number + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserUpn +Principal name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IReservation + +## NOTES + +## RELATED LINKS diff --git a/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockStoragePool.md b/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockStoragePool.md new file mode 100644 index 000000000000..f2fe21a5f9c6 --- /dev/null +++ b/src/PureStorageBlock/PureStorageBlock/help/Update-AzPureStorageBlockStoragePool.md @@ -0,0 +1,273 @@ +--- +external help file: Az.PureStorageBlock-help.xml +Module Name: Az.PureStorageBlock +online version: https://learn.microsoft.com/powershell/module/az.purestorageblock/update-azpurestorageblockstoragepool +schema: 2.0.0 +--- + +# Update-AzPureStorageBlockStoragePool + +## SYNOPSIS +Update a storage pool + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPureStorageBlockStoragePool -Name -ResourceGroupName [-SubscriptionId ] + [-EnableSystemAssignedIdentity ] [-ProvisionedBandwidthMbPerSec ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPureStorageBlockStoragePool -InputObject + [-EnableSystemAssignedIdentity ] [-ProvisionedBandwidthMbPerSec ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Update a storage pool + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the storage pool + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: StoragePoolName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProvisionedBandwidthMbPerSec +Total bandwidth provisioned for the pool, in MB/s + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IPureStorageBlockIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PureStorageBlock.Models.IStoragePool + +## NOTES + +## RELATED LINKS diff --git a/tools/CreateMappings_rules.json b/tools/CreateMappings_rules.json index c37f5ee38a18..02bc10b96662 100644 --- a/tools/CreateMappings_rules.json +++ b/tools/CreateMappings_rules.json @@ -987,5 +987,9 @@ { "alias": "CloudHsm", "module": "CloudHsm" + }, + { + "alias": "PureStorageBlock", + "module": "PureStorageBlock" } -] \ No newline at end of file +]