Share via


az spring-cloud certificate

Note

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

This command group is implicitly deprecated because command group 'spring-cloud' is deprecated and will be removed in a future release. Use 'spring' instead.

Commands to manage certificates.

Commands

Name Description Type Status
az spring-cloud certificate add

Add a certificate in Azure Spring Cloud.

Extension Deprecated
az spring-cloud certificate list

List all certificates in Azure Spring Cloud.

Extension Deprecated
az spring-cloud certificate list-reference-app

List all the apps reference an existing certificate in the Azure Spring Cloud.

Extension Deprecated
az spring-cloud certificate remove

Remove a certificate in Azure Spring Cloud.

Extension Deprecated
az spring-cloud certificate show

Show a certificate in Azure Spring Cloud.

Extension Deprecated

az spring-cloud certificate add

Deprecated

This command is implicitly deprecated because command group 'spring-cloud certificate' is deprecated and will be removed in a future release. Use 'spring certificate' instead.

Add a certificate in Azure Spring Cloud.

az spring-cloud certificate add --name
                                --resource-group
                                --service
                                [--only-public-cert {false, true}]
                                [--public-certificate-file]
                                [--vault-certificate-name]
                                [--vault-uri]

Examples

Import certificate from key vault.

az spring-cloud certificate add --name MyCertName --vault-uri MyKeyVaultUri --vault-certificate-name MyKeyVaultCertName --service MyCluster --resource-group MyResourceGroup

Required Parameters

--name -n

Name of certificate.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--only-public-cert

If true, only import public certificate part from key vault.

accepted values: false, true
default value: False
--public-certificate-file -f

A file path for the public certificate to be uploaded.

--vault-certificate-name

The certificate name in key vault.

--vault-uri

The key vault uri where store the certificate.

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 spring-cloud certificate list

Deprecated

This command is implicitly deprecated because command group 'spring-cloud certificate' is deprecated and will be removed in a future release. Use 'spring certificate' instead.

List all certificates in Azure Spring Cloud.

az spring-cloud certificate list --resource-group
                                 --service
                                 [--certificate-type {ContentCertificate, KeyVaultCertificate}]

Examples

List all certificates in spring cloud service.

az spring-cloud certificate list --service MyCluster --resource-group MyResourceGroup -o table

Required Parameters

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

Optional Parameters

--certificate-type

Type of uploaded certificate.

accepted values: ContentCertificate, KeyVaultCertificate
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 spring-cloud certificate list-reference-app

Deprecated

This command is implicitly deprecated because command group 'spring-cloud certificate' is deprecated and will be removed in a future release. Use 'spring certificate' instead.

List all the apps reference an existing certificate in the Azure Spring Cloud.

az spring-cloud certificate list-reference-app --name
                                               --resource-group
                                               --service

Examples

List all the apps reference an existing certificate in spring cloud service.

az spring-cloud certificate list-reference-app --service MyCluster --resource-group MyResourceGroup --name MyCertName

Required Parameters

--name -n

Name of certificate.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

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 spring-cloud certificate remove

Deprecated

This command is implicitly deprecated because command group 'spring-cloud certificate' is deprecated and will be removed in a future release. Use 'spring certificate' instead.

Remove a certificate in Azure Spring Cloud.

az spring-cloud certificate remove --name
                                   --resource-group
                                   --service

Required Parameters

--name -n

Name of certificate.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

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 spring-cloud certificate show

Deprecated

This command is implicitly deprecated because command group 'spring-cloud certificate' is deprecated and will be removed in a future release. Use 'spring certificate' instead.

Show a certificate in Azure Spring Cloud.

az spring-cloud certificate show --name
                                 --resource-group
                                 --service

Required Parameters

--name -n

Name of certificate.

--resource-group -g

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

--service -s

Name of Azure Spring Cloud, you can configure the default service using az configure --defaults spring-cloud=.

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.