az networkcloud accessbridge

Note

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

Manage Access Bridge.

Commands

Name	Description	Type	Status
az networkcloud accessbridge create	Create a new access bridge or update the properties of the existing access bridge.	Extension	GA
az networkcloud accessbridge delete	Delete the specified access bridge.	Extension	GA
az networkcloud accessbridge list	List a list of access bridges in the provided subscription.	Extension	GA
az networkcloud accessbridge show	Get the properties of the provided access bridge.	Extension	GA
az networkcloud accessbridge update	Update properties of the provided access bridge, or update tags associated with the access bridge. Properties and tag updates can be done independently.	Extension	GA
az networkcloud accessbridge wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az networkcloud accessbridge create

Create a new access bridge or update the properties of the existing access bridge.

az networkcloud accessbridge create --access-bridge-name --name {Bastion, PrivateVault, StorageDashboard}
                                    --extended-location
                                    --network-id
                                    --resource-group
                                    [--acquire-policy-token]
                                    [--change-reference]
                                    [--ipv4-connected-prefix]
                                    [--ipv6-connected-prefix]
                                    [--location]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--security-rules]
                                    [--tags]

Examples

Create or update access bridge

az networkcloud accessbridge create --resource-group resourceGroupName --access-bridge-name Bastion --location location --tags "{key1:myvalue1,key2:myvalue2}" --extended-location "{type:CustomLocation,name:/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName}" --ipv4-connected-prefix 198.51.100.0/24 --ipv6-connected-prefix 2001:db8::/64 --network-id /subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName/internalNetworks/internalNetworkName --security-rules "[{description:'Allow management plane egress',port:24562-24570,ipv4-addresses:[10.10.20.10-10.10.20.20],ipv6-addresses:['2001:db8:abcd:12::1000-2001:db8:abcd:12::1fff'],direction:Outbound}]"

Required Parameters

--access-bridge-name --name -n

The name of the access bridge.

Property	Value
Accepted values:	Bastion, PrivateVault, StorageDashboard

--extended-location

The extended location of the cluster associated with the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AccessBridge Arguments

--network-id

The resource ID of the internal network in a layer 3 isolation domain containing the IP subnets to use.

Property	Value
Parameter group:	Properties Arguments

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

--ipv4-connected-prefix

The IPv4 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.

Property	Value
Parameter group:	Properties Arguments

--ipv6-connected-prefix

The IPv6 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.

Property	Value
Parameter group:	Properties 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:	AccessBridge 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-rules

The list of security rules enforced by the access bridge. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--tags

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

Property	Value
Parameter group:	AccessBridge 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 networkcloud accessbridge delete

Delete the specified access bridge.

az networkcloud accessbridge delete [--access-bridge-name --name {Bastion, PrivateVault, StorageDashboard}]
                                    [--acquire-policy-token]
                                    [--change-reference]
                                    [--ids]
                                    [--if-match]
                                    [--if-none-match]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--subscription]
                                    [--yes]

Examples

Delete access bridge

az networkcloud accessbridge delete --resource-group resourceGroupName --access-bridge-name Bastion

Optional Parameters

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

--access-bridge-name --name -n

The name of the access bridge.

Property	Value
Parameter group:	Resource Id Arguments
Accepted values:	Bastion, PrivateVault, StorageDashboard

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

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

--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--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 networkcloud accessbridge list

List a list of access bridges in the provided subscription.

az networkcloud accessbridge list [--max-items]
                                  [--next-token]
                                  [--resource-group]
                                  [--skip-token]
                                  [--top]

Examples

List access bridges for subscription

az networkcloud accessbridge list

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

--skip-token

The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets.

--top

The maximum number of resources to return from the operation. Example: '$top=10'.

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 networkcloud accessbridge show

Get the properties of the provided access bridge.

az networkcloud accessbridge show [--access-bridge-name --name {Bastion, PrivateVault, StorageDashboard}]
                                  [--ids]
                                  [--resource-group]
                                  [--subscription]

Examples

Get access bridge

az networkcloud accessbridge show --resource-group resourceGroupName --access-bridge-name Bastion

Optional Parameters

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

--access-bridge-name --name -n

The name of the access bridge.

Property	Value
Parameter group:	Resource Id Arguments
Accepted values:	Bastion, PrivateVault, StorageDashboard

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

--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 networkcloud accessbridge update

Update properties of the provided access bridge, or update tags associated with the access bridge. Properties and tag updates can be done independently.

az networkcloud accessbridge update [--access-bridge-name --name {Bastion, PrivateVault, StorageDashboard}]
                                    [--acquire-policy-token]
                                    [--change-reference]
                                    [--ids]
                                    [--if-match]
                                    [--if-none-match]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--security-rules]
                                    [--subscription]
                                    [--tags]

Examples

Patch access bridge resource

az networkcloud accessbridge update --resource-group resourceGroupName --access-bridge-name Bastion --security-rules "[{description:'Allow management plane egress',port:24562-24570,ipv4-addresses:[10.10.20.10-10.10.20.20],ipv6-addresses:['2001:db8:abcd:12::1000-2001:db8:abcd:12::1fff'],direction:Outbound}]"

Optional Parameters

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

--access-bridge-name --name -n

The name of the access bridge.

Property	Value
Parameter group:	Resource Id Arguments
Accepted values:	Bastion, PrivateVault, StorageDashboard

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

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

--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

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

--security-rules

The list of security rules enforced by the access bridge. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	AccessBridgeUpdateParameters 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 networkcloud accessbridge wait

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

az networkcloud accessbridge wait [--access-bridge-name --name {Bastion, PrivateVault, StorageDashboard}]
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--ids]
                                  [--interval]
                                  [--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.

--access-bridge-name --name -n

The name of the access bridge.

Property	Value
Parameter group:	Resource Id Arguments
Accepted values:	Bastion, PrivateVault, StorageDashboard

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

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

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

--interval

Polling interval in seconds.

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

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