apidiagnostic

package
v0.20241118.1115603 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-05-01-preview/apidiagnostic Documentation

The apidiagnostic SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2023-05-01-preview).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-05-01-preview/apidiagnostic"

Client Initialization

client := apidiagnostic.NewApiDiagnosticClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiDiagnosticClient.CreateOrUpdate

ctx := context.TODO()
id := apidiagnostic.NewApiDiagnosticID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId", "diagnosticId")

payload := apidiagnostic.DiagnosticContract{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload, apidiagnostic.DefaultCreateOrUpdateOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ApiDiagnosticClient.Delete

ctx := context.TODO()
id := apidiagnostic.NewApiDiagnosticID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId", "diagnosticId")

read, err := client.Delete(ctx, id, apidiagnostic.DefaultDeleteOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ApiDiagnosticClient.Get

ctx := context.TODO()
id := apidiagnostic.NewApiDiagnosticID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId", "diagnosticId")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ApiDiagnosticClient.GetEntityTag

ctx := context.TODO()
id := apidiagnostic.NewApiDiagnosticID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId", "diagnosticId")

read, err := client.GetEntityTag(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ApiDiagnosticClient.ListByService

ctx := context.TODO()
id := apidiagnostic.NewApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId")

// alternatively `client.ListByService(ctx, id, apidiagnostic.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, apidiagnostic.DefaultListByServiceOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ApiDiagnosticClient.Update

ctx := context.TODO()
id := apidiagnostic.NewApiDiagnosticID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId", "diagnosticId")

payload := apidiagnostic.DiagnosticContract{
	// ...
}


read, err := client.Update(ctx, id, payload, apidiagnostic.DefaultUpdateOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAlwaysLog 

func PossibleValuesForAlwaysLog() []string

func PossibleValuesForDataMaskingMode 

func PossibleValuesForDataMaskingMode() []string

func PossibleValuesForHTTPCorrelationProtocol 

func PossibleValuesForHTTPCorrelationProtocol() []string

func PossibleValuesForOperationNameFormat 

func PossibleValuesForOperationNameFormat() []string

func PossibleValuesForSamplingType 

func PossibleValuesForSamplingType() []string

func PossibleValuesForVerbosity 

func PossibleValuesForVerbosity() []string

func ValidateApiDiagnosticID 

func ValidateApiDiagnosticID(input interface{}, key string) (warnings []string, errors []error)

ValidateApiDiagnosticID checks that 'input' can be parsed as a Api Diagnostic ID

func ValidateApiID 

func ValidateApiID(input interface{}, key string) (warnings []string, errors []error)

ValidateApiID checks that 'input' can be parsed as a Api ID

Types

type AlwaysLog 

type AlwaysLog string
const (
	AlwaysLogAllErrors AlwaysLog = "allErrors"
)

func (*AlwaysLog) UnmarshalJSON 

func (s *AlwaysLog) UnmarshalJSON(bytes []byte) error

type ApiDiagnosticClient 

type ApiDiagnosticClient struct {
	Client *resourcemanager.Client
}

func NewApiDiagnosticClientWithBaseURI 

func NewApiDiagnosticClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiDiagnosticClient, error)

func (ApiDiagnosticClient) CreateOrUpdate 

func (c ApiDiagnosticClient) CreateOrUpdate(ctx context.Context, id ApiDiagnosticId, input DiagnosticContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ApiDiagnosticClient) Delete 

func (c ApiDiagnosticClient) Delete(ctx context.Context, id ApiDiagnosticId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (ApiDiagnosticClient) Get 

func (c ApiDiagnosticClient) Get(ctx context.Context, id ApiDiagnosticId) (result GetOperationResponse, err error)

Get ...

func (ApiDiagnosticClient) GetEntityTag 

func (c ApiDiagnosticClient) GetEntityTag(ctx context.Context, id ApiDiagnosticId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (ApiDiagnosticClient) ListByService 

func (c ApiDiagnosticClient) ListByService(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)

ListByService ...

func (ApiDiagnosticClient) ListByServiceComplete 

func (c ApiDiagnosticClient) ListByServiceComplete(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (ApiDiagnosticClient) ListByServiceCompleteMatchingPredicate 

func (c ApiDiagnosticClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ApiId, options ListByServiceOperationOptions, predicate DiagnosticContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApiDiagnosticClient) Update 

func (c ApiDiagnosticClient) Update(ctx context.Context, id ApiDiagnosticId, input DiagnosticContract, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

type ApiDiagnosticId 

type ApiDiagnosticId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ApiId             string
	DiagnosticId      string
}

ApiDiagnosticId is a struct representing the Resource ID for a Api Diagnostic

func NewApiDiagnosticID 

func NewApiDiagnosticID(subscriptionId string, resourceGroupName string, serviceName string, apiId string, diagnosticId string) ApiDiagnosticId

NewApiDiagnosticID returns a new ApiDiagnosticId struct

func ParseApiDiagnosticID 

func ParseApiDiagnosticID(input string) (*ApiDiagnosticId, error)

ParseApiDiagnosticID parses 'input' into a ApiDiagnosticId

func ParseApiDiagnosticIDInsensitively 

func ParseApiDiagnosticIDInsensitively(input string) (*ApiDiagnosticId, error)

ParseApiDiagnosticIDInsensitively parses 'input' case-insensitively into a ApiDiagnosticId note: this method should only be used for API response data and not user input

func (*ApiDiagnosticId) FromParseResult 

func (id *ApiDiagnosticId) FromParseResult(input resourceids.ParseResult) error

func (ApiDiagnosticId) ID 

func (id ApiDiagnosticId) ID() string

ID returns the formatted Api Diagnostic ID

func (ApiDiagnosticId) Segments 

func (id ApiDiagnosticId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Api Diagnostic ID

func (ApiDiagnosticId) String 

func (id ApiDiagnosticId) String() string

String returns a human-readable description of this Api Diagnostic ID

type ApiId 

type ApiId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ApiId             string
}

ApiId is a struct representing the Resource ID for a Api

func NewApiID 

func NewApiID(subscriptionId string, resourceGroupName string, serviceName string, apiId string) ApiId

NewApiID returns a new ApiId struct

func ParseApiID 

func ParseApiID(input string) (*ApiId, error)

ParseApiID parses 'input' into a ApiId

func ParseApiIDInsensitively 

func ParseApiIDInsensitively(input string) (*ApiId, error)

ParseApiIDInsensitively parses 'input' case-insensitively into a ApiId note: this method should only be used for API response data and not user input

func (*ApiId) FromParseResult 

func (id *ApiId) FromParseResult(input resourceids.ParseResult) error

func (ApiId) ID 

func (id ApiId) ID() string

ID returns the formatted Api ID

func (ApiId) Segments 

func (id ApiId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Api ID

func (ApiId) String 

func (id ApiId) String() string

String returns a human-readable description of this Api ID

type BodyDiagnosticSettings 

type BodyDiagnosticSettings struct {
	Bytes *int64 `json:"bytes,omitempty"`
}

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders 

func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers

func (CreateOrUpdateOperationOptions) ToOData 

func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query

func (CreateOrUpdateOperationOptions) ToQuery 

func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DiagnosticContract
}

type DataMasking 

type DataMasking struct {
	Headers     *[]DataMaskingEntity `json:"headers,omitempty"`
	QueryParams *[]DataMaskingEntity `json:"queryParams,omitempty"`
}

type DataMaskingEntity 

type DataMaskingEntity struct {
	Mode  *DataMaskingMode `json:"mode,omitempty"`
	Value *string          `json:"value,omitempty"`
}

type DataMaskingMode 

type DataMaskingMode string
const (
	DataMaskingModeHide DataMaskingMode = "Hide"
	DataMaskingModeMask DataMaskingMode = "Mask"
)

func (*DataMaskingMode) UnmarshalJSON 

func (s *DataMaskingMode) UnmarshalJSON(bytes []byte) error

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

func (o DeleteOperationOptions) ToHeaders() *client.Headers

func (DeleteOperationOptions) ToOData 

func (o DeleteOperationOptions) ToOData() *odata.Query

func (DeleteOperationOptions) ToQuery 

func (o DeleteOperationOptions) ToQuery() *client.QueryParams

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type DiagnosticContract 

type DiagnosticContract struct {
	Id         *string                       `json:"id,omitempty"`
	Name       *string                       `json:"name,omitempty"`
	Properties *DiagnosticContractProperties `json:"properties,omitempty"`
	Type       *string                       `json:"type,omitempty"`
}

type DiagnosticContractOperationPredicate 

type DiagnosticContractOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (DiagnosticContractOperationPredicate) Matches 

func (p DiagnosticContractOperationPredicate) Matches(input DiagnosticContract) bool

type DiagnosticContractProperties 

type DiagnosticContractProperties struct {
	AlwaysLog               *AlwaysLog                  `json:"alwaysLog,omitempty"`
	Backend                 *PipelineDiagnosticSettings `json:"backend,omitempty"`
	Frontend                *PipelineDiagnosticSettings `json:"frontend,omitempty"`
	HTTPCorrelationProtocol *HTTPCorrelationProtocol    `json:"httpCorrelationProtocol,omitempty"`
	LogClientIP             *bool                       `json:"logClientIp,omitempty"`
	LoggerId                string                      `json:"loggerId"`
	Metrics                 *bool                       `json:"metrics,omitempty"`
	OperationNameFormat     *OperationNameFormat        `json:"operationNameFormat,omitempty"`
	Sampling                *SamplingSettings           `json:"sampling,omitempty"`
	Verbosity               *Verbosity                  `json:"verbosity,omitempty"`
}

type GetEntityTagOperationResponse 

type GetEntityTagOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DiagnosticContract
}

type HTTPCorrelationProtocol 

type HTTPCorrelationProtocol string
const (
	HTTPCorrelationProtocolLegacy  HTTPCorrelationProtocol = "Legacy"
	HTTPCorrelationProtocolNone    HTTPCorrelationProtocol = "None"
	HTTPCorrelationProtocolWThreeC HTTPCorrelationProtocol = "W3C"
)

func (*HTTPCorrelationProtocol) UnmarshalJSON 

func (s *HTTPCorrelationProtocol) UnmarshalJSON(bytes []byte) error

type HTTPMessageDiagnostic 

type HTTPMessageDiagnostic struct {
	Body        *BodyDiagnosticSettings `json:"body,omitempty"`
	DataMasking *DataMasking            `json:"dataMasking,omitempty"`
	Headers     *[]string               `json:"headers,omitempty"`
}

type ListByServiceCompleteResult 

type ListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DiagnosticContract
}

type ListByServiceCustomPager added in v0.20240628.1153531 

type ListByServiceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByServiceCustomPager) NextPageLink() *odata.Link

type ListByServiceOperationOptions 

type ListByServiceOperationOptions struct {
	Filter *string
	Skip   *int64
	Top    *int64
}

func DefaultListByServiceOperationOptions 

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

func (ListByServiceOperationOptions) ToHeaders 

func (o ListByServiceOperationOptions) ToHeaders() *client.Headers

func (ListByServiceOperationOptions) ToOData 

func (o ListByServiceOperationOptions) ToOData() *odata.Query

func (ListByServiceOperationOptions) ToQuery 

func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams

type ListByServiceOperationResponse 

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DiagnosticContract
}

type OperationNameFormat 

type OperationNameFormat string
const (
	OperationNameFormatName OperationNameFormat = "Name"
	OperationNameFormatURL  OperationNameFormat = "Url"
)

func (*OperationNameFormat) UnmarshalJSON 

func (s *OperationNameFormat) UnmarshalJSON(bytes []byte) error

type PipelineDiagnosticSettings 

type PipelineDiagnosticSettings struct {
	Request  *HTTPMessageDiagnostic `json:"request,omitempty"`
	Response *HTTPMessageDiagnostic `json:"response,omitempty"`
}

type SamplingSettings 

type SamplingSettings struct {
	Percentage   *float64      `json:"percentage,omitempty"`
	SamplingType *SamplingType `json:"samplingType,omitempty"`
}

type SamplingType 

type SamplingType string
const (
	SamplingTypeFixed SamplingType = "fixed"
)

func (*SamplingType) UnmarshalJSON 

func (s *SamplingType) UnmarshalJSON(bytes []byte) error

type UpdateOperationOptions 

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions 

func DefaultUpdateOperationOptions() UpdateOperationOptions

func (UpdateOperationOptions) ToHeaders 

func (o UpdateOperationOptions) ToHeaders() *client.Headers

func (UpdateOperationOptions) ToOData 

func (o UpdateOperationOptions) ToOData() *odata.Query

func (UpdateOperationOptions) ToQuery 

func (o UpdateOperationOptions) ToQuery() *client.QueryParams

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DiagnosticContract
}

type Verbosity 

type Verbosity string
const (
	VerbosityError       Verbosity = "error"
	VerbosityInformation Verbosity = "information"
	VerbosityVerbose     Verbosity = "verbose"
)

func (*Verbosity) UnmarshalJSON 

func (s *Verbosity) UnmarshalJSON(bytes []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.