apioperationsbytag

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: 11 Imported by: 0

README

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

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

Client Initialization

client := apioperationsbytag.NewApiOperationsByTagClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiOperationsByTagClient.OperationListByTags

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

// alternatively `client.OperationListByTags(ctx, id, apioperationsbytag.DefaultOperationListByTagsOperationOptions())` can be used to do batched pagination
items, err := client.OperationListByTagsComplete(ctx, id, apioperationsbytag.DefaultOperationListByTagsOperationOptions())
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 PossibleValuesForApiType 

func PossibleValuesForApiType() []string

func PossibleValuesForBearerTokenSendingMethods 

func PossibleValuesForBearerTokenSendingMethods() []string

func PossibleValuesForProductState 

func PossibleValuesForProductState() []string

func PossibleValuesForProtocol 

func PossibleValuesForProtocol() []string

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 ApiContactInformation 

type ApiContactInformation struct {
	Email *string `json:"email,omitempty"`
	Name  *string `json:"name,omitempty"`
	Url   *string `json:"url,omitempty"`
}

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 ApiLicenseInformation 

type ApiLicenseInformation struct {
	Name *string `json:"name,omitempty"`
	Url  *string `json:"url,omitempty"`
}

type ApiOperationsByTagClient 

type ApiOperationsByTagClient struct {
	Client *resourcemanager.Client
}

func NewApiOperationsByTagClientWithBaseURI 

func NewApiOperationsByTagClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiOperationsByTagClient, error)

func (ApiOperationsByTagClient) OperationListByTags 

func (c ApiOperationsByTagClient) OperationListByTags(ctx context.Context, id ApiId, options OperationListByTagsOperationOptions) (result OperationListByTagsOperationResponse, err error)

OperationListByTags ...

func (ApiOperationsByTagClient) OperationListByTagsComplete 

func (c ApiOperationsByTagClient) OperationListByTagsComplete(ctx context.Context, id ApiId, options OperationListByTagsOperationOptions) (OperationListByTagsCompleteResult, error)

OperationListByTagsComplete retrieves all the results into a single object

func (ApiOperationsByTagClient) OperationListByTagsCompleteMatchingPredicate 

func (c ApiOperationsByTagClient) OperationListByTagsCompleteMatchingPredicate(ctx context.Context, id ApiId, options OperationListByTagsOperationOptions, predicate TagResourceContractOperationPredicate) (result OperationListByTagsCompleteResult, err error)

OperationListByTagsCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ApiTagResourceContractProperties 

type ApiTagResourceContractProperties struct {
	ApiRevision                   *string                                `json:"apiRevision,omitempty"`
	ApiRevisionDescription        *string                                `json:"apiRevisionDescription,omitempty"`
	ApiVersion                    *string                                `json:"apiVersion,omitempty"`
	ApiVersionDescription         *string                                `json:"apiVersionDescription,omitempty"`
	ApiVersionSetId               *string                                `json:"apiVersionSetId,omitempty"`
	AuthenticationSettings        *AuthenticationSettingsContract        `json:"authenticationSettings,omitempty"`
	Contact                       *ApiContactInformation                 `json:"contact,omitempty"`
	Description                   *string                                `json:"description,omitempty"`
	Id                            *string                                `json:"id,omitempty"`
	IsCurrent                     *bool                                  `json:"isCurrent,omitempty"`
	IsOnline                      *bool                                  `json:"isOnline,omitempty"`
	License                       *ApiLicenseInformation                 `json:"license,omitempty"`
	Name                          *string                                `json:"name,omitempty"`
	Path                          *string                                `json:"path,omitempty"`
	Protocols                     *[]Protocol                            `json:"protocols,omitempty"`
	ServiceURL                    *string                                `json:"serviceUrl,omitempty"`
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	SubscriptionRequired          *bool                                  `json:"subscriptionRequired,omitempty"`
	TermsOfServiceURL             *string                                `json:"termsOfServiceUrl,omitempty"`
	Type                          *ApiType                               `json:"type,omitempty"`
}

type ApiType 

type ApiType string
const (
	ApiTypeGraphql   ApiType = "graphql"
	ApiTypeHTTP      ApiType = "http"
	ApiTypeOdata     ApiType = "odata"
	ApiTypeSoap      ApiType = "soap"
	ApiTypeWebsocket ApiType = "websocket"
)

func (*ApiType) UnmarshalJSON 

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

type AuthenticationSettingsContract 

