Skip to content

AzureProvider

`laktory.models.resources.providers.AzureProvider` ¤

Bases: BaseProvider, TerraformResource

Azure Provider

Examples:

from laktory import models

p = models.AzureProvider(
    client_id="${vars.AZURE_CLIENT_ID}",
    client_secret="${vars.AZURE_CLIENT_SECRET}",
)

PARAMETER	DESCRIPTION
`alias`	TYPE: `str \| VariableType` DEFAULT: `None`
`auxiliary_tenant_ids`	TYPE: `list[str \| VariableType] \| VariableType` DEFAULT: `None`
`client_certificate`	Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate TYPE: `str \| VariableType` DEFAULT: `None`
`client_certificate_password`	The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate TYPE: `str \| VariableType` DEFAULT: `None`
`client_certificate_path`	The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate. TYPE: `str \| VariableType` DEFAULT: `None`
`client_id`	The Client ID which should be used. TYPE: `str \| VariableType` DEFAULT: `None`
`client_id_file_path`	The path to a file containing the Client ID which should be used. TYPE: `str \| VariableType` DEFAULT: `None`
`client_secret`	The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret. TYPE: `str \| VariableType` DEFAULT: `None`
`client_secret_file_path`	The path to a file containing the Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret. TYPE: `str \| VariableType` DEFAULT: `None`
`disable_correlation_request_id`	This will disable the x-ms-correlation-request-id header. TYPE: `bool \| VariableType` DEFAULT: `None`
`disable_terraform_partner_id`	This will disable the Terraform Partner ID which is used if a custom partner_id isn't specified. TYPE: `bool \| VariableType` DEFAULT: `None`
`environment`	The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public. It can also be sourced from the following environment variables: AZURE_ENVIRONMENT, ARM_ENVIRONMENT TYPE: `str \| VariableType` DEFAULT: `None`
`metadata_host`	The Hostname which should be used for the Azure Metadata Service. It can also be sourced from the following environment variable: ARM_METADATA_HOSTNAME TYPE: `str \| VariableType` DEFAULT: `None`
`msi_endpoint`	The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically. TYPE: `str \| VariableType` DEFAULT: `None`
`oidc_request_token`	The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect. TYPE: `str \| VariableType` DEFAULT: `None`
`oidc_request_url`	The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect. TYPE: `str \| VariableType` DEFAULT: `None`
`oidc_token`	The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect. TYPE: `str \| VariableType` DEFAULT: `None`
`oidc_token_file_path`	The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect. TYPE: `str \| VariableType` DEFAULT: `None`
`partner_id`	A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution. TYPE: `str \| VariableType` DEFAULT: `None`
`skip_provider_registration`	Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they're not already registered? It can also be sourced from the following environment variable: ARM_SKIP_PROVIDER_REGISTRATION TYPE: `bool \| VariableType` DEFAULT: `None`
`source`	TYPE: `str \| VariableType` DEFAULT: `None`
`storage_use_azuread`	Should the AzureRM Provider use AzureAD to access the Storage Data Plane API's? It can also be sourced from the following environment variable: ARM_STORAGE_USE_AZUREAD TYPE: `bool \| VariableType` DEFAULT: `None`
`subscription_id`	The Subscription ID which should be used. It can also be sourced from the following environment variable: ARM_SUBSCRIPTION_ID TYPE: `str \| VariableType` DEFAULT: `None`
`tenant_id`	The Tenant ID which should be used. TYPE: `str \| VariableType` DEFAULT: `None`
`use_aks_workload_identity`	Allow Azure AKS Workload Identity to be used for Authentication. TYPE: `bool \| VariableType` DEFAULT: `None`
`use_cli`	Allow Azure CLI to be used for Authentication. TYPE: `bool \| VariableType` DEFAULT: `None`
`use_msi`	Allow Managed Service Identity to be used for Authentication. TYPE: `bool \| VariableType` DEFAULT: `None`
`use_oidc`	Allow OpenID Connect to be used for authentication TYPE: `bool \| VariableType` DEFAULT: `None`
`version`	TYPE: `str \| VariableType` DEFAULT: `None`