apioperationtag

package
v0.20241126.2320 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

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

The apioperationtag SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2023-03-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-03-01-preview/apioperationtag"

Client Initialization

client := apioperationtag.NewApiOperationTagClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiOperationTagClient.TagAssignToOperation

ctx := context.TODO()
id := apioperationtag.NewOperationTagID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId", "operationId", "tagId")

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

Example Usage: ApiOperationTagClient.TagDetachFromOperation

ctx := context.TODO()
id := apioperationtag.NewOperationTagID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId", "operationId", "tagId")

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

Example Usage: ApiOperationTagClient.TagGetByOperation

ctx := context.TODO()
id := apioperationtag.NewOperationTagID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId", "operationId", "tagId")

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

Example Usage: ApiOperationTagClient.TagGetEntityStateByOperation

ctx := context.TODO()
id := apioperationtag.NewOperationTagID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId", "operationId", "tagId")

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

Example Usage: ApiOperationTagClient.TagListByOperation

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateOperationID 

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

ValidateOperationID checks that 'input' can be parsed as a Operation ID

func ValidateOperationTagID 

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

ValidateOperationTagID checks that 'input' can be parsed as a Operation Tag ID

Types

type ApiOperationTagClient 

type ApiOperationTagClient struct {
	Client *resourcemanager.Client
}

func NewApiOperationTagClientWithBaseURI 

func NewApiOperationTagClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiOperationTagClient, error)

func (ApiOperationTagClient) TagAssignToOperation 

func (c ApiOperationTagClient) TagAssignToOperation(ctx context.Context, id OperationTagId) (result TagAssignToOperationOperationResponse, err error)

TagAssignToOperation ...

func (ApiOperationTagClient) TagDetachFromOperation 

func (c ApiOperationTagClient) TagDetachFromOperation(ctx context.Context, id OperationTagId) (result TagDetachFromOperationOperationResponse, err error)

TagDetachFromOperation ...

func (ApiOperationTagClient) TagGetByOperation 

func (c ApiOperationTagClient) TagGetByOperation(ctx context.Context, id OperationTagId) (result TagGetByOperationOperationResponse, err error)

TagGetByOperation ...

func (ApiOperationTagClient) TagGetEntityStateByOperation 

func (c ApiOperationTagClient) TagGetEntityStateByOperation(ctx context.Context, id OperationTagId) (result TagGetEntityStateByOperationOperationResponse, err error)

TagGetEntityStateByOperation ...

func (ApiOperationTagClient) TagListByOperation 

func (c ApiOperationTagClient) TagListByOperation(ctx context.Context, id OperationId, options TagListByOperationOperationOptions) (result TagListByOperationOperationResponse, err error)

TagListByOperation ...

func (ApiOperationTagClient) TagListByOperationComplete 

func (c ApiOperationTagClient) TagListByOperationComplete(ctx context.Context, id OperationId, options TagListByOperationOperationOptions) (TagListByOperationCompleteResult, error)

TagListByOperationComplete retrieves all the results into a single object

func (ApiOperationTagClient) TagListByOperationCompleteMatchingPredicate 

func (c ApiOperationTagClient) TagListByOperationCompleteMatchingPredicate(ctx context.Context, id OperationId, options TagListByOperationOperationOptions, predicate TagContractOperationPredicate) (result TagListByOperationCompleteResult, err error)

TagListByOperationCompleteMatchingPredicate retrieves all the results and then applies the predicate

type OperationId 

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

OperationId is a struct representing the Resource ID for a Operation

func NewOperationID 

func NewOperationID(subscriptionId string, resourceGroupName string, serviceName string, apiId string, operationId string) OperationId

NewOperationID returns a new OperationId struct

func ParseOperationID 

func ParseOperationID(input string) (*OperationId, error)

ParseOperationID parses 'input' into a OperationId

func ParseOperationIDInsensitively 

func ParseOperationIDInsensitively(input string) (*OperationId, error)

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

func (*OperationId) FromParseResult 

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

func (OperationId) ID 

func (id OperationId) ID() string

ID returns the formatted Operation ID

func (OperationId) Segments 

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

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

func (OperationId) String 

func (id OperationId) String() string

String returns a human-readable description of this Operation ID

type OperationTagId 

type OperationTagId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ApiId             string
	OperationId       string
	TagId             string
}

OperationTagId is a struct representing the Resource ID for a Operation Tag

func NewOperationTagID 

func NewOperationTagID(subscriptionId string, resourceGroupName string, serviceName string, apiId string, operationId string, tagId string) OperationTagId

NewOperationTagID returns a new OperationTagId struct

func ParseOperationTagID 

func ParseOperationTagID(input string) (*OperationTagId, error)

ParseOperationTagID parses 'input' into a OperationTagId

func ParseOperationTagIDInsensitively 

func ParseOperationTagIDInsensitively(input string) (*OperationTagId, error)

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

func (*OperationTagId) FromParseResult 

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

func (OperationTagId) ID 

func (id OperationTagId) ID() string

ID returns the formatted Operation Tag ID

func (OperationTagId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Operation Tag ID

func (OperationTagId) String 

func (id OperationTagId) String() string

String returns a human-readable description of this Operation Tag ID

type TagAssignToOperationOperationResponse 

type TagAssignToOperationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TagContract
}

type TagContract 

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

type TagContractOperationPredicate 

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

func (TagContractOperationPredicate) Matches 

func (p TagContractOperationPredicate) Matches(input TagContract) bool

type TagContractProperties 

type TagContractProperties struct {
	DisplayName string `json:"displayName"`
}

type TagDetachFromOperationOperationResponse 

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

type TagGetByOperationOperationResponse 

type TagGetByOperationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TagContract
}

type TagGetEntityStateByOperationOperationResponse 

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

type TagListByOperationCompleteResult 

type TagListByOperationCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TagContract
}

type TagListByOperationCustomPager 

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

type TagListByOperationOperationOptions 

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

func DefaultTagListByOperationOperationOptions 

func DefaultTagListByOperationOperationOptions() TagListByOperationOperationOptions

func (TagListByOperationOperationOptions) ToHeaders 

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

func (TagListByOperationOperationOptions) ToOData 

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

func (TagListByOperationOperationOptions) ToQuery 

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

type TagListByOperationOperationResponse 

type TagListByOperationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TagContract
}

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.