common

Documentation

Index

• Constants
• type ApiAuthorizerFunc
• type Authorizers
• type ClientOptions
  • func (o ClientOptions) Configure(c client.BaseClient, authorizer auth.Authorizer)
  • func (o ClientOptions) ConfigureClient(c *autorest.Client, authorizer autorest.Authorizer)

Constants

const (
	// HeaderCorrelationRequestID is the Azure extension header to set a user-specified correlation request ID.
	HeaderCorrelationRequestID = "x-ms-correlation-request-id"
)

Types

type ApiAuthorizerFunc

type ApiAuthorizerFunc func(api environments.Api) (auth.Authorizer, error)

type Authorizers

type Authorizers struct {
	BatchManagement auth.Authorizer
	KeyVault        auth.Authorizer
	ManagedHSM      auth.Authorizer
	ResourceManager auth.Authorizer
	Storage         auth.Authorizer
	Synapse         auth.Authorizer

	// Some data-plane APIs require a token scoped for a specific endpoint
	AuthorizerFunc ApiAuthorizerFunc
}

type ClientOptions

type ClientOptions struct {
	Authorizers *Authorizers
	AuthConfig  *auth.Credentials
	Environment environments.Environment
	Features    features.UserFeatures

	SubscriptionId   string
	TenantId         string
	PartnerId        string
	TerraformVersion string

	CustomCorrelationRequestID  string
	DisableCorrelationRequestID bool

	DisableTerraformPartnerID bool
	StorageUseAzureAD         bool

	ResourceManagerEndpoint string

	// Legacy authorizers for go-autorest
	BatchManagementAuthorizer autorest.Authorizer
	KeyVaultAuthorizer        autorest.Authorizer
	ManagedHSMAuthorizer      autorest.Authorizer
	ResourceManagerAuthorizer autorest.Authorizer
	SynapseAuthorizer         autorest.Authorizer

	// TODO: Remove when all go-autorest clients are gone
	SkipProviderReg bool
}

func (ClientOptions) Configure

func (o ClientOptions) Configure(c client.BaseClient, authorizer auth.Authorizer)

Configure set up a resourcemanager.Client using an auth.Authorizer from hashicorp/go-azure-sdk

func (ClientOptions) ConfigureClient

func (o ClientOptions) ConfigureClient(c *autorest.Client, authorizer autorest.Authorizer)

ConfigureClient sets up an autorest.Client using an autorest.Authorizer