az mission community transit-hub

Note

This reference is part of the mission extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az mission community transit-hub command. Learn more about extensions.

Manage Transit Hub.

Commands

Name	Description	Type	Status
az mission community transit-hub create	Create a TransitHubResource.	Extension	GA
az mission community transit-hub delete	Delete a TransitHubResource.	Extension	GA
az mission community transit-hub list	List TransitHubResource resources by subscription ID.	Extension	GA
az mission community transit-hub show	Get a TransitHubResource.	Extension	GA
az mission community transit-hub update	Update a TransitHubResource.	Extension	GA
az mission community transit-hub wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az mission community transit-hub create

Create a TransitHubResource.

az mission community transit-hub create --community-name
                                        --name --transit-hub-name
                                        --resource-group
                                        [--acquire-policy-token]
                                        [--change-reference]
                                        [--location]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--security-provider {AzureFirewall, None}]
                                        [--state {Active, Approved, Failed, PendingApproval, PendingUpdate}]
                                        [--tags]
                                        [--transit-option]

Examples

TransitHub_CreateOrUpdate

az mission community transit-hub create --resource-group rgopenapi --community-name TestMyCommunity --transit-hub-name TestThName --state PendingApproval --transit-option "{type:ExpressRoute,params:{scale-units:1}}" --security-provider AzureFirewall --tags "{Tag1:Value1}" --location westcentralus

Required Parameters

--community-name

The name of the communityResource Resource.

--name --transit-hub-name -n

The name of the TransitHub Resource.

--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--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

--security-provider

Specifies the security provider for the transit hub.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	AzureFirewall, None

--state

The state of the transitHub.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Active, Approved, Failed, PendingApproval, PendingUpdate

--tags

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

Property	Value
Parameter group:	Resource Arguments

--transit-option

The TransitOption of the transitHub. 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.

--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 mission community transit-hub delete

Delete a TransitHubResource.

az mission community transit-hub delete [--acquire-policy-token]
                                        [--change-reference]
                                        [--community-name]
                                        [--ids]
                                        [--name --transit-hub-name]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--subscription]
                                        [--yes]

Examples

TransitHub_Delete

az mission community transit-hub delete --resource-group rgopenapi --community-name TestMyCommunity --transit-hub-name TestThName

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--community-name

The name of the communityResource Resource.

Property	Value
Parameter group:	Resource Id Arguments

--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 --transit-hub-name -n

The name of the TransitHub 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

--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 mission community transit-hub list

List TransitHubResource resources by subscription ID.

az mission community transit-hub list --community-name
                                      [--max-items]
                                      [--next-token]
                                      [--resource-group]

Examples

TransitHub_ListBySubscription

az mission community transit-hub list --community-name TestMyCommunity

TransitHub_ListByCommunityResource

az mission community transit-hub list --resource-group rgopenapi --community-name TestMyCommunity

Required Parameters

--community-name

The name of the communityResource Resource.

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 mission community transit-hub show

Get a TransitHubResource.

az mission community transit-hub show [--community-name]
                                      [--ids]
                                      [--name --transit-hub-name]
                                      [--resource-group]
                                      [--subscription]

Examples

TransitHub_Get

az mission community transit-hub show --resource-group rgopenapi --community-name TestMyCommunity --transit-hub-name TestThName

Optional Parameters

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

--community-name

The name of the communityResource Resource.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --transit-hub-name -n

The name of the TransitHub Resource.

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 mission community transit-hub update

Update a TransitHubResource.

az mission community transit-hub update [--acquire-policy-token]
                                        [--add]
                                        [--change-reference]
                                        [--community-name]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--ids]
                                        [--name --transit-hub-name]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--remove]
                                        [--resource-group]
                                        [--security-provider {AzureFirewall, None}]
                                        [--set]
                                        [--state {Active, Approved, Failed, PendingApproval, PendingUpdate}]
                                        [--subscription]
                                        [--tags]
                                        [--transit-option]

Examples

TransitHub_CreateOrUpdate

az mission community transit-hub update --resource-group rgopenapi --community-name TestMyCommunity --transit-hub-name TestThName

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--community-name

The name of the communityResource Resource.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --transit-hub-name -n

The name of the TransitHub 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

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update 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

--security-provider

Specifies the security provider for the transit hub.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	AzureFirewall, None

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--state

The state of the transitHub.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Active, Approved, Failed, PendingApproval, PendingUpdate

--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:	Resource Arguments

--transit-option

The TransitOption of the transitHub. 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 mission community transit-hub wait

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

az mission community transit-hub wait [--acquire-policy-token]
                                      [--change-reference]
                                      [--community-name]
                                      [--created]
                                      [--custom]
                                      [--deleted]
                                      [--exists]
                                      [--ids]
                                      [--interval]
                                      [--name --transit-hub-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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--community-name

The name of the communityResource Resource.

Property	Value
Parameter group:	Resource Id Arguments

--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 --transit-hub-name -n

The name of the TransitHub Resource.

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

Feedback

Was this page helpful?