tagapilink

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

The tagapilink 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/tagapilink"

Client Initialization

client := tagapilink.NewTagApiLinkClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TagApiLinkClient.CreateOrUpdate

ctx := context.TODO()
id := tagapilink.NewApiLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "tagId", "apiLinkId")

payload := tagapilink.TagApiLinkContract{
	// ...
}


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

Example Usage: TagApiLinkClient.Delete

ctx := context.TODO()
id := tagapilink.NewApiLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "tagId", "apiLinkId")

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

Example Usage: TagApiLinkClient.Get

ctx := context.TODO()
id := tagapilink.NewApiLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "tagId", "apiLinkId")

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: TagApiLinkClient.ListByProduct

ctx := context.TODO()
id := tagapilink.NewTagID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "tagId")

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

Example Usage: TagApiLinkClient.WorkspaceTagApiLinkCreateOrUpdate

ctx := context.TODO()
id := tagapilink.NewTagApiLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "tagId", "apiLinkId")

payload := tagapilink.TagApiLinkContract{
	// ...
}


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

Example Usage: TagApiLinkClient.WorkspaceTagApiLinkDelete

ctx := context.TODO()
id := tagapilink.NewTagApiLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "tagId", "apiLinkId")

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

Example Usage: TagApiLinkClient.WorkspaceTagApiLinkGet

ctx := context.TODO()
id := tagapilink.NewTagApiLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "tagId", "apiLinkId")

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

Example Usage: TagApiLinkClient.WorkspaceTagApiLinkListByProduct

ctx := context.TODO()
id := tagapilink.NewWorkspaceTagID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "tagId")

// alternatively `client.WorkspaceTagApiLinkListByProduct(ctx, id, tagapilink.DefaultWorkspaceTagApiLinkListByProductOperationOptions())` can be used to do batched pagination
items, err := client.WorkspaceTagApiLinkListByProductComplete(ctx, id, tagapilink.DefaultWorkspaceTagApiLinkListByProductOperationOptions())
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 ValidateApiLinkID 

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

ValidateApiLinkID checks that 'input' can be parsed as a Api Link ID

func ValidateTagApiLinkID 

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

ValidateTagApiLinkID checks that 'input' can be parsed as a Tag Api Link ID

func ValidateTagID 

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

ValidateTagID checks that 'input' can be parsed as a Tag ID

func ValidateWorkspaceTagID 

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

ValidateWorkspaceTagID checks that 'input' can be parsed as a Workspace Tag ID

Types

type ApiLinkId 

type ApiLinkId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	TagId             string
	ApiLinkId         string
}

ApiLinkId is a struct representing the Resource ID for a Api Link

func NewApiLinkID 

func NewApiLinkID(subscriptionId string, resourceGroupName string, serviceName string, tagId string, apiLinkId string) ApiLinkId

NewApiLinkID returns a new ApiLinkId struct

func ParseApiLinkID 

func ParseApiLinkID(input string) (*ApiLinkId, error)

ParseApiLinkID parses 'input' into a ApiLinkId

func ParseApiLinkIDInsensitively 

func ParseApiLinkIDInsensitively(input string) (*ApiLinkId, error)

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

func (*ApiLinkId) FromParseResult 

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

func (ApiLinkId) ID 

func (id ApiLinkId) ID() string

ID returns the formatted Api Link ID

func (ApiLinkId) Segments 

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

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

func (ApiLinkId) String 

func (id ApiLinkId) String() string

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

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByProductCompleteResult 

type ListByProductCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TagApiLinkContract
}

type ListByProductCustomPager 

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

type ListByProductOperationOptions 

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

func DefaultListByProductOperationOptions 

func DefaultListByProductOperationOptions() ListByProductOperationOptions

func (ListByProductOperationOptions) ToHeaders 

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

func (ListByProductOperationOptions) ToOData 

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

func (ListByProductOperationOptions) ToQuery 

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

type ListByProductOperationResponse 

type ListByProductOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TagApiLinkContract
}

type TagApiLinkClient 

type TagApiLinkClient struct {
	Client *resourcemanager.Client
}

func NewTagApiLinkClientWithBaseURI 

