az notification-hub credential apns

  • Experimental
  • Reference

Note

This reference is part of the notification-hub extension for the Azure CLI (version 2.49.0 or higher). The extension will automatically install the first time you run an az notification-hub credential apns command. Learn more about extensions.

Command group 'notification-hub' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands

Name Description Type Status
az notification-hub credential apns update

Update credential for Apple(APNS).

 Extension Experimental

az notification-hub credential apns update

Experimental

Command group 'notification-hub' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update credential for Apple(APNS).

az notification-hub credential apns update --name
                                           --namespace-name
                                           --resource-group
                                           [--apns-certificate]
                                           [--app-id]
                                           [--app-name]
                                           [--certificate-key]
                                           [--endpoint]
                                           [--key-id]
                                           [--token]

Examples

Update APNS certificate

az notification-hub credential apns update --namespace-name my-namespace --notification-hub-name my-hub --apns-certificate "/path/to/certificate" --certificate-key "xxxxxx" --resource-group MyResourceGroup

Required Parameters

--name --notification-hub-name -n

The notification hub name.

--namespace-name

The namespace name.

--resource-group -g

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

Optional Parameters

--apns-certificate

The APNS certificate.

--app-id

The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode.

--app-name

The name of the application or BundleId. Specify if using Token Authentication Mode.

--certificate-key

The APNS certificate password if it exists.

--endpoint

The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'.

default value: gateway.push.apple.com
--key-id

A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode.

--token

Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode.

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.