Share via

az webpubsub custom-certificate

  • Reference

Note

This reference is part of the webpubsub extension for the Azure CLI (version 2.56.0 or higher). The extension will automatically install the first time you run an az webpubsub custom-certificate command. Learn more about extensions.

Manage WebPubSub custom certificates.

Commands

Name Description Type Status
az webpubsub custom-certificate create

Create a custom certificate of WebPubSub Service.

 Extension GA
az webpubsub custom-certificate delete

Delete a custom certificate of WebPubSub Service.

 Extension GA
az webpubsub custom-certificate list

List custom certificates of WebPubSub Service.

 Extension GA
az webpubsub custom-certificate show

Show the detail of a custom certificate of WebPubSub Service.

 Extension GA

az webpubsub custom-certificate create

Create a custom certificate of WebPubSub Service.

az webpubsub custom-certificate create --certificate-name
                                       --key-vault-base-uri
                                       --key-vault-secret-name
                                       --resource-group
                                       --webpubsub-name
                                       [--key-vault-secret-version]

Examples

Create a custom certificate

az webpubsub custom-certificate create --webpubsub-name MyWebPubSub -g MyResourceGroup --certificate-name MyCertificate --key-vault-base-uri https://myvault.vault.azure.net/ --key-vault-secret-name MySecret --key-vault-secret-version 8d35338681be4cf09b97e899cb7179b8

Required Parameters

--certificate-name

Name of the custom certificate.

--key-vault-base-uri

Key vault base URI. For example, https://contoso.vault.azure.net.

--key-vault-secret-name

Key vault secret name where certificate is stored.

--resource-group -g

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

--webpubsub-name

Name of the webpubsub.

Optional Parameters

--key-vault-secret-version

Key vault secret version where certificate is stored. If empty, will use latest version.

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 webpubsub custom-certificate delete

Delete a custom certificate of WebPubSub Service.

az webpubsub custom-certificate delete --certificate-name
                                       --resource-group
                                       --webpubsub-name

Examples

Delete a custom certificate

az webpubsub custom-certificate delete --webpubsub-name MyWebPubSub -g MyResourceGroup --certificate-name MyCertificate

Required Parameters

--certificate-name

Name of the custom certificate.

--resource-group -g

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

--webpubsub-name

Name of the webpubsub.

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 webpubsub custom-certificate list

List custom certificates of WebPubSub Service.

az webpubsub custom-certificate list --resource-group
                                     --webpubsub-name

Examples

List custom certificates

az webpubsub custom-certificate list --webpubsub-name MyWebPubSub -g MyResourceGroup

Required Parameters

--resource-group -g

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

--webpubsub-name

Name of the webpubsub.

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 webpubsub custom-certificate show

Show the detail of a custom certificate of WebPubSub Service.

az webpubsub custom-certificate show --certificate-name
                                     --resource-group
                                     --webpubsub-name

Examples

Show custom certificate

az webpubsub custom-certificate show --webpubsub-name MyWebPubSub -g MyResourceGroup --certificate-name MyCertificate

Required Parameters

--certificate-name

Name of the custom certificate.

--resource-group -g

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

--webpubsub-name

Name of the webpubsub.

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.