func NewTagApiLinkClientWithBaseURI(sdkApi sdkEnv.Api) (*TagApiLinkClient, error)

func (TagApiLinkClient) CreateOrUpdate 

func (c TagApiLinkClient) CreateOrUpdate(ctx context.Context, id ApiLinkId, input TagApiLinkContract) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (TagApiLinkClient) Delete 

func (c TagApiLinkClient) Delete(ctx context.Context, id ApiLinkId) (result DeleteOperationResponse, err error)

Delete ...

func (TagApiLinkClient) Get 

func (c TagApiLinkClient) Get(ctx context.Context, id ApiLinkId) (result GetOperationResponse, err error)

Get ...

func (TagApiLinkClient) ListByProduct 

func (c TagApiLinkClient) ListByProduct(ctx context.Context, id TagId, options ListByProductOperationOptions) (result ListByProductOperationResponse, err error)

ListByProduct ...

func (TagApiLinkClient) ListByProductComplete 

func (c TagApiLinkClient) ListByProductComplete(ctx context.Context, id TagId, options ListByProductOperationOptions) (ListByProductCompleteResult, error)

ListByProductComplete retrieves all the results into a single object

func (TagApiLinkClient) ListByProductCompleteMatchingPredicate 

func (c TagApiLinkClient) ListByProductCompleteMatchingPredicate(ctx context.Context, id TagId, options ListByProductOperationOptions, predicate TagApiLinkContractOperationPredicate) (result ListByProductCompleteResult, err error)

ListByProductCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TagApiLinkClient) WorkspaceTagApiLinkCreateOrUpdate 

func (c TagApiLinkClient) WorkspaceTagApiLinkCreateOrUpdate(ctx context.Context, id TagApiLinkId, input TagApiLinkContract) (result WorkspaceTagApiLinkCreateOrUpdateOperationResponse, err error)

WorkspaceTagApiLinkCreateOrUpdate ...

func (TagApiLinkClient) WorkspaceTagApiLinkDelete 

func (c TagApiLinkClient) WorkspaceTagApiLinkDelete(ctx context.Context, id TagApiLinkId) (result WorkspaceTagApiLinkDeleteOperationResponse, err error)

WorkspaceTagApiLinkDelete ...

func (TagApiLinkClient) WorkspaceTagApiLinkGet 

func (c TagApiLinkClient) WorkspaceTagApiLinkGet(ctx context.Context, id TagApiLinkId) (result WorkspaceTagApiLinkGetOperationResponse, err error)

WorkspaceTagApiLinkGet ...

func (TagApiLinkClient) WorkspaceTagApiLinkListByProduct 

func (c TagApiLinkClient) WorkspaceTagApiLinkListByProduct(ctx context.Context, id WorkspaceTagId, options WorkspaceTagApiLinkListByProductOperationOptions) (result WorkspaceTagApiLinkListByProductOperationResponse, err error)

WorkspaceTagApiLinkListByProduct ...

func (TagApiLinkClient) WorkspaceTagApiLinkListByProductComplete 

func (c TagApiLinkClient) WorkspaceTagApiLinkListByProductComplete(ctx context.Context, id WorkspaceTagId, options WorkspaceTagApiLinkListByProductOperationOptions) (WorkspaceTagApiLinkListByProductCompleteResult, error)

WorkspaceTagApiLinkListByProductComplete retrieves all the results into a single object

func (TagApiLinkClient) WorkspaceTagApiLinkListByProductCompleteMatchingPredicate 

func (c TagApiLinkClient) WorkspaceTagApiLinkListByProductCompleteMatchingPredicate(ctx context.Context, id WorkspaceTagId, options WorkspaceTagApiLinkListByProductOperationOptions, predicate TagApiLinkContractOperationPredicate) (result WorkspaceTagApiLinkListByProductCompleteResult, err error)

WorkspaceTagApiLinkListByProductCompleteMatchingPredicate retrieves all the results and then applies the predicate

type TagApiLinkContract 

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

type TagApiLinkContractOperationPredicate 

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

func (TagApiLinkContractOperationPredicate) Matches 

func (p TagApiLinkContractOperationPredicate) Matches(input TagApiLinkContract) bool

