apisbytag

package
v0.20240612.1122027 Latest Latest
Warning

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

 Go to latest Published: Jun 12, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

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

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

Client Initialization

client := apisbytag.NewApisByTagClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApisByTagClient.ApiListByTags

ctx := context.TODO()
id := apisbytag.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")

// alternatively `client.ApiListByTags(ctx, id, apisbytag.DefaultApiListByTagsOperationOptions())` can be used to do batched pagination
items, err := client.ApiListByTagsComplete(ctx, id, apisbytag.DefaultApiListByTagsOperationOptions())
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 ValidateServiceID 

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

Types

type ApiContactInformation 

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

type ApiLicenseInformation 

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

type ApiListByTagsCompleteResult 

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

type ApiListByTagsOperationOptions 

type ApiListByTagsOperationOptions struct {
	Filter               *string
	IncludeNotTaggedApis *bool
	Skip                 *int64
	Top                  *int64
}

func DefaultApiListByTagsOperationOptions 

func DefaultApiListByTagsOperationOptions() ApiListByTagsOperationOptions

func (ApiListByTagsOperationOptions) ToHeaders 

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

func (ApiListByTagsOperationOptions) ToOData 

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

func (ApiListByTagsOperationOptions) ToQuery 

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

type ApiListByTagsOperationResponse 

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

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"
	ApiTypeGrpc      ApiType = "grpc"
	ApiTypeHTTP      ApiType = "http"
	ApiTypeOdata     ApiType = "odata"
	ApiTypeSoap      ApiType = "soap"
	ApiTypeWebsocket ApiType = "websocket"
)

func (*ApiType) UnmarshalJSON 

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

type ApisByTagClient 

type ApisByTagClient struct {
	Client *resourcemanager.Client
}

func NewApisByTagClientWithBaseURI 

func NewApisByTagClientWithBaseURI(sdkApi sdkEnv.Api) (*ApisByTagClient, error)

func (ApisByTagClient) ApiListByTags 

func (c ApisByTagClient) ApiListByTags(ctx context.Context, id ServiceId, options ApiListByTagsOperationOptions) (result ApiListByTagsOperationResponse, err error)

ApiListByTags ...

func (ApisByTagClient) ApiListByTagsComplete 

func (c ApisByTagClient) ApiListByTagsComplete(ctx context.Context, id ServiceId, options ApiListByTagsOperationOptions) (ApiListByTagsCompleteResult, error)

ApiListByTagsComplete retrieves all the results into a single object

func (ApisByTagClient) ApiListByTagsCompleteMatchingPredicate 

func (c ApisByTagClient) ApiListByTagsCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ApiListByTagsOperationOptions, predicate TagResourceContractOperationPredicate) (result ApiListByTagsCompleteResult, err error)

ApiListByTagsCompleteMatchingPredicate retrieves all the results and then applies the predicate

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

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID 

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID 

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively 

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (*ServiceId) FromParseResult 

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

func (ServiceId) ID 

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments 

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

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

func (ServiceId) String 

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

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.