type AuthenticationSettingsContract struct {
	OAuth2                       *OAuth2AuthenticationSettingsContract   `json:"oAuth2,omitempty"`
	OAuth2AuthenticationSettings *[]OAuth2AuthenticationSettingsContract `json:"oAuth2AuthenticationSettings,omitempty"`
	Openid                       *OpenIdAuthenticationSettingsContract   `json:"openid,omitempty"`
	OpenidAuthenticationSettings *[]OpenIdAuthenticationSettingsContract `json:"openidAuthenticationSettings,omitempty"`
}

type BearerTokenSendingMethods 

type BearerTokenSendingMethods string
const (
	BearerTokenSendingMethodsAuthorizationHeader BearerTokenSendingMethods = "authorizationHeader"
	BearerTokenSendingMethodsQuery               BearerTokenSendingMethods = "query"
)

func (*BearerTokenSendingMethods) UnmarshalJSON 

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

type OAuth2AuthenticationSettingsContract 

type OAuth2AuthenticationSettingsContract struct {
	AuthorizationServerId *string `json:"authorizationServerId,omitempty"`
	Scope                 *string `json:"scope,omitempty"`
}

type OpenIdAuthenticationSettingsContract 

type OpenIdAuthenticationSettingsContract struct {
	BearerTokenSendingMethods *[]BearerTokenSendingMethods `json:"bearerTokenSendingMethods,omitempty"`
	OpenidProviderId          *string                      `json:"openidProviderId,omitempty"`
}

type OperationListByTagsCompleteResult 

type OperationListByTagsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TagResourceContract
}

type OperationListByTagsCustomPager 

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

type OperationListByTagsOperationOptions 

type OperationListByTagsOperationOptions struct {
	Filter                     *string
	IncludeNotTaggedOperations *bool
	Skip                       *int64
	Top                        *int64
}

func DefaultOperationListByTagsOperationOptions 

func DefaultOperationListByTagsOperationOptions() OperationListByTagsOperationOptions

func (OperationListByTagsOperationOptions) ToHeaders 

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

func (OperationListByTagsOperationOptions) ToOData 

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

func (OperationListByTagsOperationOptions) ToQuery 

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

type OperationListByTagsOperationResponse 

type OperationListByTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TagResourceContract
}

type OperationTagResourceContractProperties 

type OperationTagResourceContractProperties struct {
	ApiName     *string `json:"apiName,omitempty"`
	ApiRevision *string `json:"apiRevision,omitempty"`
	ApiVersion  *string `json:"apiVersion,omitempty"`
	Description *string `json:"description,omitempty"`
	Id          *string `json:"id,omitempty"`
	Method      *string `json:"method,omitempty"`
	Name        *string `json:"name,omitempty"`
	UrlTemplate *string `json:"urlTemplate,omitempty"`
}

type ProductState 

type ProductState string
const (
	ProductStateNotPublished ProductState = "notPublished"
	ProductStatePublished    ProductState = "published"
)

func (*ProductState) UnmarshalJSON 

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

type ProductTagResourceContractProperties 

type ProductTagResourceContractProperties struct {
	ApprovalRequired     *bool         `json:"approvalRequired,omitempty"`
	Description          *string       `json:"description,omitempty"`
	Id                   *string       `json:"id,omitempty"`
	Name                 string        `json:"name"`
	State                *ProductState `json:"state,omitempty"`
	SubscriptionRequired *bool         `json:"subscriptionRequired,omitempty"`
	SubscriptionsLimit   *int64        `json:"subscriptionsLimit,omitempty"`
	Terms                *string       `json:"terms,omitempty"`
}

type Protocol 

type Protocol string
const (
	ProtocolHTTP  Protocol = "http"
	ProtocolHTTPS Protocol = "https"
	ProtocolWs    Protocol = "ws"
	ProtocolWss   Protocol = "wss"
)

func (*Protocol) UnmarshalJSON 

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

type SubscriptionKeyParameterNamesContract 

type SubscriptionKeyParameterNamesContract struct {
	Header *string `json:"header,omitempty"`
	Query  *string `json:"query,omitempty"`
}

type TagResourceContract 

type TagResourceContract struct {
	Api       *ApiTagResourceContractProperties       `json:"api,omitempty"`
	Operation *OperationTagResourceContractProperties `json:"operation,omitempty"`
	Product   *ProductTagResourceContractProperties   `json:"product,omitempty"`
	Tag       TagTagResourceContractProperties        `json:"tag"`
}

type TagResourceContractOperationPredicate 

type TagResourceContractOperationPredicate struct {
}

func (TagResourceContractOperationPredicate) Matches 

func (p TagResourceContractOperationPredicate) Matches(input TagResourceContract) bool

type TagTagResourceContractProperties 

type TagTagResourceContractProperties struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
}

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.