apitagdescription

package
v0.20240606.1065251 Latest Latest
Warning

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

Go to latest
Published: Jun 6, 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 the Azure Resource Manager Service 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", "serviceValue", "apiIdValue", "tagDescriptionIdValue")

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", "serviceValue", "apiIdValue", "tagDescriptionIdValue")

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", "serviceValue", "apiIdValue", "tagDescriptionIdValue")

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", "serviceValue", "apiIdValue", "tagDescriptionIdValue")

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", "serviceValue", "apiIdValue")

// 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

CreateOrUpdate ...

func (ApiTagDescriptionClient) Delete

Delete ...

func (ApiTagDescriptionClient) Get

Get ...

func (ApiTagDescriptionClient) GetEntityTag

GetEntityTag ...

func (ApiTagDescriptionClient) ListByService

ListByService ...

func (ApiTagDescriptionClient) ListByServiceComplete

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 (CreateOrUpdateOperationOptions) ToOData

func (CreateOrUpdateOperationOptions) ToQuery

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

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 ListByServiceOperationOptions

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

func DefaultListByServiceOperationOptions

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

func (ListByServiceOperationOptions) ToHeaders

func (ListByServiceOperationOptions) ToOData

func (ListByServiceOperationOptions) ToQuery

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL