Fork me on GitHub

Package @pulumi/azure


var azure = require("@pulumi/azure");

ES6 modules:

import * as azure from "@pulumi/azure";


provider.ts utilities.ts


class Provider

The provider type for the azurerm package


new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function requireWithDefault

requireWithDefault<T>(req: { ... }, def: T | undefined): T

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property clientId

clientId?: pulumi.Input<string>;

property clientSecret

clientSecret?: pulumi.Input<string>;

property environment

environment?: pulumi.Input<string>;

property msiEndpoint

msiEndpoint?: pulumi.Input<string>;

property skipCredentialsValidation

skipCredentialsValidation?: pulumi.Input<boolean>;

property skipProviderRegistration

skipProviderRegistration?: pulumi.Input<boolean>;

property subscriptionId

subscriptionId?: pulumi.Input<string>;

property tenantId

tenantId?: pulumi.Input<string>;

property useMsi

useMsi?: pulumi.Input<boolean>;