az relay wcfrelay

  • Reference

Manage Azure Relay Service WCF Relay and Authorization Rule.

Commands

Name Description Type Status
az relay wcfrelay authorization-rule

Manage Azure Relay Service WCF Relay Authorization Rule.

 Core GA
az relay wcfrelay authorization-rule create

Create Authorization Rule for the given Relay Service WCF Relay.

 Core GA
az relay wcfrelay authorization-rule delete

Delete the Authorization Rule of Relay Service WCF Relay.

 Core GA
az relay wcfrelay authorization-rule keys

Manage Azure Authorization Rule keys for Relay Service WCF Relay.

 Core GA
az relay wcfrelay authorization-rule keys list

List the keys and connection strings of Authorization Rule for the given Relay Service WCF Relay.

 Core GA
az relay wcfrelay authorization-rule keys renew

Regenerate keys of Authorization Rule for Relay Service WCF Relay.

 Core GA
az relay wcfrelay authorization-rule list

List of Authorization Rule by Relay Service WCF Relay.

 Core GA
az relay wcfrelay authorization-rule show

Show properties of Authorization Rule for the given Relay Service WCF Relay.

 Core GA
az relay wcfrelay authorization-rule update

Update Authorization Rule for the given Relay Service WCF Relay.

 Core GA
az relay wcfrelay create

Create the Relay Service WCF Relay.

 Core GA
az relay wcfrelay delete

Deletes the Relay Service WCF Relay.

 Core GA
az relay wcfrelay list

List the WCF Relay by Relay Service Namespace.

 Core GA
az relay wcfrelay show

Shows the Relay Service WCF Relay Details.

 Core GA
az relay wcfrelay update

Updates existing Relay Service WCF Relay.

 Core GA

az relay wcfrelay create

Edit

Create the Relay Service WCF Relay.

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

Examples

Create Relay Service WCF Relay.

az relay wcfrelay create --resource-group myresourcegroup --namespace-name mynamespace --name myrelay --relay-type NetTcp

Required Parameters

--name -n

Name of WCF Relay.

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

--relay-type

Relay type. Allowed values: Http, NetTcp.

accepted values: Http, NetTcp
default value: NetTcp
--requires-client-authorization -c

Indicates whether client authorization is required.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--requires-transport-security -t

Indicates whether transport security 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 wcfrelay delete

Edit

Deletes the Relay Service WCF Relay.

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

Examples

Deletes the wcfrelay

az relay wcfrelay delete --resource-group myresourcegroup --namespace-name mynamespace --name myrelay

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

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

Edit

List the WCF Relay by Relay Service Namespace.

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

Examples

Get the WCF Relays by Relay Service Namespace.

az relay wcfrelay 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 wcfrelay show

Edit

Shows the Relay Service WCF Relay Details.

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

Examples

Shows the Relay Service WCF Relay Details

az relay wcfrelay show --resource-group myresourcegroup --namespace-name mynamespace --name myrelay

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

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

Edit

Updates existing Relay Service WCF Relay.

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

Examples

Updates Relay Service WCF Relay.

az relay wcfrelay update --resource-group myresourcegroup --namespace-name mynamespace --name myrelay

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

--namespace-name

Name of Namespace.

--relay-type

Relay type.

accepted values: Http, NetTcp
--remove

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

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

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