Share via

az sphere ca-certificate

  • Reference

Note

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

Manage certificates in your resource group and catalog.

Commands

Name Description Type Status
az sphere ca-certificate download

Download the certificate for your catalog.

 Extension GA
az sphere ca-certificate download-chain

Download the certificate chain for your catalog as a PKCS#7 ".p7b" file.

 Extension GA
az sphere ca-certificate download-proof

Download a proof-of-possession certificate for your catalog for use with a provided code.

 Extension GA
az sphere ca-certificate list

List all certificates in your resource group and catalog.

 Extension GA

az sphere ca-certificate download

Download the certificate for your catalog.

az sphere ca-certificate download --catalog
                                  --output-file
                                  --resource-group
                                  [--name]

Examples

Download an active certificate using resource group and catalog name.

az sphere ca-certificate download --resource-group MyResourceGroup --catalog MyCatalog --output-file myCert.cer

Download certificate using resource group, catalog name and certificate name.

az sphere ca-certificate download --resource-group MyResourceGroup --catalog MyCatalog --name 2E7A0AF370ABC439901BBB37AF38B97 --output-file myCert.cer

Required Parameters

--catalog -c

The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list.

--output-file -of

Path and file name in which to save the certificate. Specify a relative or absolute path.

--resource-group -g

Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

Optional Parameters

--name -n

The certificate to download. Specify name. If no name is supplied, the active certificate is downloaded.

Default value: active
Value from: az sphere ca-certificate list
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 sphere ca-certificate download-chain

Download the certificate chain for your catalog as a PKCS#7 ".p7b" file.

az sphere ca-certificate download-chain --catalog
                                        --output-file
                                        --resource-group
                                        [--name]

Examples

Download a certificate chain using resource group and catalog name.

az sphere ca-certificate download-chain --resource-group MyResourceGroup --catalog MyCatalog --name 2E7A0AF370ABC439901BBB37AF38B97 --output-file myCertChain.p7b

Download an active certificate chain using resource group, catalog name and certificate name.

az sphere ca-certificate download-chain --resource-group MyResourceGroup --catalog MyCatalog --output-file myCertChain.p7b

Required Parameters

--catalog -c

The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list.

--output-file -of

Path and file name in which to save the certificate chain. Specify a relative or absolute path using a ".p7b" extension.

--resource-group -g

Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

Optional Parameters

--name -n

The certificate to download. Specify name. If no name is supplied, the active certificate is downloaded.

Default value: active
Value from: az sphere ca-certificate list
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 sphere ca-certificate download-proof

Download a proof-of-possession certificate for your catalog for use with a provided code.

az sphere ca-certificate download-proof --catalog
                                        --output-file
                                        --resource-group
                                        --verification-code
                                        [--name]

Examples

Download a proof-of-possession certificate using resource group and catalog name.

az sphere ca-certificate download-proof --resource-group MyResourceGroup --catalog MyCatalog --name 2E7A0AF370ABC439901BBB37AF38B97 --verification-code 3304517c557a3375e --output-file myCert.cer

Download an active proof-of-possession certificate using resource group, catalog name and certificate name.

az sphere ca-certificate download-proof --resource-group MyResourceGroup --catalog MyCatalog --verification-code 3304517c557a3375e --output-file myCert.cer

Required Parameters

--catalog -c

The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list.

--output-file -of

Path and file name in which to save the certificate. Specify a relative or absolute path.

--resource-group -g

Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

--verification-code -v

The verification code for the Azure Sphere Security Service to use when generating the certificate.

Optional Parameters

--name -n

The certificate to download. Specify name. If no name is supplied, the active certificate is downloaded.

Default value: active
Value from: az sphere ca-certificate list
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 sphere ca-certificate list

List all certificates in your resource group and catalog.

az sphere ca-certificate list --catalog
                              --resource-group

Examples

List all certificates in a resource group and catalog.

az sphere ca-certificate list --resource-group MyResourceGroup --catalog MyCatalog

Required Parameters

--catalog -c

The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list.

--resource-group -g

Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

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.