az arc-multicloud public-cloud-connector

Note

This reference is part of the multicloud-connector extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az arc-multicloud public-cloud-connector command. Learn more about extensions.

Commands for multicloudConnector.

For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest.

Commands

Name	Description	Type	Status
az arc-multicloud public-cloud-connector create	Create a PublicCloudConnector.	Extension	GA
az arc-multicloud public-cloud-connector delete	Delete a PublicCloudConnector.	Extension	GA
az arc-multicloud public-cloud-connector list	List PublicCloudConnector resources within the current subscription, and limit to the specified resource group if one is provided.	Extension	GA
az arc-multicloud public-cloud-connector show	Get a PublicCloudConnector.	Extension	GA
az arc-multicloud public-cloud-connector test-permission	A long-running resource action.	Extension	GA
az arc-multicloud public-cloud-connector update	Update a PublicCloudConnector.	Extension	GA
az arc-multicloud public-cloud-connector wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az arc-multicloud public-cloud-connector create

Create a PublicCloudConnector.

For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest.

az arc-multicloud public-cloud-connector create --name
                                                --resource-group
                                                [--aws-cloud-profile]
                                                [--host-type {AWS}]
                                                [--location]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--tags]

Examples

PublicCloudConnectors_CreateOrUpdate

az arc-multicloud public-cloud-connector create --resource-group multiCloudRG --name awsConnector --aws-cloud-profile "{account-id:123456789123,excluded-accounts:[123456789124,123456789125],is-organizational-account:True}" --host-type AWS --tags "{a:b}" --location eastus

PublicCloudConnectors_CreateOrUpdate

az arc-multicloud public-cloud-connector create --resource-group multiCloudRG --name awsConnector --aws-cloud-profile account-id=123456789123 is-organizational-account=false --host-type AWS --tags a=b --location eastus

Required Parameters

--name -n

Represent public cloud connector name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aws-cloud-profile

Cloud profile for AWS. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--host-type

Host cloud the public cloud connector.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	AWS

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Resource Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az arc-multicloud public-cloud-connector delete

Delete a PublicCloudConnector.

For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest.

az arc-multicloud public-cloud-connector delete [--ids]
                                                [--name]
                                                [--resource-group]
                                                [--subscription]
                                                [--yes]

Examples

PublicCloudConnectors_Delete

az arc-multicloud public-cloud-connector delete --resource-group multiCloudRG --name awsConnector

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Represent public cloud connector name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az arc-multicloud public-cloud-connector list

List PublicCloudConnector resources within the current subscription, and limit to the specified resource group if one is provided.

For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest.

az arc-multicloud public-cloud-connector list [--max-items]
                                              [--next-token]
                                              [--resource-group]

Examples

PublicCloudConnectors_ListBySubscription

az arc-multicloud public-cloud-connector list --resource-group multiCloudRG

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az arc-multicloud public-cloud-connector show

Get a PublicCloudConnector.

For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest.

az arc-multicloud public-cloud-connector show [--ids]
                                              [--name]
                                              [--resource-group]
                                              [--subscription]

Examples

publicCloudConnectors_Get

az arc-multicloud public-cloud-connector show --resource-group multiCloudRG --name awsConnector

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Represent public cloud connector name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az arc-multicloud public-cloud-connector test-permission

A long-running resource action.

For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest.

az arc-multicloud public-cloud-connector test-permission [--ids]
                                                         [--name]
                                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                         [--resource-group]
                                                         [--subscription]

Examples

PublicCloudConnectors_TestPermissions

az arc-multicloud public-cloud-connector test-permission --resource-group multiCloudRG --name awsConnector

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Represent public cloud connectors resource.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az arc-multicloud public-cloud-connector update

Update a PublicCloudConnector.

For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest.

az arc-multicloud public-cloud-connector update [--aws-cloud-profile]
                                                [--ids]
                                                [--name]
                                                [--resource-group]
                                                [--subscription]
                                                [--tags]

Examples

publicCloudConnectors_Update

az arc-multicloud public-cloud-connector update --resource-group multiCloudRG --name awsConnector --aws-cloud-profile "{excluded-accounts:[123456789123,123456789124]}" --tags "{}"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aws-cloud-profile

Cloud profile for AWS. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Represent public cloud connectors name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az arc-multicloud public-cloud-connector wait

Place the CLI in a waiting state until a condition is met.

az arc-multicloud public-cloud-connector wait [--created]
                                              [--custom]
                                              [--deleted]
                                              [--exists]
                                              [--ids]
                                              [--interval]
                                              [--name]
                                              [--resource-group]
                                              [--subscription]
                                              [--timeout]
                                              [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name -n

Represent public cloud connector name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Share via

az arc-multicloud public-cloud-connector

Commands

az arc-multicloud public-cloud-connector create

Examples

Required Parameters

Optional Parameters

az arc-multicloud public-cloud-connector delete

Examples

Optional Parameters

az arc-multicloud public-cloud-connector list

Examples

Optional Parameters

az arc-multicloud public-cloud-connector show

Examples

Optional Parameters

az arc-multicloud public-cloud-connector test-permission

Examples

Optional Parameters

az arc-multicloud public-cloud-connector update

Examples

Optional Parameters

az arc-multicloud public-cloud-connector wait

Optional Parameters

Feedback