middleware

Documentation

Index

• func AggressivePollingOptions() *runtime.PollUntilDoneOptions
• func DefaultArmOpts(userAgent string, logCollector ArmRequestMetricCollector, ...) *arm.ClientOptions
• func DefaultHTTPClient() *http.Client
• func DefaultRetryOpts() policy.RetryOptions
• func DefaultTelemetryOpts(userAgent string) policy.TelemetryOptions
• type ArmError
• type ArmErrorCode
• type ArmRequestMetricCollector
• type ArmRequestMetricPolicy
  • func (p *ArmRequestMetricPolicy) Do(req *policy.Request) (*http.Response, error)
• type DummyTokenCredential
  • func (d DummyTokenCredential) GetToken(ctx context.Context, opts policy.TokenRequestOptions) (azcore.AccessToken, error)
• type HttpConnTracking
• type QueryParameterPolicy
  • func (p *QueryParameterPolicy) Do(req *policy.Request) (*http.Response, error)
• type Recorder
  • func NewRecorder(cassetteName string) (*Recorder, error)
  • func (r *Recorder) ClientCertPasswd() string
  • func (r *Recorder) ClientCertPath() string
  • func (r *Recorder) ClientID() string
  • func (r *Recorder) ClientSecret() string
  • func (r *Recorder) HTTPClient() *http.Client
  • func (r *Recorder) IsNewCassette() bool
  • func (r *Recorder) Stop() error
  • func (r *Recorder) SubscriptionID() string
  • func (r *Recorder) TenantID() string
  • func (r *Recorder) TokenCredential() azcore.TokenCredential
• type RequestInfo
• type ResponseInfo

Functions

func AggressivePollingOptions

func AggressivePollingOptions() *runtime.PollUntilDoneOptions

AggressivePollingOptions is a very aggressive set of poller options

func DefaultArmOpts

func DefaultArmOpts(userAgent string, logCollector ArmRequestMetricCollector, customPerCallPolicies ...policy.Policy) *arm.ClientOptions

func DefaultHTTPClient

func DefaultHTTPClient() *http.Client

DefaultHTTPClient returns a shared http client

func DefaultRetryOpts

func DefaultRetryOpts() policy.RetryOptions

func DefaultTelemetryOpts

func DefaultTelemetryOpts(userAgent string) policy.TelemetryOptions

Types

type ArmError

type ArmError struct {
	Code    ArmErrorCode `json:"code"`
	Message string       `json:"message"`
}

ArmError is unified Error Experience across AzureResourceManager, it contains Code Message.

type ArmErrorCode

type ArmErrorCode string

const (
	ArmErrorCodeCastToArmResponseErrorFailed ArmErrorCode = "CastToArmResponseErrorFailed"
	ArmErrorCodeTransportError               ArmErrorCode = "TransportError"
	ArmErrorCodeUnexpectedTransportError     ArmErrorCode = "UnexpectedTransportError"
	ArmErrorCodeContextCanceled              ArmErrorCode = "ContextCanceled"
	ArmErrorCodeContextDeadlineExceeded      ArmErrorCode = "ContextDeadlineExceeded"
)

type ArmRequestMetricCollector

type ArmRequestMetricCollector interface {
	// RequestStarted is called when a request is about to be sent.
	// context is not provided, get it from RequestInfo.Request.Context()
	RequestStarted(*RequestInfo)

	// RequestCompleted is called when a request is finished
	// context is not provided, get it from RequestInfo.Request.Context()
	// if an error occurred, ResponseInfo.Error will be populated
	RequestCompleted(*RequestInfo, *ResponseInfo)
}

ArmRequestMetricCollector is a interface that collectors need to implement. TODO: use *policy.Request or *http.Request?

type ArmRequestMetricPolicy

type ArmRequestMetricPolicy struct {
	Collector ArmRequestMetricCollector
}

ArmRequestMetricPolicy is a policy that collects metrics/telemetry for ARM requests.

func (*ArmRequestMetricPolicy) Do

func (p *ArmRequestMetricPolicy) Do(req *policy.Request) (*http.Response, error)

Do implements the azcore/policy.Policy interface.

type DummyTokenCredential

type DummyTokenCredential func(ctx context.Context, options policy.TokenRequestOptions) (azcore.AccessToken, error)

func (DummyTokenCredential) GetToken

func (d DummyTokenCredential) GetToken(ctx context.Context, opts policy.TokenRequestOptions) (azcore.AccessToken, error)

type HttpConnTracking

type HttpConnTracking struct {
	TotalLatency string
	DnsLatency   string
	ConnLatency  string
	TlsLatency   string
	Protocol     string
	ReqConnInfo  *httptrace.GotConnInfo
}

type QueryParameterPolicy

type QueryParameterPolicy struct {
	Name    string
	Value   string
	Replace bool
}

func (*QueryParameterPolicy) Do

func (p *QueryParameterPolicy) Do(req *policy.Request) (*http.Response, error)

type Recorder

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

func NewRecorder

func NewRecorder(cassetteName string) (*Recorder, error)

func (*Recorder) ClientCertPasswd

func (r *Recorder) ClientCertPasswd() string

func (*Recorder) ClientCertPath

func (r *Recorder) ClientCertPath() string

func (*Recorder) ClientID

func (r *Recorder) ClientID() string

func (*Recorder) ClientSecret

func (r *Recorder) ClientSecret() string

func (*Recorder) HTTPClient

func (r *Recorder) HTTPClient() *http.Client

func (*Recorder) IsNewCassette

func (r *Recorder) IsNewCassette() bool

func (*Recorder) Stop

func (r *Recorder) Stop() error

func (*Recorder) SubscriptionID

func (r *Recorder) SubscriptionID() string

func (*Recorder) TenantID

func (r *Recorder) TenantID() string

func (*Recorder) TokenCredential

func (r *Recorder) TokenCredential() azcore.TokenCredential

type RequestInfo

type RequestInfo struct {
	Request  *http.Request
	ArmResId *arm.ResourceID
}

type ResponseInfo

type ResponseInfo struct {
	Response      *http.Response
	Error         *ArmError
	Latency       time.Duration
	RequestId     string
	CorrelationId string
	ConnTracking  *HttpConnTracking
}