pulumiazurenativesdk

README

Native Azure Pulumi Provider

The Azure Native provider for Pulumi lets you use Azure resources in your cloud programs. This provider uses the Azure Resource Manager REST API directly and therefore provides full access to the ARM API.

The Azure Native provider is the recommended provider for projects targeting Azure.

To use this package, install the Pulumi CLI.

Installing

This package is available in many languages in the standard packaging formats.

Node.js (Java/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

npm install @pulumi/azure-native

or yarn:

yarn add @pulumi/azure-native

Python

To use from Python, install using pip:

pip install pulumi_azure_native

Go

To use from Go, use go get to grab the latest version of the library

go get github.com/pulumi/pulumi-azure-native/sdk

.NET

To use from .NET, install using dotnet add package:

dotnet add package Pulumi.AzureNative

Concepts

The @pulumi/azure-native package provides a strongly-typed means to build cloud applications that create and interact closely with Azure resources. Resources are exposed for the entire Azure surface area, including (but not limited to) 'compute', 'keyvault', 'network', 'storage', and more.

The Azure Native provider works directly with the Azure Resource Manager (ARM) platform instead of depending on a handwritten layer as with the classic provider. This approach ensures higher quality and higher fidelity with the Azure platform.

Configuring credentials

To learn how to configure credentials refer to the Azure configuration options.

Other Configuration

In addition to the configuration options in the official documentation linked above, the following environment variables can be used to tweak lower-level behavior of the provider:

• PULUMI_FORCE_NEW_FROM_SUBTYPES: if, after a change in your program, the provider does not replace a resource that should be replaced because it cannot be updated, setting this variable to true might allow the provider to infer the correct behavior. For more details please see PR #2970. We're planning to make this behavior the default in the future.

Building

See contributing for details on how to build and contribute to this provider.

Reference

For further information, visit Azure Native in the Pulumi Registry or for detailed API reference documentation, visit Azure Native API Docs in the Pulumi Registry.

Documentation

Overview

A native Pulumi package for creating and managing Azure resources.

Index

• type Provider
  • func NewProvider(ctx *pulumi.Context, name string, args *ProviderArgs, ...) (*Provider, error)
  • func (*Provider) ElementType() reflect.Type
  • func (i *Provider) ToProviderOutput() ProviderOutput
  • func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput
• type ProviderArgs
  • func (ProviderArgs) ElementType() reflect.Type
• type ProviderInput
• type ProviderOutput
  • func (ProviderOutput) ElementType() reflect.Type
  • func (o ProviderOutput) ToProviderOutput() ProviderOutput
  • func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

Types

type Provider

type Provider struct {
	pulumi.ProviderResourceState
}

The provider type for the native Azure package.

func NewProvider

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs

type ProviderArgs struct {
	// Any additional Tenant IDs which should be used for authentication.
	AuxiliaryTenantIds pulumi.StringArrayInput
	// The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
	ClientCertificatePassword pulumi.StringPtrInput
	// The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
	ClientCertificatePath pulumi.StringPtrInput
	// The Client ID which should be used.
	ClientId pulumi.StringPtrInput
	// The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
	ClientSecret pulumi.StringPtrInput
	// This will disable the Pulumi Partner ID which is used if a custom `partnerId` isn't specified.
	DisablePulumiPartnerId pulumi.BoolPtrInput
	// The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public.
	Environment pulumi.StringPtrInput
	// The location to use. ResourceGroups will consult this property for a default location, if one was not supplied explicitly when defining the resource.
	Location pulumi.StringPtrInput
	// The Hostname of the Azure Metadata Service.
	MetadataHost pulumi.StringPtrInput
	// The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
	MsiEndpoint pulumi.StringPtrInput
	// Your cloud service or provider’s bearer token to exchange for an OIDC ID token.
	OidcRequestToken pulumi.StringPtrInput
	// The URL to initiate the `oidcRequestToken` OIDC token exchange.
	OidcRequestUrl pulumi.StringPtrInput
	// The OIDC token to exchange for an Azure token.
	OidcToken pulumi.StringPtrInput
	// A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
	PartnerId pulumi.StringPtrInput
	// The Subscription ID which should be used.
	SubscriptionId pulumi.StringPtrInput
	// The Tenant ID which should be used.
	TenantId pulumi.StringPtrInput
	// Allow Managed Service Identity to be used for Authentication.
	UseMsi pulumi.BoolPtrInput
	// Allow OpenID Connect (OIDC) to be used for Authentication.
	UseOidc pulumi.BoolPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ElementType

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput