apitagdescription

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/2022-08-01/apitagdescription Documentation

The apitagdescription SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2022-08-01).

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/2022-08-01/apitagdescription"

Client Initialization

client := apitagdescription.NewApiTagDescriptionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiTagDescriptionClient.CreateOrUpdate

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

payload := apitagdescription.TagDescriptionCreateParameters{
	// ...
}


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

Example Usage: ApiTagDescriptionClient.Delete

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

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

Example Usage: ApiTagDescriptionClient.Get

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

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: ApiTagDescriptionClient.GetEntityTag

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

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: ApiTagDescriptionClient.ListByService

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

// alternatively `client.ListByService(ctx, id, apitagdescription.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, apitagdescription.DefaultListByServiceOperationOptions())
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 ValidateApiID 

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

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

func ValidateTagDescriptionID 

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

ValidateTagDescriptionID checks that 'input' can be parsed as a Tag Description ID

Types

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 ApiTagDescriptionClient 

type ApiTagDescriptionClient struct {
	Client *resourcemanager.Client
}

func NewApiTagDescriptionClientWithBaseURI 

func NewApiTagDescriptionClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiTagDescriptionClient, error)

func (ApiTagDescriptionClient) CreateOrUpdate 

func (c ApiTagDescriptionClient) CreateOrUpdate(ctx context.Context, id TagDescriptionId, input TagDescriptionCreateParameters, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ApiTagDescriptionClient) Delete 

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

Delete ...

func (ApiTagDescriptionClient) Get 

func (c ApiTagDescriptionClient) Get(ctx context.Context, id TagDescriptionId) (result GetOperationResponse, err error)

Get ...

func (ApiTagDescriptionClient) GetEntityTag 

func (c ApiTagDescriptionClient) GetEntityTag(ctx context.Context, id TagDescriptionId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (ApiTagDescriptionClient) ListByService 

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

ListByService ...

func (ApiTagDescriptionClient) ListByServiceComplete 

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

ListByServiceComplete retrieves all the results into a single object

func (ApiTagDescriptionClient) ListByServiceCompleteMatchingPredicate 

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

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

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        *TagDescriptionContract
}

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 GetEntityTagOperationResponse 

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

type GetOperationResponse 

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

type ListByServiceCompleteResult 

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

type ListByServiceCustomPager 

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        *[]TagDescriptionContract
}

type TagDescriptionBaseProperties 

type TagDescriptionBaseProperties struct {
	Description             *string `json:"description,omitempty"`
	ExternalDocsDescription *string `json:"externalDocsDescription,omitempty"`
	ExternalDocsURL         *string `json:"externalDocsUrl,omitempty"`
}

type TagDescriptionContract 

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

type TagDescriptionContractOperationPredicate 

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

func (TagDescriptionContractOperationPredicate) Matches 

func (p TagDescriptionContractOperationPredicate) Matches(input TagDescriptionContract) bool

type TagDescriptionContractProperties 

type TagDescriptionContractProperties struct {
	Description             *string `json:"description,omitempty"`
	DisplayName             *string `json:"displayName,omitempty"`
	ExternalDocsDescription *string `json:"externalDocsDescription,omitempty"`
	ExternalDocsURL         *string `json:"externalDocsUrl,omitempty"`
	TagId                   *string `json:"tagId,omitempty"`
}

type TagDescriptionCreateParameters 

type TagDescriptionCreateParameters struct {
	Properties *TagDescriptionBaseProperties `json:"properties,omitempty"`
}

type TagDescriptionId 

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

TagDescriptionId is a struct representing the Resource ID for a Tag Description

func NewTagDescriptionID 

func NewTagDescriptionID(subscriptionId string, resourceGroupName string, serviceName string, apiId string, tagDescriptionId string) TagDescriptionId

NewTagDescriptionID returns a new TagDescriptionId struct

func ParseTagDescriptionID 

func ParseTagDescriptionID(input string) (*TagDescriptionId, error)

ParseTagDescriptionID parses 'input' into a TagDescriptionId

func ParseTagDescriptionIDInsensitively 

func ParseTagDescriptionIDInsensitively(input string) (*TagDescriptionId, error)

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

func (*TagDescriptionId) FromParseResult 

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

func (TagDescriptionId) ID 

func (id TagDescriptionId) ID() string

ID returns the formatted Tag Description ID

func (TagDescriptionId) Segments 

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

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

func (TagDescriptionId) String 

func (id TagDescriptionId) String() string

String returns a human-readable description of this Tag Description 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.