az relay hyco
Manage Azure Relay Service Hybrid Connection and Authorization Rule.
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 |
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]
Create a new Relay Service Hybrid Connection
az relay hyco create --resource-group myresourcegroup --namespace-name mynamespace --name myhyco
Name of Hybrid Connection.
Name of Namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Indicates whether client authorization is required.
Endpoint metadata.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Deletes the Relay Service Hybrid Connection.
az relay hyco delete [--ids]
[--name]
[--namespace-name]
[--resource-group]
[--subscription]
Deletes the Relay Service Hybrid Connection
az relay hyco delete --resource-group myresourcegroup --namespace-name mynamespace --name myhyco
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 of Hybrid Connection.
Name of Namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
List the Hybrid Connection by Relay Service Namespace.
az relay hyco list --namespace-name
--resource-group
[--max-items]
[--next-token]
Get the Hybrid Connections by Namespace.
az relay hyco list --resource-group myresourcegroup --namespace-name mynamespace
Name of Namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Shows the Relay Service Hybrid Connection Details.
az relay hyco show [--ids]
[--name]
[--namespace-name]
[--resource-group]
[--subscription]
Shows the Hybrid Connection details.
az relay hyco show --resource-group myresourcegroup --namespace-name mynamespace --name myhyco
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 of Hybrid Connection.
Name of Namespace.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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]
Updates existing Relay Service Hybrid Connection.
az relay hyco update --resource-group myresourcegroup --namespace-name mynamespace --name myhyco
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>
.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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 of Hybrid Connection.
Name of Namespace.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Indicates whether client authorization is required.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Enumerates the possible values for the status of a messaging entity.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Endpoint metadata.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: