custom/Remove-AzStackHCIVmVirtualMachine_New.ps1
|
# ---------------------------------------------------------------------------------- # # 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. # ---------------------------------------------------------------------------------- <# .Synopsis The operation to delete a virtual machine. .Description The operation to delete a virtual machine. .Inputs Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.IStackHCIVMIdentity .Outputs System.Boolean .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <IStackHCIVMIdentity>: Identity Parameter [ExtensionName <String>]: The name of the machine extension. [GalleryImageName <String>]: Name of the gallery image [Id <String>]: Resource identity path [MarketplaceGalleryImageName <String>]: Name of the marketplace gallery image [MetadataName <String>]: Name of the hybridIdentityMetadata. [Name <String>]: The name of the machine where the extension should be created or updated. [NetworkInterfaceName <String>]: Name of the network interface [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive. [StorageContainerName <String>]: Name of the storage container [SubscriptionId <String>]: The ID of the target subscription. [VirtualHardDiskName <String>]: Name of the virtual hard disk [VirtualMachineName <String>]: Name of the virtual machine [VirtualNetworkName <String>]: Name of the virtual network .Link https://learn.microsoft.com/powershell/module/az.stackhcivm/remove-azstackhcivmvirtualmachine #> function Remove-AzStackHCIVMVirtualMachine { [OutputType([System.Boolean])] [CmdletBinding(PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='ByName',Mandatory)] [Alias('VirtualMachineName')] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Path')] [System.String] # Name of the virtual machine ${Name}, [Parameter(ParameterSetName='ByName',Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Path')] [System.String] # The name of the resource group. # The name is case insensitive. ${ResourceGroupName}, [Parameter(ParameterSetName='ByName')] [Parameter(ParameterSetName='ByResourceId')] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] [System.String] # The ID of the target subscription. ${SubscriptionId}, [Parameter(ParameterSetName='ByName')] [Parameter(ParameterSetName='ByResourceId')] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Path')] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.IStackHCIVMIdentity] # Identity Parameter # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter(ParameterSetName='ByResourceId',Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Path')] [System.String] # The ARM Resource ID of the virtual machine. ${ResourceId}, [Parameter(HelpMessage='Forces the cmdlet to remove the virtual machine without prompting for confirmation.')] [System.Management.Automation.SwitchParameter] ${Force}, [Parameter()] [Alias('AzureRMContext', 'AzureCredential')] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Azure')] [System.Management.Automation.PSObject] # The credentials, account, tenant, and subscription used for communication with Azure. ${DefaultProfile}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Run the command as a job ${AsJob}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Runtime')] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Run the command asynchronously ${NoWait}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) process { Write-Warning("Running this command will delete the virtual machine.") if ($Force -or $PSCmdlet.ShouldContinue("Delete this virtual machine?", "Confirm")) { if ($PSCmdlet.ParameterSetName -eq "ByResourceId"){ if ($ResourceId -match $vmRegex) { $SubscriptionId = $($Matches['subscriptionId']) $ResourceGroupName = $($Matches['resourceGroupName']) $Name = $($Matches['machineName']) $resourceUri = "/subscriptions/" + $subscriptionId + "/resourceGroups/" + $resourceGroupName + "/providers/Microsoft.HybridCompute/machines/" + $Name } else { Write-Error "Resource ID is invalid: $ResourceId" -ErrorAction Stop } } if ($PSCmdlet.ParameterSetName -eq "ByName"){ if ($SubscriptionId -and $ResourceGroupName -and $Name){ $resourceUri = "/subscriptions/" + $SubscriptionId + "/resourceGroups/" + $ResourceGroupName + "/providers/Microsoft.HybridCompute/machines/" + $Name } else { Write-Error "One or more input parameters are invalid. Name is $name, resource group name is $resourcegroupname, subscription id is $subscriptionid" } } $null = $PSBoundParameters.Remove("ResourceId") $null = $PSBoundParameters.Remove("Name") $null = $PSBoundParameters.Remove("SubscriptionId") $null = $PSBoundParameters.Remove("ResourceGroupName") $null = $PSBoundParameters.Remove("Force") $PSBoundParameters.Add("ResourceUri", $resourceUri) Az.StackHCIVM.internal\Remove-AzStackHCIVMVirtualMachine @PSBoundParameters $PSBoundParameters.Add("SubscriptionId", $SubscriptionId) $PSBoundParameters.Add("ResourceGroupName", $ResourceGroupName) $PSBoundParameters.Add("Name", $Name) $null = $PSBoundParameters.Remove("ResourceUri") Az.StackHCIVM.internal\Remove-AzStackHCIVMMachine @PSBoundParameters } } } |