Update-AzNginxDeployment

Update the NGINX deployment

Syntax

Update-AzNginxDeployment
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-AutoScaleSettingProfile <IScaleProfile[]>]
      [-AutoUpgradeProfileUpgradeChannel <String>]
      [-EnableDiagnosticsSupport]
      [-IdentityType <IdentityType>]
      [-IdentityUserAssignedIdentity <Hashtable>]
      [-Location <String>]
      [-ScalingPropertyCapacity <Int32>]
      [-SkuName <String>]
      [-StorageAccountContainerName <String>]
      [-StorageAccountName <String>]
      [-Tag <Hashtable>]
      [-UserProfilePreferredEmail <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzNginxDeployment
      -InputObject <INginxIdentity>
      [-AutoScaleSettingProfile <IScaleProfile[]>]
      [-AutoUpgradeProfileUpgradeChannel <String>]
      [-EnableDiagnosticsSupport]
      [-IdentityType <IdentityType>]
      [-IdentityUserAssignedIdentity <Hashtable>]
      [-Location <String>]
      [-ScalingPropertyCapacity <Int32>]
      [-SkuName <String>]
      [-StorageAccountContainerName <String>]
      [-StorageAccountName <String>]
      [-Tag <Hashtable>]
      [-UserProfilePreferredEmail <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update the NGINX deployment

Examples

Example 1: Enable the diagnotics support for a NGINX deployment

Update-AzNginxDeployment -Name nginx-test -ResourceGroupName nginx-test-rg -EnableDiagnosticsSupport

Location      Name
--------      ----
westcentralus nginx-test

This command enables the diagnotics support for a NGINX deployment.

Example 2: Disable the diagnotics support for a NGINX deployment

Update-AzNginxDeployment -Name nginx-test -ResourceGroupName nginx-test-rg -EnableDiagnosticsSupport:$false

Location      Name
--------      ----
westcentralus nginx-test

This command disables the diagnotics support for a NGINX deployment.

Parameters

-AsJob

Run the command as a job

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

-AutoScaleSettingProfile

. To construct, see NOTES section for AUTOSCALESETTINGPROFILE properties and create a hash table.

Type:Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.IScaleProfile[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AutoUpgradeProfileUpgradeChannel

Channel used for autoupgrade.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableDiagnosticsSupport

.

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

-IdentityType

.

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

-IdentityUserAssignedIdentity

Dictionary of <UserIdentityProperties>

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

-InputObject

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

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

-Location

.

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

-Name

The name of targeted NGINX deployment

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

-NoWait

Run the command asynchronously

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

-ResourceGroupName

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

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

-ScalingPropertyCapacity

.

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

-SkuName

Name of the SKU.

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

-StorageAccountContainerName

.

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

-StorageAccountName

.

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

-SubscriptionId

The ID of the target subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Dictionary of <string>

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

-UserProfilePreferredEmail

The preferred support contact email address of the user used for sending alerts and notification. Can be an empty string or a valid email address.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

INginxIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.Nginx.Models.Api202401Preview.INginxDeployment