access

package
v0.13.0 Latest Latest
Warning

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

Go to latest
Published: Jun 17, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 issues for the ClientID.
	ClientSecret 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 NewAccessFactoryWithOptions

func NewAccessFactoryWithOptions(clientOptions *arm.ClientOptions, tokenCredentialProvider TokenCredentialProvider) Factory

NewAccessFactoryWithOptions creates an instance of Factory which uses a fixed tokenCredential passed as an argument and also takes custom arm.ClientOptions.

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.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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