Back to Lego

Azure (deprecated)

docs/content/dns/zz_gen_azure.md

4.35.22.3 KB
Original Source
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/azure/azure.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

Configuration for Azure (deprecated).

<!--more-->
  • Code: azure
  • Since: v0.4.0

{{% notice note %}} Please contribute by adding a CLI example. {{% /notice %}}

Credentials

Environment Variable NameDescription
AZURE_CLIENT_IDClient ID
AZURE_CLIENT_SECRETClient secret
AZURE_ENVIRONMENTAzure environment, one of: public, usgovernment, german, and china
AZURE_RESOURCE_GROUPResource group
AZURE_SUBSCRIPTION_IDSubscription ID
AZURE_TENANT_IDTenant ID
instance metadata serviceIf the credentials are not set via the environment, then it will attempt to get a bearer token via the instance metadata service.

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Additional Configuration

Environment Variable NameDescription
AZURE_METADATA_ENDPOINTMetadata Service endpoint URL
AZURE_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
AZURE_PRIVATE_ZONESet to true to use Azure Private DNS Zones and not public
AZURE_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 120)
AZURE_TTLThe TTL of the TXT record used for the DNS challenge in seconds (Default: 60)
AZURE_ZONE_NAMEZone name to use inside Azure DNS service to add the TXT record in

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

More information

<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/azure/azure.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->