AzStackHCI.VM

0.0.2

internal/Set-AzStackHCIVMMachine.ps1

                                
# ----------------------------------------------------------------------------------

# 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.

# ----------------------------------------------------------------------------------

<#

.Synopsis

The operation to create or update a hybrid machine.

Please note some properties can be set only during machine creation.

.Description

The operation to create or update a hybrid machine.

Please note some properties can be set only during machine creation.

.Example

{{ Add code here }}

.Example

{{ Add code here }}

.Outputs

Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.IMachine

.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.

EXTENSION <IMachineExtensionInstanceView[]>: Machine Extensions information (deprecated field)

  [Name <String>]: The machine extension name.

  [StatusCode <String>]: The status code.

  [StatusDisplayStatus <String>]: The short localizable label for the status.

  [StatusLevel <String>]: The level code.

  [StatusMessage <String>]: The detailed status message, including for alerts and error messages.

  [StatusTime <DateTime?>]: The time of the status.

  [Type <String>]: Specifies the type of the extension; an example is "CustomScriptExtension".

  [TypeHandlerVersion <String>]: Specifies the version of the script handler.

.Link

https://learn.microsoft.com/powershell/module/azstackhci.vm/set-azstackhcivmmachine

#>

function Set-AzStackHCIVMMachine {

[OutputType([Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.IMachine])]

[CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')]

param(

    [Parameter(Mandatory)]

    [Alias('MachineName')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Path')]

    [System.String]

    # The name of the hybrid machine.

    ${Name},

    [Parameter(Mandatory)]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Path')]

    [System.String]

    # The name of the resource group.

    # The name is case insensitive.

    ${ResourceGroupName},

    [Parameter()]

    [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.

    # The value must be an UUID.

    ${SubscriptionId},

    [Parameter(ParameterSetName='UpdateExpanded', Mandatory)]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The geo-location where the resource lives

    ${Location},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The correlation ID passed in from RSM per upgrade.

    ${AgentUpgradeCorrelationId},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # Specifies the version info w.r.t AgentUpgrade for the machine.

    ${AgentUpgradeDesiredVersion},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.Management.Automation.SwitchParameter]

    # Specifies if RSM should try to upgrade this machine

    ${AgentUpgradeEnableAutomaticUpgrade},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # Public Key that the client provides to be used during initial resource onboarding

    ${ClientPublicKey},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [AllowEmptyCollection()]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.IMachineExtensionInstanceView[]]

    # Machine Extensions information (deprecated field)

    ${Extension},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The behavior of the service when the Arc-enabled machine starts up.

    ${ExtensionServiceStartupType},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The current status of the service.

    ${ExtensionServiceStatus},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The behavior of the service when the Arc-enabled machine starts up.

    ${GuestConfigurationServiceStartupType},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The current status of the service.

    ${GuestConfigurationServiceStatus},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.PSArgumentCompleterAttribute("SystemAssigned")]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The identity type.

    ${IdentityType},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.PSArgumentCompleterAttribute("AVS", "HCI", "SCVMM", "VMware")]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # Indicates which kind of VM fabric the instance is an instance of, such as HCI or SCVMM etc.

    ${Kind},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.PSArgumentCompleterAttribute("ImageDefault", "AutomaticByPlatform")]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # Specifies the assessment mode.

    ${LinuxConfigurationPatchSettingsAssessmentMode},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.PSArgumentCompleterAttribute("ImageDefault", "AutomaticByPlatform", "AutomaticByOS", "Manual")]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # Specifies the patch mode.

    ${LinuxConfigurationPatchSettingsPatchMode},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The city or locality where the resource is located.

    ${LocationDataCity},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The country or region where the resource is located

    ${LocationDataCountryOrRegion},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The district, state, or province where the resource is located.

    ${LocationDataDistrict},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # A canonical name for the geographic or physical location.

    ${LocationDataName},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # Specifies whether any MS SQL instance is discovered on the machine.

    ${MssqlDiscovered},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The type of Operating System (windows/linux).

    ${OSType},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any.

    ${ParentClusterResourceId},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # The resource id of the private link scope this machine is assigned to, if any.

    ${PrivateLinkScopeResourceId},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Runtime.Info(PossibleTypes=([Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Models.ITrackedResourceTags]))]

    [System.Collections.Hashtable]

    # Resource tags.

    ${Tag},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # Specifies the hybrid machine unique ID.

    ${VMId},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.PSArgumentCompleterAttribute("ImageDefault", "AutomaticByPlatform")]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # Specifies the assessment mode.

    ${WindowsConfigurationPatchSettingsAssessmentMode},

    [Parameter(ParameterSetName='UpdateExpanded')]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.PSArgumentCompleterAttribute("ImageDefault", "AutomaticByPlatform", "AutomaticByOS", "Manual")]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # Specifies the patch mode.

    ${WindowsConfigurationPatchSettingsPatchMode},

    [Parameter(ParameterSetName='UpdateViaJsonFilePath', Mandatory)]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # Path of Json file supplied to the Update operation

    ${JsonFilePath},

    [Parameter(ParameterSetName='UpdateViaJsonString', Mandatory)]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Body')]

    [System.String]

    # Json string supplied to the Update operation

    ${JsonString},

    [Parameter()]

    [Alias('AzureRMContext', 'AzureCredential')]

    [ValidateNotNull()]

    [Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Category('Azure')]

    [System.Management.Automation.PSObject]

    # The DefaultProfile parameter is not functional.

    # Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

    ${DefaultProfile},

    [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(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}

)

begin {

    try {

        $outBuffer = $null

        if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) {

            $PSBoundParameters['OutBuffer'] = 1

        }

        $parameterSet = $PSCmdlet.ParameterSetName

        $mapping = @{

            UpdateExpanded = 'AzStackHci.VM.private\Set-AzStackHCIVMMachine_UpdateExpanded';

            UpdateViaJsonFilePath = 'AzStackHci.VM.private\Set-AzStackHCIVMMachine_UpdateViaJsonFilePath';

            UpdateViaJsonString = 'AzStackHci.VM.private\Set-AzStackHCIVMMachine_UpdateViaJsonString';

        }

        if (('UpdateExpanded', 'UpdateViaJsonFilePath', 'UpdateViaJsonString') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId') ) {

            $testPlayback = $false

            $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { if ($_) { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.StackHCIVM.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) } }

            if ($testPlayback) {

                $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1')

            } else {

                $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id

            }

        }

        $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet)

        $scriptCmd = {& $wrappedCmd @PSBoundParameters}

        $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin)

        $steppablePipeline.Begin($PSCmdlet)

    } catch {

        throw

    }

}

process {

    try {

        $steppablePipeline.Process($_)

    } catch {

        throw

    }

}

end {

    try {

        $steppablePipeline.End()

    } catch {

        throw

    }

} 

}