gatewayapi

package
v0.20230228.1155508 Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2023 License: MPL-2.0 Imports: 8 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/gatewayapi Documentation

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

Client Initialization

client := gatewayapi.NewGatewayApiClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GatewayApiClient.CreateOrUpdate

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

payload := gatewayapi.AssociationContract{
	// ...
}


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: GatewayApiClient.Delete

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

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

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

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

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

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

func PossibleValuesForApiType() []string

func PossibleValuesForBearerTokenSendingMethods 

func PossibleValuesForBearerTokenSendingMethods() []string

func PossibleValuesForProtocol 

func PossibleValuesForProtocol() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForVersioningScheme 

func PossibleValuesForVersioningScheme() []string

func ValidateApiID 

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

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

func ValidateGatewayID 

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

ValidateGatewayID checks that 'input' can be parsed as a Gateway ID

Types

type ApiContactInformation 

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

type ApiContract 

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

type ApiContractOperationPredicate 

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

func (ApiContractOperationPredicate) Matches 

func (p ApiContractOperationPredicate) Matches(input ApiContract) bool

type ApiContractProperties 

type ApiContractProperties struct {
	ApiRevision                   *string                                `json:"apiRevision,omitempty"`
	ApiRevisionDescription        *string                                `json:"apiRevisionDescription,omitempty"`
	ApiVersion                    *string                                `json:"apiVersion,omitempty"`
	ApiVersionDescription         *string                                `json:"apiVersionDescription,omitempty"`
	ApiVersionSet                 *ApiVersionSetContractDetails          `json:"apiVersionSet,omitempty"`
	ApiVersionSetId               *string                                `json:"apiVersionSetId,omitempty"`
	AuthenticationSettings        *AuthenticationSettingsContract        `json:"authenticationSettings,omitempty"`
	Contact                       *ApiContactInformation                 `json:"contact,omitempty"`
	Description                   *string                                `json:"description,omitempty"`
	DisplayName                   *string                                `json:"displayName,omitempty"`
	IsCurrent                     *bool                                  `json:"isCurrent,omitempty"`
	IsOnline                      *bool                                  `json:"isOnline,omitempty"`
	License                       *ApiLicenseInformation                 `json:"license,omitempty"`
	Path                          string                                 `json:"path"`
	Protocols                     *[]Protocol                            `json:"protocols,omitempty"`
	ServiceUrl                    *string                                `json:"serviceUrl,omitempty"`
	SourceApiId                   *string                                `json:"sourceApiId,omitempty"`
	SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
	SubscriptionRequired          *bool                                  `json:"subscriptionRequired,omitempty"`
	TermsOfServiceUrl             *string                                `json:"termsOfServiceUrl,omitempty"`
	Type                          *ApiType                               `json:"type,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) 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 ApiType 

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

type ApiVersionSetContractDetails 

type ApiVersionSetContractDetails struct {
	Description       *string           `json:"description,omitempty"`
	Id                *string           `json:"id,omitempty"`
	Name              *string           `json:"name,omitempty"`
	VersionHeaderName *string           `json:"versionHeaderName,omitempty"`
	VersionQueryName  *string           `json:"versionQueryName,omitempty"`
	VersioningScheme  *VersioningScheme `json:"versioningScheme,omitempty"`
}

type AssociationContract 

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

type AssociationContractProperties 

type AssociationContractProperties struct {
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

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"
)

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *ApiContract
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GatewayApiClient 

type GatewayApiClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewGatewayApiClientWithBaseURI 

func NewGatewayApiClientWithBaseURI(endpoint string) GatewayApiClient

func (GatewayApiClient) CreateOrUpdate 

func (c GatewayApiClient) CreateOrUpdate(ctx context.Context, id ApiId, input AssociationContract) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (GatewayApiClient) Delete 

func (c GatewayApiClient) Delete(ctx context.Context, id ApiId) (result DeleteOperationResponse, err error)

Delete ...

func (GatewayApiClient) GetEntityTag 

func (c GatewayApiClient) GetEntityTag(ctx context.Context, id ApiId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (GatewayApiClient) ListByService 

func (c GatewayApiClient) ListByService(ctx context.Context, id GatewayId, options ListByServiceOperationOptions) (resp ListByServiceOperationResponse, err error)

ListByService ...

func (GatewayApiClient) ListByServiceComplete 

func (c GatewayApiClient) ListByServiceComplete(ctx context.Context, id GatewayId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all of the results into a single object

func (GatewayApiClient) ListByServiceCompleteMatchingPredicate 

func (c GatewayApiClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id GatewayId, options ListByServiceOperationOptions, predicate ApiContractOperationPredicate) (resp ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type GatewayId 

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

GatewayId is a struct representing the Resource ID for a Gateway

func NewGatewayID 

func NewGatewayID(subscriptionId string, resourceGroupName string, serviceName string, gatewayId string) GatewayId

NewGatewayID returns a new GatewayId struct

func ParseGatewayID 

func ParseGatewayID(input string) (*GatewayId, error)

ParseGatewayID parses 'input' into a GatewayId

func ParseGatewayIDInsensitively 

func ParseGatewayIDInsensitively(input string) (*GatewayId, error)

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

func (GatewayId) ID 

func (id GatewayId) ID() string

ID returns the formatted Gateway ID

func (GatewayId) Segments 

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

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

func (GatewayId) String 

func (id GatewayId) String() string

String returns a human-readable description of this Gateway ID

type GetEntityTagOperationResponse 

type GetEntityTagOperationResponse struct {
	HttpResponse *http.Response
}

type ListByServiceCompleteResult 

type ListByServiceCompleteResult struct {
	Items []ApiContract
}

type ListByServiceOperationOptions 

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

func DefaultListByServiceOperationOptions 

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

type ListByServiceOperationResponse 

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]ApiContract
	// contains filtered or unexported fields
}

func (ListByServiceOperationResponse) HasMore 

func (r ListByServiceOperationResponse) HasMore() bool

func (ListByServiceOperationResponse) LoadMore 

func (r ListByServiceOperationResponse) LoadMore(ctx context.Context) (resp ListByServiceOperationResponse, err 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 Protocol 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCreated ProvisioningState = "created"
)

type SubscriptionKeyParameterNamesContract 

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

type VersioningScheme 

type VersioningScheme string
const (
	VersioningSchemeHeader  VersioningScheme = "Header"
	VersioningSchemeQuery   VersioningScheme = "Query"
	VersioningSchemeSegment VersioningScheme = "Segment"
)

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.