Edit

Share via

Set-AzConnectedKubernetes

  • Preview
Module:
Az.ConnectedKubernetes Module

This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.

API to set properties of the connected cluster resource

Syntax

SetExpanded (Default) 

Set-AzConnectedKubernetes
    -ClusterName <String>
    -ResourceGroupName <String>
    -Location <String>
    [-SubscriptionId <String>]
    [-AadProfileAdminGroupObjectID <String[]>]
    [-AadProfileEnableAzureRbac]
    [-AadProfileTenantId <String>]
    [-ArcAgentProfileAgentAutoUpgrade <String>]
    [-ArcAgentProfileAgentError <IAgentError[]>]
    [-ArcAgentProfileDesiredAgentVersion <String>]
    [-ArcAgentProfileSystemComponent <ISystemComponent[]>]
    [-ArcAgentryConfiguration <IArcAgentryConfigurations[]>]
    [-AzureHybridBenefit <String>]
    [-Distribution <String>]
    [-DistributionVersion <String>]
    [-GatewayEnabled]
    [-Infrastructure <String>]
    [-Kind <String>]
    [-PrivateLinkScopeResourceId <String>]
    [-PrivateLinkState <String>]
    [-ProvisioningState <String>]
    [-Tag <Hashtable>]
    [-CustomLocationsOid <String>]
    [-OidcIssuerProfileEnabled]
    [-OidcIssuerProfileSelfHostedIssuerUrl <String>]
    [-WorkloadIdentityEnabled]
    [-AcceptEULA]
    [-ConfigurationSetting <Hashtable>]
    [-ConfigurationProtectedSetting <Hashtable>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetExpandedDisableGateway 

Set-AzConnectedKubernetes
    -ClusterName <String>
    -ResourceGroupName <String>
    -Location <String>
    [-SubscriptionId <String>]
    [-AadProfileAdminGroupObjectID <String[]>]
    [-AadProfileEnableAzureRbac]
    [-AadProfileTenantId <String>]
    [-ArcAgentProfileAgentAutoUpgrade <String>]
    [-ArcAgentProfileAgentError <IAgentError[]>]
    [-ArcAgentProfileDesiredAgentVersion <String>]
    [-ArcAgentProfileSystemComponent <ISystemComponent[]>]
    [-ArcAgentryConfiguration <IArcAgentryConfigurations[]>]
    [-AzureHybridBenefit <String>]
    [-Distribution <String>]
    [-DistributionVersion <String>]
    [-GatewayEnabled]
    [-Infrastructure <String>]
    [-Kind <String>]
    [-PrivateLinkScopeResourceId <String>]
    [-PrivateLinkState <String>]
    [-ProvisioningState <String>]
    [-Tag <Hashtable>]
    [-CustomLocationsOid <String>]
    [-OidcIssuerProfileEnabled]
    [-OidcIssuerProfileSelfHostedIssuerUrl <String>]
    [-WorkloadIdentityEnabled]
    [-AcceptEULA]
    [-ConfigurationSetting <Hashtable>]
    [-ConfigurationProtectedSetting <Hashtable>]
    [-DisableGateway]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetExpandedEnableGateway 

Set-AzConnectedKubernetes
    -ClusterName <String>
    -ResourceGroupName <String>
    -Location <String>
    -GatewayResourceId <String>
    [-SubscriptionId <String>]
    [-AadProfileAdminGroupObjectID <String[]>]
    [-AadProfileEnableAzureRbac]
    [-AadProfileTenantId <String>]
    [-ArcAgentProfileAgentAutoUpgrade <String>]
    [-ArcAgentProfileAgentError <IAgentError[]>]
    [-ArcAgentProfileDesiredAgentVersion <String>]
    [-ArcAgentProfileSystemComponent <ISystemComponent[]>]
    [-ArcAgentryConfiguration <IArcAgentryConfigurations[]>]
    [-AzureHybridBenefit <String>]
    [-Distribution <String>]
    [-DistributionVersion <String>]
    [-GatewayEnabled]
    [-Infrastructure <String>]
    [-Kind <String>]
    [-PrivateLinkScopeResourceId <String>]
    [-PrivateLinkState <String>]
    [-ProvisioningState <String>]
    [-Tag <Hashtable>]
    [-CustomLocationsOid <String>]
    [-OidcIssuerProfileEnabled]
    [-OidcIssuerProfileSelfHostedIssuerUrl <String>]
    [-WorkloadIdentityEnabled]
    [-AcceptEULA]
    [-ConfigurationSetting <Hashtable>]
    [-ConfigurationProtectedSetting <Hashtable>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetEnableGateway 

Set-AzConnectedKubernetes
    -GatewayResourceId <String>
    -InputObject <IConnectedCluster>
    [-SubscriptionId <String>]
    [-AadProfileAdminGroupObjectID <String[]>]
    [-AadProfileEnableAzureRbac]
    [-AadProfileTenantId <String>]
    [-ArcAgentProfileAgentAutoUpgrade <String>]
    [-ArcAgentProfileAgentError <IAgentError[]>]
    [-ArcAgentProfileDesiredAgentVersion <String>]
    [-ArcAgentProfileSystemComponent <ISystemComponent[]>]
    [-ArcAgentryConfiguration <IArcAgentryConfigurations[]>]
    [-AzureHybridBenefit <String>]
    [-Distribution <String>]
    [-DistributionVersion <String>]
    [-GatewayEnabled]
    [-Infrastructure <String>]
    [-Kind <String>]
    [-PrivateLinkScopeResourceId <String>]
    [-PrivateLinkState <String>]
    [-ProvisioningState <String>]
    [-Tag <Hashtable>]
    [-CustomLocationsOid <String>]
    [-OidcIssuerProfileEnabled]
    [-OidcIssuerProfileSelfHostedIssuerUrl <String>]
    [-WorkloadIdentityEnabled]
    [-AcceptEULA]
    [-ConfigurationSetting <Hashtable>]
    [-ConfigurationProtectedSetting <Hashtable>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetDisableGateway 

Set-AzConnectedKubernetes
    -InputObject <IConnectedCluster>
    [-SubscriptionId <String>]
    [-AadProfileAdminGroupObjectID <String[]>]
    [-AadProfileEnableAzureRbac]
    [-AadProfileTenantId <String>]
    [-ArcAgentProfileAgentAutoUpgrade <String>]
    [-ArcAgentProfileAgentError <IAgentError[]>]
    [-ArcAgentProfileDesiredAgentVersion <String>]
    [-ArcAgentProfileSystemComponent <ISystemComponent[]>]
    [-ArcAgentryConfiguration <IArcAgentryConfigurations[]>]
    [-AzureHybridBenefit <String>]
    [-Distribution <String>]
    [-DistributionVersion <String>]
    [-GatewayEnabled]
    [-Infrastructure <String>]
    [-Kind <String>]
    [-PrivateLinkScopeResourceId <String>]
    [-PrivateLinkState <String>]
    [-ProvisioningState <String>]
    [-Tag <Hashtable>]
    [-CustomLocationsOid <String>]
    [-OidcIssuerProfileEnabled]
    [-OidcIssuerProfileSelfHostedIssuerUrl <String>]
    [-WorkloadIdentityEnabled]
    [-AcceptEULA]
    [-ConfigurationSetting <Hashtable>]
    [-ConfigurationProtectedSetting <Hashtable>]
    [-DisableGateway]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Set 

Set-AzConnectedKubernetes
    -InputObject <IConnectedCluster>
    [-SubscriptionId <String>]
    [-AadProfileAdminGroupObjectID <String[]>]
    [-AadProfileEnableAzureRbac]
    [-AadProfileTenantId <String>]
    [-ArcAgentProfileAgentAutoUpgrade <String>]
    [-ArcAgentProfileAgentError <IAgentError[]>]
    [-ArcAgentProfileDesiredAgentVersion <String>]
    [-ArcAgentProfileSystemComponent <ISystemComponent[]>]
    [-ArcAgentryConfiguration <IArcAgentryConfigurations[]>]
    [-AzureHybridBenefit <String>]
    [-Distribution <String>]
    [-DistributionVersion <String>]
    [-GatewayEnabled]
    [-Infrastructure <String>]
    [-Kind <String>]
    [-PrivateLinkScopeResourceId <String>]
    [-PrivateLinkState <String>]
    [-ProvisioningState <String>]
    [-Tag <Hashtable>]
    [-CustomLocationsOid <String>]
    [-OidcIssuerProfileEnabled]
    [-OidcIssuerProfileSelfHostedIssuerUrl <String>]
    [-WorkloadIdentityEnabled]
    [-AcceptEULA]
    [-ConfigurationSetting <Hashtable>]
    [-ConfigurationProtectedSetting <Hashtable>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

API to set properties of the connected cluster resource. Replaces all configuration of an existing connected cluster; any properties not specified will be reset to their default values.

Examples

Example 1: Disable gateway for a connected Kubernetes cluster

Set-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -DisableGateway

Location Name              ResourceGroupName
-------- ----              -----------------
eastus   azps_test_cluster azps_test_group

This command disables the gateway feature of a connected Kubernetes cluster.

Example 2: Enable gateway for a connected Kubernetes cluster

Set-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Location eastus -GatewayResourceId $gatewayResourceId

Location Name              ResourceGroupName
-------- ----              -----------------
eastus   azps_test_cluster azps_test_group

This command enables gateway feature of a connected kubernetes cluster.

Example 3: Enable gateway for a connected Kubernetes cluster with InputObject

# Get an existing cluster first
$inputObject = Get-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -SubscriptionId $subscriptionId
# Enable gateway and set gateway resource Id
$inputObject.GatewayEnabled=$true
$inputObject.GatewayResourceId=$gatewayResourceId
Set-AzConnectedKubernetes -InputObject $inputObject

Location Name              ResourceGroupName
-------- ----              -----------------
eastus   azps_test_cluster azps_test_group

This command enables gateway feature of a connected kubernetes cluster.

Example 4: Enable workload identity of a connected kubernetes cluster with InputObject

# Get an existing cluster first
$inputObject = Get-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -SubscriptionId $subscriptionId
# Enable workload identity and OIDC issuer profile
$inputObject.WorkloadIdentityEnabled=$true
$inputObject.OidcIssuerProfileEnabled=$true
Set-AzConnectedKubernetes -InputObject $inputObject

Location Name              ResourceGroupName
-------- ----              -----------------
eastus   azps_test_cluster azps_test_group

This command enables workload identity and OIDC Issuer Profile for a connected Kubernetes cluster

Example 5: Disable workload identity of a connected Kubernetes cluster with InputObject

# Get an existing cluster first
$inputObject = Get-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -SubscriptionId $subscriptionId
# Disable workload identity
$inputObject.WorkloadIdentityEnabled=$false
Set-AzConnectedKubernetes -InputObject $inputObject

Location Name              ResourceGroupName
-------- ----              -----------------
eastus   azps_test_cluster azps_test_group

This command disables workload identity of a connected kubernetes cluster

Example 6: Disable workload identity of a connected kubernetes cluster

Get-AzConnectedKubernetes -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -SubscriptionId $subscriptionId | Set-AzConnectedKubernetes -WorkloadIdentityEnabled:$false

Location Name              ResourceGroupName
-------- ----              -----------------
eastus   azps_test_cluster azps_test_group

This command disables workload identity of a connected kubernetes cluster

Parameters

-AadProfileAdminGroupObjectID

The list of AAD group object IDs that will have admin role of the cluster.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AadProfileEnableAzureRbac

Whether to enable Azure RBAC for Kubernetes authorization.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AadProfileTenantId

The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AcceptEULA

Accept EULA of ConnectedKubernetes, legal term will pop up without this parameter provided

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ArcAgentProfileAgentAutoUpgrade

Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ArcAgentProfileAgentError

List of arc agentry and system components errors on the cluster resource.

Parameter properties

Type:

IAgentError[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ArcAgentProfileDesiredAgentVersion

Version of the Arc agents to be installed on the cluster resource

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ArcAgentProfileSystemComponent

List of system extensions that are installed on the cluster resource.

Parameter properties

Type:

ISystemComponent[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ArcAgentryConfiguration

Configuration settings for customizing the behavior of the connected cluster.

Parameter properties

Type:

IArcAgentryConfigurations[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AsJob

Run the command as a job

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AzureHybridBenefit

Indicates whether Azure Hybrid Benefit is opted in

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClusterName

The name of the Kubernetes cluster on which get is called.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name

Parameter sets

SetExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetExpandedDisableGateway
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetExpandedEnableGateway
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ConfigurationProtectedSetting

Arc Agentry System Protected Configuration

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ConfigurationSetting

Arc Agentry System Configuration

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CustomLocationsOid

OID of 'custom-locations' app.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableGateway

API to set properties of the connected cluster resource. Replaces all configuration of an existing connected cluster; any properties not specified will be reset to their default values.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetExpandedDisableGateway
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetDisableGateway
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Distribution

The Kubernetes distribution running on this connected cluster.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DistributionVersion

The Kubernetes distribution version on this connected cluster.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GatewayEnabled

Indicates whether the gateway for arc router connectivity is enabled.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GatewayResourceId

Arc Gateway resource Id, providing this will enable the gateway

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetExpandedEnableGateway
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetEnableGateway
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Infrastructure

The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

API to set properties of the connected cluster resource. Replaces all configuration of an existing connected cluster; any properties not specified will be reset to their default values.

Parameter properties

Type:IConnectedCluster
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetEnableGateway
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
SetDisableGateway
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Set
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Kind

The kind of connected cluster.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Location

The geo-location where the resource lives

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetExpandedDisableGateway
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetExpandedEnableGateway
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoWait

Run the command asynchronously

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OidcIssuerProfileEnabled

Whether to enable oidc issuer for workload identity integration.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OidcIssuerProfileSelfHostedIssuerUrl

The issuer url for public cloud clusters - AKS, EKS, GKE - used for the workload identity feature.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivateLinkScopeResourceId

This is populated only if privateLinkState is enabled. The resource id of the private link scope this connected cluster is assigned to, if any.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivateLinkState

Property which describes the state of private link on a connected cluster resource.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProvisioningState

Provisioning state of the connected cluster resource.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetExpandedDisableGateway
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SetExpandedEnableGateway
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The ID of the target subscription.

Parameter properties

Type:String
Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Tag

Resource tags.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WorkloadIdentityEnabled

Whether to enable or disable the workload identity Webhook

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IConnectedCluster

Outputs

IConnectedCluster