azuread

package module
v1.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 23, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

README

Build Status Slack NPM version Python version GoDoc License

Microsoft Azure Active Directory Resource Provider

The Microsoft Azure AD resource provider for Pulumi lets you use Azure Active Directory resources in your cloud programs. To use this package, please install the Pulumi CLI first. For a streamlined Pulumi walkthrough, including language runtime installation and Azure configuration, click "Get Started" below.

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/azuread

or yarn:

$ yarn add @pulumi/azuread
Python 3

To use from Python, install using pip:

$ pip install pulumi_azuread
Go

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

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

Configuration

The following configuration points are available:

  • azuread:clientId - The Client ID which should be used. This can also be sourced from the ARM_CLIENT_ID Environment Variable.
  • azuread:subscriptionId - The Subscription ID which should be used. This can also be sourced from the ARM_SUBSCRIPTION_ID Environment Variable.
  • azuread:tenantId - The Tenant ID which should be used. This can also be sourced from the ARM_TENANT_ID Environment Variable.
  • azuread:clientSecret - The Client Secret which should be used. This can also be sourced from the ARM_CLIENT_SECRET Environment Variable.
  • azuread:certificatePassword - The password associated with the Client Certificate. This can also be sourced from the ARM_CLIENT_CERTIFICATE_PASSWORD Environment Variable.
  • azuread:clientCertificatePath - The path to the Client Certificate associated with the Service Principal which should be used. This can also be sourced from the ARM_CLIENT_CERTIFICATE_PATH Environment Variable.
  • azuread:environment - The Cloud Environment which be used. Possible values are public, usgovernment, german and china. Defaults to public. This can also be sourced from the ARM_ENVIRONMENT environment variable.
  • azuread:msiEndpoint - The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically. This can also be sourced from the ARM_MSI_ENDPOINT Environment Variable.
  • azuread:useMsi - Should Managed Service Identity be used for Authentication? This can also be sourced from the ARM_USE_MSI Environment Variable. Defaults to false.

Reference

For detailed reference documentation, please visit the API docs.

Build from source

Add dependencies

In the root of the repository, run:

  • Download the install-common-toolchain.sh script from here (or clone the repo) and run it in your terminal.
  • make ensure
Build the provider:
  • make

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Provider

func Provider() tfbridge.ProviderInfo

Provider returns additional overlaid schema and metadata associated with the provider..

Types

This section is empty.

Directories

Path Synopsis
cmd
pkg
provider module
sdk module
go/azuread
nolint: lll nolint: lll Package azuread exports types, functions, subpackages for provisioning azuread resources.// A Pulumi package for creating and managing azuread cloud resources.
nolint: lll nolint: lll Package azuread exports types, functions, subpackages for provisioning azuread resources.// A Pulumi package for creating and managing azuread cloud resources.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL