access

Documentation

Index

• func GetDefaultTokenCredentials(connectConfig ConnectConfig) (azcore.TokenCredential, error)
• type ConnectConfig
• type Factory
  • func NewDefaultAccessFactory() Factory
• type TokenCredentialProvider

Functions

func GetDefaultTokenCredentials

func GetDefaultTokenCredentials(connectConfig ConnectConfig) (azcore.TokenCredential, error)

GetDefaultTokenCredentials provides the azure token credentials using the ConnectConfig passed as an argument.

Types

type ConnectConfig

type ConnectConfig struct {
	// SubscriptionID is a unique ID identifying a subscription.
	SubscriptionID string
	// TenantID is a unique identifier for an active directory tenant.
	TenantID string
	// ClientID is a unique identity assigned by azure active directory to an application.
	ClientID string
	// ClientSecret is a certificate issued for the ClientID.
	// This field is mutually exclusive with WorkloadIdentityTokenFile.
	ClientSecret string
	// WorkloadIdentityTokenFile is the file containing a federated token for authentication against Azure.
	// This field is mutually exclusive with ClientSecret.
	WorkloadIdentityTokenFile string
	// ClientOptions are the options to use when connecting with clients.
	ClientOptions policy.ClientOptions
}

ConnectConfig is the configuration required to connect to azure provider.

type Factory

type Factory interface {
	// GetResourceGroupsAccess creates and returns a new instance of armresources.ResourceGroupsClient.
	GetResourceGroupsAccess(connectConfig ConnectConfig) (*armresources.ResourceGroupsClient, error)
	// GetVirtualMachinesAccess creates and returns a new instance of armcompute.VirtualMachinesClient.
	GetVirtualMachinesAccess(connectConfig ConnectConfig) (*armcompute.VirtualMachinesClient, error)
	// GetNetworkInterfacesAccess creates and returns a new instance of armnetwork.InterfacesClient.
	GetNetworkInterfacesAccess(connectConfig ConnectConfig) (*armnetwork.InterfacesClient, error)
	// GetSubnetAccess creates and returns a new instance of armnetwork.SubnetsClient.
	GetSubnetAccess(connectConfig ConnectConfig) (*armnetwork.SubnetsClient, error)
	// GetDisksAccess creates and returns a new instance of armcompute.DisksClient.
	GetDisksAccess(connectConfig ConnectConfig) (*armcompute.DisksClient, error)
	// GetResourceGraphAccess creates and returns a new instance of armresourcegraph.Client.
	GetResourceGraphAccess(connectConfig ConnectConfig) (*armresourcegraph.Client, error)
	// GetVirtualMachineImagesAccess creates and returns a new instance of armcompute.VirtualMachineImagesClient.
	GetVirtualMachineImagesAccess(connectConfig ConnectConfig) (*armcompute.VirtualMachineImagesClient, error)
	// GetMarketPlaceAgreementsAccess creates and returns a new instance of armmarketplaceordering.MarketplaceAgreementsClient.
	GetMarketPlaceAgreementsAccess(connectConfig ConnectConfig) (*armmarketplaceordering.MarketplaceAgreementsClient, error)
}

Factory is an access factory providing methods to get facade/access for different resources. Azure SDK provides clients for resources, these clients are actually just facades which internally uses another client.

func NewDefaultAccessFactory

func NewDefaultAccessFactory() Factory

NewDefaultAccessFactory creates a new instance of Factory.

type TokenCredentialProvider

type TokenCredentialProvider func(connectConfig ConnectConfig) (azcore.TokenCredential, error)

TokenCredentialProvider is a function which gets azcore.TokenCredential using the passed ConnectConfig. This allows unit tests to pass their own fake provider for token credentials.