azure

README

Microsoft Azure Resource Provider

The Microsoft Azure resource provider for Pulumi lets you use Azure resources in your cloud programs. To use this package, please install the Pulumi CLI first.

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

or yarn:

$ yarn add @pulumi/azure

Python

To use from Python, install using pip:

$ pip install pulumi_azure

Go

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

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

Concepts

The @pulumi/azure 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), 'appinsights', 'compute', 'cosmosdb', 'keyvault', and more.

Configuring credentials

There are a variety of ways credentials may be configured for the Azure provider, appropriate for different use cases. They are enumerated in the quickstart guide.

Reference

For detailed reference documentation, please visit the API docs.

Documentation

Index

• func AutoName(name string, options AutoNameOptions) *tfbridge.SchemaInfo
• func AutoNameWithMaxLength(name string, maxlength int) *tfbridge.SchemaInfo
• func FromName(options AutoNameOptions) func(res *tfbridge.PulumiResource) (interface{}, error)
• func Provider() tfbridge.ProviderInfo
• type AutoNameOptions

Functions

func AutoName

func AutoName(name string, options AutoNameOptions) *tfbridge.SchemaInfo

AutoName creates custom schema for a Terraform name property which is automatically populated from the resource's URN name, and transformed based on the provided options.

func AutoNameWithMaxLength

func AutoNameWithMaxLength(name string, maxlength int) *tfbridge.SchemaInfo

func FromName

func FromName(options AutoNameOptions) func(res *tfbridge.PulumiResource) (interface{}, error)

FromName automatically propagates a resource's URN onto the resulting default info.

func Provider

func Provider() tfbridge.ProviderInfo

Provider returns additional overlaid schema and metadata associated with the azure package.

nolint: lll

Types

type AutoNameOptions

type AutoNameOptions struct {
	// A separator between name and random portions of the
	Separator string
	// Maximum length of the generated name
	Maxlen int
	// Number of characters of random hex digits to add to the name
	Randlen int
	// A transform to apply to the name prior to adding random characters
	Transform func(string) string
	// Force the name to be lowercase prior to adding random characters
	ForceLowercase bool
}

AutoNameOptions provides parameters to AutoName to control how names will be generated