type TagApiLinkContractProperties 

type TagApiLinkContractProperties struct {
	ApiId string `json:"apiId"`
}

type TagApiLinkId 

type TagApiLinkId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
	TagId             string
	ApiLinkId         string
}

TagApiLinkId is a struct representing the Resource ID for a Tag Api Link

func NewTagApiLinkID 

func NewTagApiLinkID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string, tagId string, apiLinkId string) TagApiLinkId

NewTagApiLinkID returns a new TagApiLinkId struct

func ParseTagApiLinkID 

func ParseTagApiLinkID(input string) (*TagApiLinkId, error)

ParseTagApiLinkID parses 'input' into a TagApiLinkId

func ParseTagApiLinkIDInsensitively 

func ParseTagApiLinkIDInsensitively(input string) (*TagApiLinkId, error)

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

func (*TagApiLinkId) FromParseResult 

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

func (TagApiLinkId) ID 

func (id TagApiLinkId) ID() string

ID returns the formatted Tag Api Link ID

func (TagApiLinkId) Segments 

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

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

func (TagApiLinkId) String 

func (id TagApiLinkId) String() string

String returns a human-readable description of this Tag Api Link ID

type TagId 

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

TagId is a struct representing the Resource ID for a Tag

func NewTagID 

func NewTagID(subscriptionId string, resourceGroupName string, serviceName string, tagId string) TagId

NewTagID returns a new TagId struct

func ParseTagID 

func ParseTagID(input string) (*TagId, error)

ParseTagID parses 'input' into a TagId

func ParseTagIDInsensitively 

func ParseTagIDInsensitively(input string) (*TagId, error)

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

func (*TagId) FromParseResult 

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

func (TagId) ID 

func (id TagId) ID() string

ID returns the formatted Tag ID

func (TagId) Segments 

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

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

func (TagId) String 

func (id TagId) String() string

String returns a human-readable description of this Tag ID

type WorkspaceTagApiLinkCreateOrUpdateOperationResponse 

type WorkspaceTagApiLinkCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TagApiLinkContract
}

type WorkspaceTagApiLinkDeleteOperationResponse 

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

type WorkspaceTagApiLinkGetOperationResponse 

type WorkspaceTagApiLinkGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TagApiLinkContract
}

type WorkspaceTagApiLinkListByProductCompleteResult 

type WorkspaceTagApiLinkListByProductCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TagApiLinkContract
}

type WorkspaceTagApiLinkListByProductCustomPager 

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

type WorkspaceTagApiLinkListByProductOperationOptions 

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

func DefaultWorkspaceTagApiLinkListByProductOperationOptions 

func DefaultWorkspaceTagApiLinkListByProductOperationOptions() WorkspaceTagApiLinkListByProductOperationOptions

func (WorkspaceTagApiLinkListByProductOperationOptions) ToHeaders 

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

func (WorkspaceTagApiLinkListByProductOperationOptions) ToOData 

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

func (WorkspaceTagApiLinkListByProductOperationOptions) ToQuery 

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

type WorkspaceTagApiLinkListByProductOperationResponse 

type WorkspaceTagApiLinkListByProductOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TagApiLinkContract
}

type WorkspaceTagId 

type WorkspaceTagId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
	TagId             string
}

WorkspaceTagId is a struct representing the Resource ID for a Workspace Tag

func NewWorkspaceTagID 

func NewWorkspaceTagID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string, tagId string) WorkspaceTagId

NewWorkspaceTagID returns a new WorkspaceTagId struct

func ParseWorkspaceTagID 

func ParseWorkspaceTagID(input string) (*WorkspaceTagId, error)

ParseWorkspaceTagID parses 'input' into a WorkspaceTagId

func ParseWorkspaceTagIDInsensitively 

func ParseWorkspaceTagIDInsensitively(input string) (*WorkspaceTagId, error)

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

func (*WorkspaceTagId) FromParseResult 

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

func (WorkspaceTagId) ID 

func (id WorkspaceTagId) ID() string

ID returns the formatted Workspace Tag ID

func (WorkspaceTagId) Segments 

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

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

func (WorkspaceTagId) String 

func (id WorkspaceTagId) String() string

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

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.