az notification-hub
Note
This reference is part of the notification-hub extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az notification-hub command. Learn more about extensions.
Manage notification hubs.
Commands
Name | Description | Type | Status |
---|---|---|---|
az notification-hub authorization-rule |
Commands to manage notification hubs authorization rule. |
Extension | GA |
az notification-hub authorization-rule create |
Create an authorization rule for a notification hub. |
Extension | Experimental |
az notification-hub authorization-rule delete |
Delete a notificationHub authorization rule. |
Extension | Experimental |
az notification-hub authorization-rule list |
List the authorization rules for a notification hub. |
Extension | Experimental |
az notification-hub authorization-rule list-keys |
List the primary and secondary connection strings to the notification hub. |
Extension | Experimental |
az notification-hub authorization-rule regenerate-keys |
Regenerates the primary/secondary keys to the notification hub authorization rule. |
Extension | Experimental |
az notification-hub authorization-rule show |
Show an authorization rule for a notification hub by name. |
Extension | Experimental |
az notification-hub check-availability |
Checks the availability of the given notification hub in a namespace. |
Extension | Experimental |
az notification-hub create |
Create a notification hub in a namespace. |
Extension | Experimental |
az notification-hub credential |
Commands to manage notification hub credential. |
Extension | GA |
az notification-hub credential adm | Extension | GA | |
az notification-hub credential adm update |
Update credential for Amazon(ADM). |
Extension | Experimental |
az notification-hub credential apns | Extension | GA | |
az notification-hub credential apns update |
Update credential for Apple(APNS). |
Extension | Experimental |
az notification-hub credential baidu | Extension | GA | |
az notification-hub credential baidu update |
Update credential for Baidu(Andrioid China). |
Extension | Experimental |
az notification-hub credential gcm | Extension | GA | |
az notification-hub credential gcm update |
Update the Google GCM/FCM API key. |
Extension | Experimental |
az notification-hub credential list |
Lists the PNS credentials associated with a notification hub. |
Extension | Experimental |
az notification-hub credential mpns | Extension | GA | |
az notification-hub credential mpns update |
Update credential for Windows Phone(MPNS). |
Extension | Experimental |
az notification-hub credential wns | Extension | GA | |
az notification-hub credential wns update |
Update credential for Windows(WNS). |
Extension | Experimental |
az notification-hub delete |
Delete a notification hub associated with a namespace. |
Extension | Experimental |
az notification-hub list |
List the notification hubs associated with a namespace. |
Extension | Experimental |
az notification-hub namespace |
Commands to manage notification hub namespace. |
Extension | GA |
az notification-hub namespace authorization-rule |
Commands to manage notification hubs namespace authorization rule. |
Extension | GA |
az notification-hub namespace authorization-rule create |
Create an authorization rule for a namespace. |
Extension | Experimental |
az notification-hub namespace authorization-rule delete |
Delete a namespace authorization rule. |
Extension | Experimental |
az notification-hub namespace authorization-rule list |
List the authorization rules for a namespace. |
Extension | Experimental |
az notification-hub namespace authorization-rule list-keys |
List the primary and secondary connection strings to the namespace. |
Extension | Experimental |
az notification-hub namespace authorization-rule regenerate-keys |
Regenerate the primary/secondary keys to the namespace authorization rule. |
Extension | Experimental |
az notification-hub namespace authorization-rule show |
Get an authorization rule for a namespace by name. |
Extension | Experimental |
az notification-hub namespace check-availability |
Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name. |
Extension | Experimental |
az notification-hub namespace create |
Create a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent. |
Extension | Experimental |
az notification-hub namespace delete |
Delete an existing namespace. This operation also removes all associated notificationHubs under the namespace. |
Extension | Experimental |
az notification-hub namespace list |
List available namespaces. |
Extension | Experimental |
az notification-hub namespace show |
Return the description for the specified namespace. |
Extension | Experimental |
az notification-hub namespace update |
Update a service namespace. The namespace's resource manifest is immutable and cannot be modified. |
Extension | Experimental |
az notification-hub namespace wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az notification-hub show |
Show the notification hub information. |
Extension | Experimental |
az notification-hub update |
Update a notification hub in a namespace. |
Extension | Experimental |
az notification-hub check-availability
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Checks the availability of the given notification hub in a namespace.
az notification-hub check-availability --name
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]
Examples
Check the availability of the given notification hub name
az notification-hub check-availability --resource-group MyResourceGroup --namespace-name "locp-newns" --name my-hub
Required Parameters
Resource name.
Property | Value |
---|---|
Parameter group: | Parameters Arguments |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
The namespace name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az notification-hub create
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a notification hub in a namespace.
az notification-hub create --name
--namespace-name
--resource-group
[--location]
[--registration-ttl]
[--tags]
Examples
Create a notification hub
az notification-hub create --resource-group MyResourceGroup --namespace-name my-namespace --name my-hub --location "South Central US"
Required Parameters
The notification hub name.
The namespace name.
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.
Resource location When not specified, the location of the resource group will be used.
Property | Value |
---|---|
Parameter group: | Parameters Arguments |
The RegistrationTtl of the created NotificationHub.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Parameters Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az notification-hub delete
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete a notification hub associated with a namespace.
az notification-hub delete [--ids]
[--name]
[--namespace-name]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete a notification hub
az notification-hub delete --resource-group MyResourceGroup --namespace-name my-namespace --name my-hub
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
The notification hub name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The namespace name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az notification-hub list
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List the notification hubs associated with a namespace.
az notification-hub list --namespace-name
--resource-group
[--max-items]
[--next-token]
Examples
List the notification hubs
az notification-hub list --resource-group MyResourceGroup --namespace-name my-namespace
Required Parameters
The namespace name.
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.
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 |
Token to specify where to start paginating. This is the token value from a previously truncated response.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az notification-hub show
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show the notification hub information.
az notification-hub show [--ids]
[--name]
[--namespace-name]
[--resource-group]
[--subscription]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
The notification hub name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The namespace name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az notification-hub update
This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update a notification hub in a namespace.
az notification-hub update [--add]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--location]
[--name --notification-hub-name]
[--namespace-name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
Examples
Update the notification hub
az notification-hub update --resource-group MyResourceGroup --namespace-name my-namespace --name "sdk-notificationHubs-8708"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
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 location.
Property | Value |
---|---|
Parameter group: | Parameters Arguments |
The notification hub name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The namespace name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
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 |
Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Parameters Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |