clients

Documentation

Index

• type Client
  • func Build(ctx context.Context, builder ClientBuilder) (*Client, error)
  • func (client *Client) Build(ctx context.Context, o *common.ClientOptions) error
• type ClientBuilder
• type ResourceManagerAccount
  • func NewResourceManagerAccount(ctx context.Context, config auth.Credentials, subscriptionId string, ...) (*ResourceManagerAccount, error)

Types

type Client

type Client struct {

	// StopContext is used for propagating control from Terraform Core (e.g. Ctrl/Cmd+C)
	StopContext context.Context

	Account  *ResourceManagerAccount
	Features features.UserFeatures

	AadB2c                            *aadb2c_v2021_04_01_preview.Client
	Advisor                           *advisor.Client
	AnalysisServices                  *analysisservices_v2017_08_01.Client
	ApiManagement                     *apiManagement.Client
	AppConfiguration                  *appConfiguration.Client
	AppInsights                       *applicationInsights.Client
	AppPlatform                       *appPlatform.Client
	AppService                        *appService.Client
	ArcKubernetes                     *arckubernetes.Client
	ArcResourceBridge                 *arcResourceBridge.Client
	Attestation                       *attestation.Client
	Authorization                     *authorization.Client
	Automanage                        *automanage.Client
	Automation                        *automation.Client
	AzureStackHCI                     *azurestackhci_v2024_01_01.Client
	Batch                             *batch.Client
	Blueprints                        *blueprints.Client
	Bot                               *bot.Client
	Cdn                               *cdn.Client
	CodeSigning                       *codesigning.Client
	Cognitive                         *cognitiveServices.Client
	Communication                     *communication.Client
	Compute                           *compute.Client
	ConfidentialLedger                *confidentialledger.Client
	Connections                       *connections.Client
	Consumption                       *consumption.Client
	ContainerApps                     *containerapps.Client
	Containers                        *containerServices.Client
	Cosmos                            *cosmosdb.Client
	CostManagement                    *costmanagement.Client
	CustomProviders                   *customproviders.Client
	Dashboard                         *dashboard.Client
	DatabaseMigration                 *datamigration.Client
	DataBricks                        *databricks.Client
	DataboxEdge                       *databoxedge.Client
	Datadog                           *datadog_v2021_03_01.Client
	DataFactory                       *datafactory.Client
	DataProtection                    *dataprotection.Client
	DataShare                         *datashare.Client
	DesktopVirtualization             *desktopvirtualization.Client
	DevTestLabs                       *devtestlabs.Client
	DigitalTwins                      *digitaltwins.Client
	Dns                               *dns_v2018_05_01.Client
	DomainServices                    *domainservices.Client
	Dynatrace                         *dynatrace.Client
	Elastic                           *elastic.Client
	ElasticSan                        *elasticsan.Client
	EventGrid                         *eventgrid.Client
	Eventhub                          *eventhub.Client
	ExtendedLocation                  *extendedlocation.Client
	Fabric                            *fabric.Client
	FluidRelay                        *fluidrelay_2022_05_26.Client
	Frontdoor                         *frontdoor.Client
	Graph                             *graph.Client
	HSM                               *hsm.Client
	HDInsight                         *hdinsight_v2021_06_01.Client
	HybridCompute                     *hybridcompute.Client
	HealthCare                        *healthcare.Client
	IoTCentral                        *iotcentral.Client
	IoTHub                            *iothub.Client
	KeyVault                          *keyvault.Client
	Kusto                             *kusto.Client
	Lighthouse                        *lighthouse.Client
	LoadBalancers                     *loadbalancers.Client
	LoadTestService                   *loadtestservice.AutoClient
	LogAnalytics                      *loganalytics.Client
	Logic                             *logic.Client
	MachineLearning                   *machinelearning.Client
	Maintenance                       *maintenance.Client
	ManagedApplication                *managedapplication.Client
	ManagementGroups                  *managementgroup.Client
	ManagedHSMs                       *managedhsm.Client
	Maps                              *maps.Client
	MixedReality                      *mixedreality.Client
	Monitor                           *monitor.Client
	MobileNetwork                     *mobilenetwork.Client
	MongoCluster                      *mongocluster.Client
	MSSQL                             *mssql.Client
	MSSQLManagedInstance              *mssqlmanagedinstance.Client
	MySQL                             *mysql.Client
	NetApp                            *netapp.Client
	Network                           *network.Client
	NetworkFunction                   *networkfunction.Client
	NewRelic                          *newrelic.Client
	Nginx                             *nginx_2024_11_01_preview.Client
	NotificationHubs                  *notificationhub.Client
	Oracle                            *oracle.Client
	Orbital                           *orbital.Client
	PaloAlto                          *paloalto.Client
	Policy                            *policy.Client
	Portal                            *portal.Client
	Postgres                          *postgres.Client
	PowerBI                           *powerBI.Client
	PrivateDns                        *privatedns.Client
	PrivateDnsResolver                *dnsresolver.Client
	Purview                           *purview.Client
	RecoveryServices                  *recoveryServices.Client
	RedHatOpenShift                   *redhatopenshift.Client
	Redis                             *redis.Client
	RedisEnterprise                   *redisenterprise.Client
	Relay                             *relay.Client
	Resource                          *resource.Client
	Search                            *search.Client
	SecurityCenter                    *securityCenter.Client
	Sentinel                          *sentinel.Client
	ServiceBus                        *serviceBus.Client
	ServiceConnector                  *serviceConnector.Client
	ServiceFabric                     *serviceFabric.Client
	ServiceFabricManaged              *serviceFabricManaged.Client
	ServiceNetworking                 *servicenetworking_2023_11_01.Client
	SignalR                           *signalr.Client
	Storage                           *storage.Client
	StorageCache                      *storagecache_2023_05_01.Client
	StorageMover                      *storageMover.Client
	StreamAnalytics                   *streamAnalytics.Client
	Subscription                      *subscription.Client
	Synapse                           *synapse.Client
	SystemCenterVirtualMachineManager *systemcentervirtualmachinemanager_2023_10_07.Client
	TrafficManager                    *trafficManager.Client
	VideoIndexer                      *videoindexer.Client
	Vmware                            *vmware.Client
	VoiceServices                     *voiceServices.Client
	Web                               *web.Client
	Workloads                         *workloads_v2024_09_01.Client
	// contains filtered or unexported fields
}

func Build

func Build(ctx context.Context, builder ClientBuilder) (*Client, error)

func (*Client) Build

func (client *Client) Build(ctx context.Context, o *common.ClientOptions) error

type ClientBuilder

type ClientBuilder struct {
	AuthConfig *auth.Credentials
	Features   features.UserFeatures

	CustomCorrelationRequestID  string
	DisableCorrelationRequestID bool
	DisableTerraformPartnerID   bool
	MetadataHost                string
	PartnerID                   string
	RegisteredResourceProviders resourceproviders.ResourceProviders
	StorageUseAzureAD           bool
	SubscriptionID              string
	TerraformVersion            string
}

type ResourceManagerAccount

type ResourceManagerAccount struct {
	Environment environments.Environment

	ClientId       string
	ObjectId       string
	SubscriptionId string
	TenantId       string

	AuthenticatedAsAServicePrincipal bool
	RegisteredResourceProviders      resourceproviders.ResourceProviders
}

func NewResourceManagerAccount

func NewResourceManagerAccount(ctx context.Context, config auth.Credentials, subscriptionId string, registeredResourceProviders resourceproviders.ResourceProviders) (*ResourceManagerAccount, error)