az functionapp config ssl

  • Reference

Configure SSL certificates.

Commands

Name Description Type Status
az functionapp config ssl bind

Bind an SSL certificate to a function app.

 Core GA
az functionapp config ssl create

Create a Managed Certificate for a hostname in a function app.

 Core Preview
az functionapp config ssl delete

Delete an SSL certificate from a function app.

 Core GA
az functionapp config ssl import

Import an SSL certificate to a function app from Key Vault.

 Core GA
az functionapp config ssl list

List SSL certificates for a function app.

 Core GA
az functionapp config ssl show

Show the details of an SSL certificate for a function app.

 Core GA
az functionapp config ssl unbind

Unbind an SSL certificate from a function app.

 Core GA
az functionapp config ssl upload

Upload an SSL certificate to a function app.

 Core GA

az functionapp config ssl bind

Edit

Bind an SSL certificate to a function app.

az functionapp config ssl bind --certificate-thumbprint
                               --ssl-type {IP, SNI}
                               [--hostname]
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--slot]
                               [--subscription]

Examples

Bind an SSL certificate to a function app. (autogenerated)

az functionapp config ssl bind --certificate-thumbprint {certificate-thumbprint} --name MyFunctionApp --resource-group MyResourceGroup --ssl-type SNI

Required Parameters

--certificate-thumbprint

The ssl cert thumbprint.

--ssl-type

The ssl cert type.

accepted values: IP, SNI

Optional Parameters

--hostname

The custom domain name. If empty, hostnames will be selected automatically.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--resource-group -g

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

--slot -s

The name of the slot. Default to the productions slot if not specified.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 functionapp config ssl create

Edit
Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Managed Certificate for a hostname in a function app.

az functionapp config ssl create --hostname
                                 --name
                                 --resource-group
                                 [--certificate-name]
                                 [--slot]

Examples

Create a Managed Certificate for cname.mycustomdomain.com.

az functionapp config ssl create --resource-group MyResourceGroup --name MyWebapp --hostname cname.mycustomdomain.com

Required Parameters

--hostname

The custom domain name.

--name -n

Name of the web app.

--resource-group -g

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

Optional Parameters

--certificate-name

The name of the certificate.

--slot -s

The name of the slot. Default to the productions slot if not specified.

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 functionapp config ssl delete

Edit

Delete an SSL certificate from a function app.

az functionapp config ssl delete --certificate-thumbprint
                                 --resource-group

Required Parameters

--certificate-thumbprint

The ssl cert thumbprint.

--resource-group -g

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

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 functionapp config ssl import

Edit

Import an SSL certificate to a function app from Key Vault.

az functionapp config ssl import --key-vault
                                 --key-vault-certificate-name
                                 [--certificate-name]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

Examples

Import an SSL certificate to a function app from Key Vault.

az functionapp config ssl import --resource-group MyResourceGroup --name MyFunctionApp --key-vault MyKeyVault --key-vault-certificate-name MyCertificateName

Import an SSL certificate to a function app from Key Vault using resource id (typically if Key Vault is in another subscription).

az functionapp config ssl import --resource-group MyResourceGroup --name MyFunctionApp --key-vault '/subscriptions/[sub id]/resourceGroups/[rg]/providers/Microsoft.KeyVault/vaults/[vault name]' --key-vault-certificate-name MyCertificateName

Required Parameters

--key-vault

The name or resource ID of the Key Vault.

--key-vault-certificate-name

The name of the certificate in Key Vault.

Optional Parameters

--certificate-name

The name of the certificate.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 functionapp config ssl list

Edit

List SSL certificates for a function app.

az functionapp config ssl list --resource-group

Examples

List SSL certificates for a function app. (autogenerated)

az functionapp config ssl list --resource-group MyResourceGroup

Required Parameters

--resource-group -g

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

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 functionapp config ssl show

Edit

Show the details of an SSL certificate for a function app.

az functionapp config ssl show --certificate-name
                               --resource-group

Examples

Show the details of an SSL certificate for a function app. (autogenerated)

az functionapp config ssl show --resource-group MyResourceGroup --certificate-name cname.mycustomdomain.com

Required Parameters

--certificate-name

The name of the certificate.

--resource-group -g

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

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 functionapp config ssl unbind

Edit

Unbind an SSL certificate from a function app.

az functionapp config ssl unbind --certificate-thumbprint
                                 [--hostname]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--slot]
                                 [--subscription]

Required Parameters

--certificate-thumbprint

The ssl cert thumbprint.

Optional Parameters

--hostname

The custom domain name. If empty, hostnames will be selected automatically.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--resource-group -g

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

--slot -s

The name of the slot. Default to the productions slot if not specified.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 functionapp config ssl upload

Edit

Upload an SSL certificate to a function app.

az functionapp config ssl upload --certificate-file
                                 --certificate-password
                                 [--certificate-name]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--slot]
                                 [--subscription]

Examples

Upload an SSL certificate to a function app. (autogenerated)

az functionapp config ssl upload --certificate-file {certificate-file} --certificate-password {certificate-password} --name MyFunctionApp     --resource-group MyResourceGroup

Required Parameters

--certificate-file

The filepath for the .pfx file.

--certificate-password

The ssl cert password.

Optional Parameters

--certificate-name

The name of the certificate.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the function app.

--resource-group -g

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

--slot -s

The name of the slot. Default to the productions slot if not specified.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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.