Share via

az spring certificate

  • Deprecated

Note

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

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

Commands to manage certificates.

Commands

Name Description Type Status
az spring certificate add

Add a certificate in Azure Spring Apps.

 Extension Deprecated
az spring certificate list

List all certificates in Azure Spring Apps.

 Extension Deprecated
az spring certificate list-reference-app

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

 Extension Deprecated
az spring certificate remove

Remove a certificate in Azure Spring Apps.

 Extension Deprecated
az spring certificate show

Show a certificate in Azure Spring Apps.

 Extension Deprecated
az spring certificate update

Update a certificate in Azure Spring Apps.

 Extension Deprecated

az spring certificate add

Deprecated

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

Add a certificate in Azure Spring Apps.

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

Examples

Import certificate from key vault.

az spring 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

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=<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.

--enable-auto-sync

Whether to automatically synchronize certificate from key vault.

Property Value
Default value: False
Accepted values: false, true
--only-public-cert

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

Property Value
Default value: False
Accepted values: false, true
--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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring certificate list

Deprecated

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

List all certificates in Azure Spring Apps.

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

Examples

List all certificates in Spring service.

az spring 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

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=<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.

--certificate-type

Type of uploaded certificate.

Property Value
Accepted values: ContentCertificate, KeyVaultCertificate
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring certificate list-reference-app

Deprecated

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

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

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

Examples

List all the apps reference an existing certificate in Spring service.

az spring 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

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring certificate remove

Deprecated

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

Remove a certificate in Azure Spring Apps.

az spring 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

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring certificate show

Deprecated

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

Show a certificate in Azure Spring Apps.

az spring 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

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az spring certificate update

Deprecated

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

Update a certificate in Azure Spring Apps.

az spring certificate update --name
                             --resource-group
                             --service
                             [--enable-auto-sync {false, true}]

Examples

Enable auto sync feature of a key vault certificate in Azure Spring Apps.

az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync true

Disable auto sync feature of a key vault certificate in Azure Spring Apps.

az spring certificate update --name MyCertName --service MyCluster --resource-group MyResourceGroup --enable-auto-sync false

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

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=<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.

--enable-auto-sync

Whether to automatically synchronize certificate from key vault.

Property Value
Accepted values: false, true
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False