armclient

Documentation

Index

• Variables
• func GetAPIVersion(armType string) (string, error)
• type AzCLIToken
• type Client
  • func NewClientFromCLI() *Client
  • func NewClientFromClientAndTokenFunc(client *http.Client, tokenFunc TokenFunc) *Client
  • func (c *Client) DoRequest(ctx context.Context, method, path string) (string, error)
  • func (c *Client) DoRequestAsync(ctx context.Context, method, path string) chan RequestResult
  • func (c *Client) DoRequestWithBody(ctx context.Context, method, path, body string) (string, error)
  • func (c *Client) DoResourceGraphQuery(ctx context.Context, subscription, query string) (string, error)
  • func (c *Client) GetTenantID() string
  • func (c *Client) GetToken() (AzCLIToken, error)
  • func (c *Client) PopulateResourceAPILookup(ctx context.Context)
  • func (c *Client) SetAquireToken(aquireFunc func(clearCache bool) (AzCLIToken, error))
  • func (c *Client) SetClient(newClient *http.Client)
• type MetricNamespaceResponse
• type MetricResponse
• type MetricsListResponse
• type ProvidersResponse
• type RequestResult
• type Resource
• type ResourceResponse
• type TokenFunc

Variables

var LegacyInstance = NewClientFromCLI()

LegacyInstance is a singleton ARMClient used while migrating to the injected client

Functions

func GetAPIVersion

func GetAPIVersion(armType string) (string, error)

GetAPIVersion returns the most recent API version for a resource

Types

type AzCLIToken

type AzCLIToken struct {
	AccessToken  string `json:"accessToken"`
	TokenType    string `json:"tokenType"`
	Tenant       string `json:"tenant"`
	Subscription string `json:"subscription"`
}

AzCLIToken contains token info from az cli

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is used to talk to the ARM API's in Azure

func NewClientFromCLI

func NewClientFromCLI() *Client

NewClientFromCLI creates a new client using the auth details on disk used by the azurecli

func NewClientFromClientAndTokenFunc

func NewClientFromClientAndTokenFunc(client *http.Client, tokenFunc TokenFunc) *Client

NewClientFromClientAndTokenFunc create a client for testing using custom token func and httpclient

func (*Client) DoRequest

func (c *Client) DoRequest(ctx context.Context, method, path string) (string, error)

DoRequest makes an ARM rest request

func (*Client) DoRequestAsync

func (c *Client) DoRequestAsync(ctx context.Context, method, path string) chan RequestResult

DoRequestAsync makes an ARM rest request

func (*Client) DoRequestWithBody

func (c *Client) DoRequestWithBody(ctx context.Context, method, path, body string) (string, error)

DoRequestWithBody makes an ARM rest request

func (*Client) DoResourceGraphQuery

func (c *Client) DoResourceGraphQuery(ctx context.Context, subscription, query string) (string, error)

DoResourceGraphQuery performs an azure graph query

func (*Client) GetTenantID

func (c *Client) GetTenantID() string

GetTenantID gets the current tenandid from AzCli

func (*Client) GetToken

func (c *Client) GetToken() (AzCLIToken, error)

GetToken gets the cached cli token

func (*Client) PopulateResourceAPILookup

func (c *Client) PopulateResourceAPILookup(ctx context.Context)

PopulateResourceAPILookup is used to build a cache of resourcetypes -> api versions this is needed when requesting details from a resource as APIVersion isn't known and is required

func (*Client) SetAquireToken

func (c *Client) SetAquireToken(aquireFunc func(clearCache bool) (AzCLIToken, error))

SetAquireToken lets you override the token func for testing or other purposes

func (*Client) SetClient

func (c *Client) SetClient(newClient *http.Client)

SetClient is used to override the HTTP Client used. This is useful when testing

type MetricNamespaceResponse

type MetricNamespaceResponse struct {
	Value []struct {
		ID             string `json:"id"`
		Name           string `json:"name"`
		Type           string `json:"type"`
		Classification string `json:"classification"`
		Properties     struct {
			MetricNamespaceName string `json:"metricNamespaceName"`
		} `json:"properties"`
	} `json:"value"`
}

