Update-AzServiceFabricVmImage

Module:

Az.ServiceFabric

Update the cluster resource vmImage setting which maps the appropriate runtime package to be delivered based on the target operating system.

Syntax

Update-AzServiceFabricVmImage
      [-ResourceGroupName] <String>
      [-Name] <String>
      -VmImage <VmImageKind>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Use Update-AzServiceFabricVmImage to update the vmImage setting of the cluster, responsible for runtime package delivery.

Important Note: VmImage 'Linux' as well as 'Ubuntu' map to the delivery of the Ubuntu 16.04 package, so if the intent is to run Ubuntu18+, use Ubuntu18_04.

Examples

Example 1

Update-AzServiceFabricVmImage -ResourceGroupName 'Group1' -ClusterName 'Contoso01SFCluster' -VmImage Ubuntu18_04

This command changes vmImage of the of the cluster 'Contoso01SFCluster' to 'Ubuntu18_04', for the purpose of migrating future upgrades to use the Ubuntu 18 SF runtime deb package.

Parameters

-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 credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Specify the name of the cluster, if not given it will be same as resource group name

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

-ResourceGroupName

Specify the name of the resource group.

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

-VmImage

Specify common target vmImage to be used for the cluster.

Type:	VmImageKind
Accepted values:	Windows, Linux, Ubuntu, Ubuntu18_04, Ubuntu20_04
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

String

VmImageKind

Outputs

PSDeploymentResult