ssl.yml

### YamlMime:AzureCLIGroup
uid: az_webapp_config_ssl
name: az webapp config ssl
importantNote: >-
  > [!NOTE]

  > This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
  Configure SSL certificates for web apps.
status: GA
sourceType: Core and Extension
directCommands:
- uid: az_webapp_config_ssl_bind
  name: az webapp config ssl bind
  summary: |-
    Bind an SSL certificate to a web app.
  status: GA
  sourceType: Core
  syntax: >-
    az webapp config ssl bind --certificate-thumbprint
                              --ssl-type {IP, SNI}
                              [--hostname]
                              [--ids]
                              [--name]
                              [--resource-group]
                              [--slot]
                              [--subscription]
  examples:
  - summary: |-
      Bind an SSL certificate to a web app. (autogenerated)
    syntax: az webapp config ssl bind --certificate-thumbprint {certificate-thumbprint} --name MyWebapp --resource-group MyResourceGroup --ssl-type SNI
  requiredParameters:
  - isRequired: true
    name: --certificate-thumbprint
    summary: |-
      The ssl cert thumbprint.
  - isRequired: true
    name: --ssl-type
    parameterValueGroup: "IP, SNI"
    summary: |-
      The ssl cert type.
  optionalParameters:
  - name: --hostname
    summary: |-
      The custom domain name. If empty, hostnames will be selected automatically.
  - name: --ids
    summary: |-
      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: --name -n
    summary: |-
      Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using `az configure --defaults web=<name>`.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --slot -s
    summary: |-
      The name of the slot. Default to the productions slot if not specified.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_webapp_config_ssl_bind(appservice-kube)
  name: az webapp config ssl bind
  extensionSuffix: appservice-kube
  summary: |-
    Bind an SSL certificate to a web app.
  status: GA
  sourceType: Extension
  syntax: >-
    az webapp config ssl bind --certificate-thumbprint
                              --ssl-type {IP, SNI}
                              [--ids]
                              [--name]
                              [--resource-group]
                              [--slot]
                              [--subscription]
  examples:
  - summary: |-
      Bind an SSL certificate to a web app. (autogenerated)
    syntax: az webapp config ssl bind --certificate-thumbprint {certificate-thumbprint} --name MyWebapp --resource-group MyResourceGroup --ssl-type SNI
  requiredParameters:
  - isRequired: true
    name: --certificate-thumbprint
    summary: |-
      The ssl cert thumbprint.
  - isRequired: true
    name: --ssl-type
    parameterValueGroup: "IP, SNI"
    summary: |-
      The ssl cert type.
  optionalParameters:
  - name: --ids
    summary: |-
      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: --name -n
    summary: |-
      Name of the web app. You can configure the default using `az configure --defaults web=<name>`.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --slot -s
    summary: |-
      The name of the slot. Default to the productions slot if not specified.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_webapp_config_ssl_create
  name: az webapp config ssl create
  summary: |-
    Create a Managed Certificate for a hostname in a webapp app.
  status: Preview
  isPreview: true
  previewOrExperimentalInfo: 'This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus'
  sourceType: Core
  syntax: >-
    az webapp config ssl create --hostname
                                --name
                                --resource-group
                                [--certificate-name]
                                [--slot]
  examples:
  - summary: |-
      Create a Managed Certificate for cname.mycustomdomain.com.
    syntax: az webapp config ssl create --resource-group MyResourceGroup --name MyWebapp --hostname cname.mycustomdomain.com
  requiredParameters:
  - isRequired: true
    name: --hostname
    summary: |-
      The custom domain name.
  - isRequired: true
    name: --name -n
    summary: |-
      Name of the web app.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --certificate-name
    summary: |-
      The name of the certificate.
  - name: --slot -s
    summary: |-
      The name of the slot. Default to the productions slot if not specified.
