Update-AzArcSetting

Patch the base Settings of the target resource.

Syntax

PowerShell
Update-AzArcSetting
      -BaseProvider <String>
      -BaseResourceName <String>
      -BaseResourceType <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-GatewayResourceId <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell
Update-AzArcSetting
      -BaseProvider <String>
      -BaseResourceName <String>
      -BaseResourceType <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -Parameter <ISettings>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell
Update-AzArcSetting
      -BaseProvider <String>
      -BaseResourceName <String>
      -BaseResourceType <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -JsonFilePath <String>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell
Update-AzArcSetting
      -BaseProvider <String>
      -BaseResourceName <String>
      -BaseResourceType <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -JsonString <String>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell
Update-AzArcSetting
      -InputObject <IArcGatewayIdentity>
      -Parameter <ISettings>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell
Update-AzArcSetting
      -InputObject <IArcGatewayIdentity>
      [-GatewayResourceId <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Patch the base Settings of the target resource.

Examples

Example 1: Patch the base Settings of the target resource

PowerShell
Update-AzArcSetting -ResourceGroupName "ytongtest" -SubscriptionId "00000000-0000-0000-0000-000000000000" -BaseProvider "Microsoft.HybridCompute" -BaseResourceName "testmachine" -BaseResourceType "machines" -GatewayResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ytongtest/providers/Microsoft.HybridCompute/gateways/myArcGateway"

GatewayPropertyGatewayResourceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ytongtest/p
                                   roviders/Microsoft.HybridCompute/gateways/myArcGateway
Id                               : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ytongtest/p
                                   roviders/Microsoft.HybridCompute/machines/testmachine/providers/Microsoft.Hybr
                                   idCompute/settings/default
Name                             : default
ResourceGroupName                : ytongtest
SystemDataCreatedAt              :
SystemDataCreatedBy              :
SystemDataCreatedByType          :
SystemDataLastModifiedAt         :
SystemDataLastModifiedBy         :
SystemDataLastModifiedByType     :
TenantId                         : 00000000-0000-0000-0000-000000000000
Type                             : Microsoft.HybridCompute/settings

Patch the base Settings of the target resource

Parameters

-BaseProvider

The name of the base Resource Provider.

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

-BaseResourceName

The name of the base resource.

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

-BaseResourceType

The name of the base Resource Type.

Type:String
Position:Named
Default value:None
Required:True
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

-GatewayResourceId

Associated Gateway Resource Id

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

-InputObject

Identity Parameter

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

-JsonFilePath

Path of Json file supplied to the Patch operation

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

-JsonString

Json string supplied to the Patch operation

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

-Parameter

.

Type:ISettings
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

-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

-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

Outputs