Share via

az eventgrid namespace client

  • Preview
  • Reference

Note

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

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage eventgrid namespace client.

Commands

Name Description Type Status
az eventgrid namespace client create

Create a client.

 Extension Preview
az eventgrid namespace client delete

Delete an existing client.

 Extension Preview
az eventgrid namespace client list

List all the client under a namespace.

 Extension Preview
az eventgrid namespace client show

Show a client.

 Extension Preview
az eventgrid namespace client update

Update a client.

 Extension Preview
az eventgrid namespace client wait

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

 Extension Preview

az eventgrid namespace client create

Preview

Command group 'az eventgrid namespace client' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a client.

az eventgrid namespace client create --client-name
                                     --namespace-name
                                     --resource-group
                                     [--attributes]
                                     [--authentication]
                                     [--authentication-name]
                                     [--client-certificate-authentication]
                                     [--description]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--state {Disabled, Enabled}]

Examples

Create client

az eventgrid namespace client create -g rg --namespace-name name -n client-name  --attributes "{'room':'345','floor':5}" --client-certificate-authentication "{validationScheme:SubjectMatchesAuthenticationName}"

Required Parameters

--client-name --name -n

The client name.

--namespace-name

Name of the namespace.

--resource-group -g

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

Optional Parameters

--attributes

Attributes for the client. Support json-file and yaml-file.

--authentication

Authentication information for the client. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--authentication-name

The name presented by the client for authentication. The default value is the name of the resource.

--client-certificate-authentication

The client certificate authentication information. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--description

Description for the Client resource.

--no-wait

Do not wait for the long-running operation to finish.

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

Indicates if the client is enabled or not. Default value is Enabled.

Accepted values: Disabled, Enabled
Default value: Enabled
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 eventgrid namespace client delete

Preview

Command group 'az eventgrid namespace client' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an existing client.

az eventgrid namespace client delete [--client-name]
                                     [--ids]
                                     [--namespace-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Examples

Delete client

az eventgrid namespace client delete -g rg --namespace-name name -n client-name

Optional Parameters

--client-name --name -n

Name of the client.

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

--namespace-name

Name of the namespace.

--no-wait

Do not wait for the long-running operation to finish.

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
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 eventgrid namespace client list

Preview

Command group 'az eventgrid namespace client' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all the client under a namespace.

az eventgrid namespace client list --namespace-name
                                   --resource-group
                                   [--filter]
                                   [--max-items]
                                   [--next-token]
                                   [--top]

Examples

List client

az eventgrid namespace client list -g rg --namespace-name name

Required Parameters

--namespace-name

Name of the namespace.

--resource-group -g

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

Optional Parameters

--filter

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

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

--top

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

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 eventgrid namespace client show

Preview

Command group 'az eventgrid namespace client' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show a client.

az eventgrid namespace client show [--client-name]
                                   [--ids]
                                   [--namespace-name]
                                   [--resource-group]
                                   [--subscription]

Examples

Show client

az eventgrid namespace client show -g rg --namespace-name name -n client-name

Optional Parameters

--client-name --name -n

Name of the client.

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

--namespace-name

Name of the 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 eventgrid namespace client update

Preview

Command group 'az eventgrid namespace client' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a client.

az eventgrid namespace client update [--add]
                                     [--attributes]
                                     [--authentication]
                                     [--client-certificate-authentication]
                                     [--client-name]
                                     [--description]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--ids]
                                     [--namespace-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--state {Disabled, Enabled}]
                                     [--subscription]

Examples

Update client

az eventgrid namespace client update -g rg --namespace-name name -n client-name --description test

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

--attributes

Attributes for the client. Support json-file and yaml-file.

--authentication

Authentication information for the client. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--client-certificate-authentication

The client certificate authentication information. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--client-name --name -n

Name of the client.

--description

Description for the Client resource.

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

--namespace-name

Name of the namespace.

--no-wait

Do not wait for the long-running operation to finish.

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.

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

--state

Indicates if the client is enabled or not. Default value is Enabled.

Accepted values: Disabled, Enabled
--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 eventgrid namespace client wait

Preview

Command group 'az eventgrid namespace client' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az eventgrid namespace client wait [--client-name]
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--ids]
                                   [--interval]
                                   [--namespace-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Optional Parameters

--client-name --name -n

Name of the client.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

Default value: 30
--namespace-name

Name of the 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.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
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.