- uid: az_webapp_config_ssl_delete
  name: az webapp config ssl delete
  summary: |-
    Delete an SSL certificate from a web app.
  status: GA
  sourceType: Core
  syntax: >-
    az webapp config ssl delete --certificate-thumbprint
                                --resource-group
  examples:
  - summary: |-
      Delete an SSL certificate from a web app. (autogenerated)
    syntax: az webapp config ssl delete --certificate-thumbprint {certificate-thumbprint} --resource-group MyResourceGroup
  requiredParameters:
  - isRequired: true
    name: --certificate-thumbprint
    summary: |-
      The ssl cert thumbprint.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- uid: az_webapp_config_ssl_import
  name: az webapp config ssl import
  summary: |-
    Import an SSL or App Service Certificate to a web app from Key Vault.
  status: GA
  sourceType: Core
  syntax: >-
    az webapp config ssl import --key-vault
                                --key-vault-certificate-name
                                [--certificate-name]
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]
  examples:
  - summary: |-
      Import an SSL or App Service Certificate certificate to a web app from Key Vault.
    syntax: az webapp config ssl import --resource-group MyResourceGroup --name MyWebapp --key-vault MyKeyVault --key-vault-certificate-name MyCertificateName
  - summary: |-
      Import an SSL or App Service Certificate to a web app from Key Vault using resource id (typically if Key Vault is in another subscription).
    syntax: az webapp config ssl import --resource-group MyResourceGroup --name MyWebapp --key-vault '/subscriptions/[sub id]/resourceGroups/[rg]/providers/Microsoft.KeyVault/vaults/[vault name]' --key-vault-certificate-name MyCertificateName
  requiredParameters:
  - isRequired: true
    name: --key-vault
    summary: |-
      The name or resource ID of the Key Vault.
  - isRequired: true
    name: --key-vault-certificate-name
    summary: |-
      The name of the certificate in Key Vault.
  optionalParameters:
  - name: --certificate-name
    summary: |-
      The name of the certificate.
  - name: --ids
    summary: |-
      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: --name -n
    summary: |-
      Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using `az configure --defaults web=<name>`.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_webapp_config_ssl_list
  name: az webapp config ssl list
  summary: |-
    List SSL certificates for a web app.
  status: GA
  sourceType: Core
  syntax: az webapp config ssl list --resource-group
  examples:
  - summary: |-
      List SSL certificates for a web app. (autogenerated)
    syntax: az webapp config ssl list --resource-group MyResourceGroup
  requiredParameters:
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- uid: az_webapp_config_ssl_show
  name: az webapp config ssl show
  summary: |-
    Show the details of an SSL certificate for a web app.
  status: GA
  sourceType: Core
  syntax: >-
    az webapp config ssl show --certificate-name
                              --resource-group
  examples:
  - summary: |-
      Show the details of an SSL certificate for a web app. (autogenerated)
    syntax: az webapp config ssl show --resource-group MyResourceGroup --certificate-name cname.mycustomdomain.com
  requiredParameters:
  - isRequired: true
    name: --certificate-name
    summary: |-
      The name of the certificate.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- uid: az_webapp_config_ssl_unbind
  name: az webapp config ssl unbind
  summary: |-
    Unbind an SSL certificate from a web app.
  status: GA
  sourceType: Core
  syntax: >-
    az webapp config ssl unbind --certificate-thumbprint
                                [--hostname]
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--slot]
                                [--subscription]
  requiredParameters:
  - isRequired: true
    name: --certificate-thumbprint
    summary: |-
      The ssl cert thumbprint.
  optionalParameters:
  - name: --hostname
    summary: |-
      The custom domain name. If empty, hostnames will be selected automatically.
  - name: --ids
    summary: |-
      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: --name -n
    summary: |-
      Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using `az configure --defaults web=<name>`.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --slot -s
    summary: |-
      The name of the slot. Default to the productions slot if not specified.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_webapp_config_ssl_unbind(appservice-kube)
  name: az webapp config ssl unbind
  extensionSuffix: appservice-kube
  summary: |-
    Unbind an SSL certificate from a web app.
  status: GA
  sourceType: Extension
  syntax: >-
    az webapp config ssl unbind --certificate-thumbprint
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--slot]
                                [--subscription]
  requiredParameters:
  - isRequired: true
    name: --certificate-thumbprint
    summary: |-
      The ssl cert thumbprint.
  optionalParameters:
  - name: --ids
    summary: |-
      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: --name -n
    summary: |-
      Name of the web app. You can configure the default using `az configure --defaults web=<name>`.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --slot -s
    summary: |-
      The name of the slot. Default to the productions slot if not specified.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_webapp_config_ssl_upload
  name: az webapp config ssl upload
  summary: |-
    Upload an SSL certificate to a web app.
  status: GA
  sourceType: Core
  syntax: >-
    az webapp config ssl upload --certificate-file
                                --certificate-password
                                [--certificate-name]
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--slot]
                                [--subscription]
  examples:
  - summary: |-
      Upload an SSL certificate to a web app. (autogenerated)
    syntax: az webapp config ssl upload --certificate-file {certificate-file} --certificate-password {certificate-password} --name MyWebapp     --resource-group MyResourceGroup
  requiredParameters:
  - isRequired: true
    name: --certificate-file
    summary: |-
      The filepath for the .pfx file.
  - isRequired: true
    name: --certificate-password
    summary: |-
      The ssl cert password.
  optionalParameters:
  - name: --certificate-name
    summary: |-
      The name of the certificate.
  - name: --ids
    summary: |-
      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: --name -n
    summary: |-
      Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using `az configure --defaults web=<name>`.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --slot -s
    summary: |-
      The name of the slot. Default to the productions slot if not specified.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
commands:
- az_webapp_config_ssl_bind
- az_webapp_config_ssl_bind(appservice-kube)
- az_webapp_config_ssl_create
- az_webapp_config_ssl_delete
- az_webapp_config_ssl_import
- az_webapp_config_ssl_list
- az_webapp_config_ssl_show
- az_webapp_config_ssl_unbind
- az_webapp_config_ssl_unbind(appservice-kube)
- az_webapp_config_ssl_upload
globalParameters:
- name: --debug
  summary: |-
    Increase logging verbosity to show all debug logs.
- name: --help -h
  summary: |-
    Show this help message and exit.
- name: --only-show-errors
  summary: |-
    Only show errors, suppressing warnings.
- name: --output -o
  defaultValue: "json"
  parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
  summary: |-
    Output format.
- name: --query
  summary: |-
    JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
  summary: |-
    Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
  summary: |-
    Increase logging verbosity. Use --debug for full debug logs.
metadata:
  description: Configure SSL certificates for web apps.