The Microsoft Azure provider package offers support for all Azure services and their properties.
Services are exposed as types from modules such as
storage, among many others. Using this
package allows you to programmatically declare instances of any Azure services using infrastructure as code, which
Pulumi then uses to drive the Azure Resource Manager (ARM) API.
If this is your first time using this package, these two resources may be helpful:
- Azure Getting Started Guide: Get up and running quickly.
- Azure Pulumi Setup Documentation: How to configure Pulumi for use with your Azure account.
Use the navigation below to see detailed documentation, including sample code, for each of the supported Azure services.
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the
pulumi/pulumi-azurerepo; however, if that doesn’t turn up anything, please consult the source
var azure = require("@pulumi/azure");
import * as azure from "@pulumi/azure";
const AustraliaCentral: Location = "australiacentral";
const AustraliaCentral2: Location = "australiacentral2";
const AustraliaEast: Location = "australiaeast";
const AustraliaSouthEast: Location = "australiasoutheast";
const BrazilSouth: Location = "brazilsouth";
const CanadaCentral: Location = "canadacentral";
const CanadaEast: Location = "canadaeast";
const CentralIndia: Location = "centralindia";
const CentralUS: Location = "centralus";
const EastAsia: Location = "eastasia";
const EastUS: Location = "eastus";
const EastUS2: Location = "eastus2";
const FranceCentral: Location = "francecentral";
const FranceSouth: Location = "francesouth";
const JapanEast: Location = "japaneast";
const JapanWest: Location = "japanwest";
const KoreaCentral: Location = "koreacentral";
const KoreaSouth: Location = "koreasouth";
const NorthCentralUS: Location = "northcentralus";
const NorthEurope: Location = "northeurope";
const SouthAfricaNorth: Location = "southafricanorth";
const SouthAfricaWest: Location = "southafricawest";
const SouthCentralUS: Location = "southcentralus";
const SouthEastAsia: Location = "southeastasia";
const SouthIndia: Location = "southindia";
const UAECentral: Location = "uaecentral";
const UAENorth: Location = "uaenorth";
const UKSouth: Location = "uksouth";
const UKWest: Location = "ukwest";
const WestCentralUS: Location = "westcentralus";
const WestEurope: Location = "westeurope";
const WestIndia: Location = "westindia";
const WestUS: Location = "westus";
const WestUS2: Location = "westus2";
class Provider extends ProviderResource
The provider type for the azurerm package. By default, resources use package-wide configuration
settings, however an explicit
Provider instance may be created and passed during resource
construction to achieve fine-grained programmatic control over provider settings. See the
documentation for more information.
This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/index.html.markdown.
new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)
Create a Provider resource with the given unique name, arguments, and options.
nameThe unique name of the resource.
argsThe arguments to use to populate this resource's properties.
optsA bag of options that control this resource's behavior.
getProvider(moduleMember: string): ProviderResource | undefined
Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
static register(provider: ProviderResource | undefined): Promise<string | undefined>
id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
type Location = "eastasia" | "southeastasia" | "centralus" | "eastus" | "eastus2" | "westus" | "westus2" | "northcentralus" | "southcentralus" | "northeurope" | "westeurope" | "japanwest" | "japaneast" | "brazilsouth" | "australiaeast" | "australiasoutheast" | "australiacentral" | "australiacentral2" | "southindia" | "centralindia" | "westindia" | "canadacentral" | "canadaeast" | "uksouth" | "ukwest" | "westcentralus" | "koreacentral" | "koreasouth" | "francecentral" | "francesouth" | "southafricanorth" | "southafricawest" | "uaecentral" | "uaenorth";
type Overwrite = Pick<T, Diff<keyof T, keyof U>> & U;
The set of arguments for constructing a Provider resource.
The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
The Client ID which should be used.
The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
This will disable the x-ms-correlation-request-id header.
This will disable the Terraform Partner ID which is used if a custom
partner_id isn’t specified.
The Cloud Environment which should be used. Possible values are public, usgovernment, german, and china. Defaults to public.
The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
This will cause the AzureRM Provider to skip verifying the credentials being used are valid.
Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they’re not already registered?
The Subscription ID which should be used.
The Tenant ID which should be used.
Allowed Managed Service Identity be used for Authentication.