MetricNamespaceResponse https://docs.microsoft.com/en-us/rest/api/monitor/metricnamespaces/list

type MetricResponse

type MetricResponse struct {
	Cost           int    `json:"cost"`
	Timespan       string `json:"timespan"`
	Interval       string `json:"interval"`
	Namespace      string `json:"namespace"`
	Resourceregion string `json:"resourceregion"`
	Value          []struct {
		ID   string `json:"id"`
		Type string `json:"type"`
		Name struct {
			Value          string `json:"value"`
			LocalizedValue string `json:"localizedValue"`
		} `json:"name"`
		Unit       string `json:"unit"`
		Timeseries []struct {
			Metadatavalues []struct {
				Name struct {
					Value          string `json:"value"`
					LocalizedValue string `json:"localizedValue"`
				} `json:"name"`
				Value string `json:"value"`
			} `json:"metadatavalues"`
			Data []map[string]interface{} `json:"data"`
		} `json:"timeseries"`
	} `json:"value"`
}

MetricResponse https://docs.microsoft.com/en-us/rest/api/monitor/metrics/list

type MetricsListResponse

type MetricsListResponse struct {
	Value []struct {
		ID         string `json:"id"`
		ResourceID string `json:"resourceId"`
		Namespace  string `json:"namespace"`
		Name       struct {
			Value          string `json:"value"`
			LocalizedValue string `json:"localizedValue"`
		} `json:"name"`
		IsDimensionRequired       bool     `json:"isDimensionRequired"`
		Unit                      string   `json:"unit"`
		PrimaryAggregationType    string   `json:"primaryAggregationType"`
		SupportedAggregationTypes []string `json:"supportedAggregationTypes"`
		MetricAvailabilities      []struct {
			TimeGrain string `json:"timeGrain"`
			Retention string `json:"retention"`
		} `json:"metricAvailabilities"`
		Dimensions []struct {
			Value          string `json:"value"`
			LocalizedValue string `json:"localizedValue"`
		} `json:"dimensions"`
	} `json:"value"`
}

MetricsListResponse https://docs.microsoft.com/en-us/rest/api/monitor/metricdefinitions/list

type ProvidersResponse

type ProvidersResponse struct {
	Providers []struct {
		ID            string `json:"id"`
		Namespace     string `json:"namespace"`
		Authorization struct {
			ApplicationID    string `json:"applicationId"`
			RoleDefinitionID string `json:"roleDefinitionId"`
		} `json:"authorization,omitempty"`
		ResourceTypes []struct {
			ResourceType string        `json:"resourceType"`
			Locations    []interface{} `json:"locations"`
			APIVersions  []string      `json:"apiVersions"`
		} `json:"resourceTypes"`
		RegistrationState string `json:"registrationState"`
		Authorizations    []struct {
			ApplicationID    string `json:"applicationId"`
			RoleDefinitionID string `json:"roleDefinitionId"`
		} `json:"authorizations,omitempty"`
	} `json:"value"`
}

ProvidersResponse providers list rest type

type RequestResult

type RequestResult struct {
	Result string
	Error  error
}

RequestResult used with async channel

type Resource

type Resource struct {
	ID   string `json:"id"`
	Name string `json:"name"`
	Type string `json:"type"`
	Sku  struct {
		Name string `json:"name"`
		Tier string `json:"tier"`
	} `json:"sku"`
	Kind       string `json:"kind"`
	Location   string `json:"location"`
	Properties struct {
		ProvisioningState string `json:"provisioningState"`
	} `json:"properties"`
}

Resource is a resource in azure

type ResourceResponse

type ResourceResponse struct {
	Resources []Resource `json:"value"`
}

ResourceResponse Resources list rest type

type TokenFunc

type TokenFunc func(clearCache bool) (AzCLIToken, error)

TokenFunc is the interface to meet for functions which retrieve tokens for the ARMClient