1. Docs
2. Reference
3. API
4. @pulumi/azure
5. config

Module config

APIs

• auxiliaryTenantIds
• clientCertificatePassword
• clientCertificatePath
• clientId
• clientSecret
• disableCorrelationRequestId
• disableTerraformPartnerId
• environment
• features
• location
• msiEndpoint
• partnerId
• skipCredentialsValidation
• skipProviderRegistration
• storageUseAzuread
• subscriptionId
• tenantId
• useMsi

APIs

let auxiliaryTenantIds

let auxiliaryTenantIds: string[] | undefined =  __config.getObject<string[]>("auxiliaryTenantIds");

let clientCertificatePassword

let clientCertificatePassword: string | undefined =  __config.get("clientCertificatePassword");

The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate

let clientCertificatePath

let clientCertificatePath: string | undefined =  __config.get("clientCertificatePath");

The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.

let clientId

let clientId: string | undefined =  __config.get("clientId");

The Client ID which should be used.

let clientSecret

let clientSecret: string | undefined =  __config.get("clientSecret");

The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.

let disableCorrelationRequestId

let disableCorrelationRequestId: boolean | undefined =  __config.getObject<boolean>("disableCorrelationRequestId");

This will disable the x-ms-correlation-request-id header.

let disableTerraformPartnerId

let disableTerraformPartnerId: boolean | undefined =  __config.getObject<boolean>("disableTerraformPartnerId");

This will disable the Terraform Partner ID which is used if a custom partner_id isn’t specified.

let environment

let environment: string | undefined =  __config.get("environment") || (utilities.getEnv("AZURE_ENVIRONMENT", "ARM_ENVIRONMENT") || "public");

The Cloud Environment which should be used. Possible values are public, usgovernment, german, and china. Defaults to public.

let features

let features: Features | undefined =  __config.getObject<outputs.config.Features>("features");

let location

let location: string | undefined =  __config.get("location") || utilities.getEnv("ARM_LOCATION");

let msiEndpoint

let msiEndpoint: string | undefined =  __config.get("msiEndpoint");

The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.

let partnerId

let partnerId: string | undefined =  __config.get("partnerId");

A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.

let skipCredentialsValidation

let skipCredentialsValidation: boolean | undefined =  __config.getObject<boolean>("skipCredentialsValidation");

This will cause the AzureRM Provider to skip verifying the credentials being used are valid.

let skipProviderRegistration

let skipProviderRegistration: boolean | undefined =  __config.getObject<boolean>("skipProviderRegistration") || (<any>utilities.getEnvBoolean("ARM_SKIP_PROVIDER_REGISTRATION") || false);

Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they’re not already registered?

let storageUseAzuread

let storageUseAzuread: boolean | undefined =  __config.getObject<boolean>("storageUseAzuread") || (<any>utilities.getEnvBoolean("ARM_STORAGE_USE_AZUREAD") || false);

Should the AzureRM Provider use AzureAD to access the Storage Data Plane API’s?

let subscriptionId

let subscriptionId: string | undefined =  __config.get("subscriptionId") || (utilities.getEnv("ARM_SUBSCRIPTION_ID") || "");

The Subscription ID which should be used.

let tenantId

let tenantId: string | undefined =  __config.get("tenantId");

The Tenant ID which should be used.

let useMsi

let useMsi: boolean | undefined =  __config.getObject<boolean>("useMsi");

Allowed Managed Service Identity be used for Authentication.