Share via

az relay hyco

  • Reference

Manage Azure Relay Service Hybrid Connection and Authorization Rule.

Commands

Name Description Type Status
az relay hyco authorization-rule

Manage Azure Relay Service Hybrid Connection Authorization Rule.

 Core GA
az relay hyco authorization-rule create

Create Authorization Rule for given Relay Service Hybrid Connection.

 Core GA
az relay hyco authorization-rule delete

Deletes the Authorization Rule of the given Relay Service Hybrid Connection.

 Core GA
az relay hyco authorization-rule keys

Manage Azure Authorization Rule keys for Relay Service Hybrid Connection.

 Core GA
az relay hyco authorization-rule keys list

List the keys and connection strings of Authorization Rule for Relay Service Hybrid Connection.

 Core GA
az relay hyco authorization-rule keys renew

Regenerate keys of Authorization Rule for Relay Service Hybrid Connection.

 Core GA
az relay hyco authorization-rule list

Shows list of Authorization Rule by Relay Service Hybrid Connection.

 Core GA
az relay hyco authorization-rule show

Shows the details of Authorization Rule for given Relay Service Hybrid Connection.

 Core GA
az relay hyco authorization-rule update

Update Authorization Rule for given Relay Service Hybrid Connection.

 Core GA
az relay hyco create

Create the Relay Service Hybrid Connection.

 Core GA
az relay hyco delete

Deletes the Relay Service Hybrid Connection.

 Core GA
az relay hyco list

List the Hybrid Connection by Relay Service Namespace.

 Core GA
az relay hyco show

Shows the Relay Service Hybrid Connection Details.

 Core GA
az relay hyco update

Updates the Relay Service Hybrid Connection.

 Core GA

az relay hyco create

Edit

Create the Relay Service Hybrid Connection.

az relay hyco create --name
                     --namespace-name
                     --resource-group
                     [--requires-client-authorization {0, 1, f, false, n, no, t, true, y, yes}]
                     [--user-metadata]

Examples

Create a new Relay Service Hybrid Connection

az relay hyco create --resource-group myresourcegroup --namespace-name mynamespace --name myhyco

Required Parameters

--name -n

Name of Hybrid Connection.

--namespace-name

Name of Namespace.

--resource-group -g

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

Optional Parameters

--requires-client-authorization -c

Indicates whether client authorization is required.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--user-metadata

Endpoint metadata.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az relay hyco delete

Edit

Deletes the Relay Service Hybrid Connection.

az relay hyco delete [--ids]
                     [--name]
                     [--namespace-name]
                     [--resource-group]
                     [--subscription]

Examples

Deletes the Relay Service Hybrid Connection

az relay hyco delete --resource-group myresourcegroup --namespace-name mynamespace --name myhyco

Optional Parameters

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

--name -n

Name of Hybrid Connection.

--namespace-name

Name of Namespace.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az relay hyco list

Edit

List the Hybrid Connection by Relay Service Namespace.

az relay hyco list --namespace-name
                   --resource-group
                   [--max-items]
                   [--next-token]

Examples

Get the Hybrid Connections by Namespace.

az relay hyco list --resource-group myresourcegroup --namespace-name mynamespace

Required Parameters

--namespace-name

Name of Namespace.

--resource-group -g

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

Optional Parameters

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

--next-token

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az relay hyco show

Edit

Shows the Relay Service Hybrid Connection Details.

az relay hyco show [--ids]
                   [--name]
                   [--namespace-name]
                   [--resource-group]
                   [--subscription]

Examples

Shows the Hybrid Connection details.

az relay hyco show --resource-group myresourcegroup --namespace-name mynamespace --name myhyco

Optional Parameters

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

--name -n

Name of Hybrid Connection.

--namespace-name

Name of Namespace.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az relay hyco update

Edit

Updates the Relay Service Hybrid Connection.

az relay hyco update [--add]
                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                     [--ids]
                     [--name]
                     [--namespace-name]
                     [--remove]
                     [--requires-client-authorization {0, 1, f, false, n, no, t, true, y, yes}]
                     [--resource-group]
                     [--set]
                     [--status {Active, Disabled, ReceiveDisabled, SendDisabled}]
                     [--subscription]
                     [--user-metadata]

Examples

Updates existing Relay Service Hybrid Connection.

az relay hyco update --resource-group myresourcegroup --namespace-name mynamespace --name myhyco

Optional Parameters

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

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--name -n

Name of Hybrid Connection.

--namespace-name

Name of Namespace.

--remove

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

--requires-client-authorization -r

Indicates whether client authorization is required.

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

--set

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

--status

Enumerates the possible values for the status of a messaging entity.

Accepted values: Active, Disabled, ReceiveDisabled, SendDisabled
--subscription

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

--user-metadata

Endpoint metadata.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.