Come join Pulumi for the industry's first Cloud Engineering Summit! October 7–8. Save Your Spot

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Pulumi Azure

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-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.Provider(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, auxiliary_tenant_ids: Union[List[Union[str, Awaitable[str], Output[T]]], Awaitable[List[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, client_certificate_password: Union[str, Awaitable[str], Output[T], None] = None, client_certificate_path: Union[str, Awaitable[str], Output[T], None] = None, client_id: Union[str, Awaitable[str], Output[T], None] = None, client_secret: Union[str, Awaitable[str], Output[T], None] = None, disable_correlation_request_id: Union[bool, Awaitable[bool], Output[T], None] = None, disable_terraform_partner_id: Union[bool, Awaitable[bool], Output[T], None] = None, environment: Union[str, Awaitable[str], Output[T], None] = None, features: Union[ProviderFeaturesArgs, Mapping[str, Any], Awaitable[Union[ProviderFeaturesArgs, Mapping[str, Any]]], Output[T], None] = None, metadata_host: Union[str, Awaitable[str], Output[T], None] = None, metadata_url: Union[str, Awaitable[str], Output[T], None] = None, msi_endpoint: Union[str, Awaitable[str], Output[T], None] = None, partner_id: Union[str, Awaitable[str], Output[T], None] = None, skip_credentials_validation: Union[bool, Awaitable[bool], Output[T], None] = None, skip_provider_registration: Union[bool, Awaitable[bool], Output[T], None] = None, storage_use_azuread: Union[bool, Awaitable[bool], Output[T], None] = None, subscription_id: Union[str, Awaitable[str], Output[T], None] = None, tenant_id: Union[str, Awaitable[str], Output[T], None] = None, use_msi: Union[bool, Awaitable[bool], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • client_certificate_password (pulumi.Input[str]) – The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate

  • client_certificate_path (pulumi.Input[str]) – The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.

  • client_id (pulumi.Input[str]) – The Client ID which should be used.

  • client_secret (pulumi.Input[str]) – The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.

  • disable_correlation_request_id (pulumi.Input[bool]) – This will disable the x-ms-correlation-request-id header.

  • disable_terraform_partner_id (pulumi.Input[bool]) – This will disable the Terraform Partner ID which is used if a custom partner_id isn’t specified.

  • environment (pulumi.Input[str]) – The Cloud Environment which should be used. Possible values are public, usgovernment, german, and china. Defaults to public.

  • metadata_host (pulumi.Input[str]) – The Hostname which should be used for the Azure Metadata Service.

  • metadata_url (pulumi.Input[str]) – Deprecated - replaced by metadata_host.

  • msi_endpoint (pulumi.Input[str]) – The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.

  • partner_id (pulumi.Input[str]) – A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.

  • skip_credentials_validation (pulumi.Input[bool]) – This will cause the AzureRM Provider to skip verifying the credentials being used are valid.

  • skip_provider_registration (pulumi.Input[bool]) – Should the AzureRM Provider skip registering all of the Resource Providers that it supports, if they’re not already registered?

  • storage_use_azuread (pulumi.Input[bool]) – Should the AzureRM Provider use AzureAD to access the Storage Data Plane API’s?

  • subscription_id (pulumi.Input[str]) – The Subscription ID which should be used.

  • tenant_id (pulumi.Input[str]) – The Tenant ID which should be used.

  • use_msi (pulumi.Input[bool]) – Allowed Managed Service Identity be used for Authentication.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str