api

package
v0.20230317.1154451 Latest Latest
Warning

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

Go to latest
Published: Mar 17, 2023 License: MPL-2.0 Imports: 9 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2021-08-01/api Documentation

The api SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2021-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/2021-08-01/api"

Client Initialization

client := api.NewApiClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiClient.CreateOrUpdate

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

payload := api.ApiCreateOrUpdateParameter{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload, api.DefaultCreateOrUpdateOperationOptions()); err != nil {
	// handle the error
}

Example Usage: ApiClient.Delete

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

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

Example Usage: ApiClient.Get

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

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

ctx := context.TODO()
id := api.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: ApiClient.ListByService

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

// alternatively `client.ListByService(ctx, id, api.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, api.DefaultListByServiceOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ApiClient.Update

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

payload := api.ApiUpdateContract{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForApiType

func PossibleValuesForApiType() []string

func PossibleValuesForBearerTokenSendingMethods

func PossibleValuesForBearerTokenSendingMethods() []string

func PossibleValuesForContentFormat

func PossibleValuesForContentFormat() []string

func PossibleValuesForProtocol

func PossibleValuesForProtocol() []string

func PossibleValuesForSoapApiType

func PossibleValuesForSoapApiType() []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 ValidateServiceID

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

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

Types

type ApiClient

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

func NewApiClientWithBaseURI

func NewApiClientWithBaseURI(endpoint string) ApiClient

func (ApiClient) CreateOrUpdate

CreateOrUpdate ...

func (ApiClient) CreateOrUpdateThenPoll

func (c ApiClient) CreateOrUpdateThenPoll(ctx context.Context, id ApiId, input ApiCreateOrUpdateParameter, options CreateOrUpdateOperationOptions) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ApiClient) Delete

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

Delete ...

func (ApiClient) Get

func (c ApiClient) Get(ctx context.Context, id ApiId) (result GetOperationResponse, err error)

Get ...

func (ApiClient) GetEntityTag

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

GetEntityTag ...

func (ApiClient) ListByService

ListByService ...

func (ApiClient) ListByServiceComplete

ListByServiceComplete retrieves all of the results into a single object

func (ApiClient) ListByServiceCompleteMatchingPredicate

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

ListByServiceCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ApiClient) Update

func (c ApiClient) Update(ctx context.Context, id ApiId, input ApiUpdateContract, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

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

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 ApiContractUpdateProperties

type ApiContractUpdateProperties 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"`
	DisplayName                   *string                                `json:"displayName,omitempty"`
	IsCurrent                     *bool                                  `json:"isCurrent,omitempty"`
	IsOnline                      *bool                                  `json:"isOnline,omitempty"`
	License                       *ApiLicenseInformation                 `json:"license,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 ApiCreateOrUpdateParameter

type ApiCreateOrUpdateParameter struct {
	Properties *ApiCreateOrUpdateProperties `json:"properties,omitempty"`
}

type ApiCreateOrUpdateProperties

type ApiCreateOrUpdateProperties struct {
	ApiRevision                   *string                                  `json:"apiRevision,omitempty"`
	ApiRevisionDescription        *string                                  `json:"apiRevisionDescription,omitempty"`
	ApiType                       *SoapApiType                             `json:"apiType,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"`
	Format                        *ContentFormat                           `json:"format,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"`
	Value                         *string                                  `json:"value,omitempty"`
	WsdlSelector                  *ApiCreateOrUpdatePropertiesWsdlSelector `json:"wsdlSelector,omitempty"`
}

type ApiCreateOrUpdatePropertiesWsdlSelector

type ApiCreateOrUpdatePropertiesWsdlSelector struct {
	WsdlEndpointName *string `json:"wsdlEndpointName,omitempty"`
	WsdlServiceName  *string `json:"wsdlServiceName,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 ApiUpdateContract

type ApiUpdateContract struct {
	Properties *ApiContractUpdateProperties `json:"properties,omitempty"`
}

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 AuthenticationSettingsContract

type AuthenticationSettingsContract struct {
	OAuth2 *OAuth2AuthenticationSettingsContract `json:"oAuth2,omitempty"`
	Openid *OpenIdAuthenticationSettingsContract `json:"openid,omitempty"`
}

type BearerTokenSendingMethods

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

type ContentFormat

type ContentFormat string
const (
	ContentFormatGraphqlNegativelink             ContentFormat = "graphql-link"
	ContentFormatOpenapi                         ContentFormat = "openapi"
	ContentFormatOpenapiNegativelink             ContentFormat = "openapi-link"
	ContentFormatOpenapiPositivejson             ContentFormat = "openapi+json"
	ContentFormatOpenapiPositivejsonNegativelink ContentFormat = "openapi+json-link"
	ContentFormatSwaggerNegativejson             ContentFormat = "swagger-json"
	ContentFormatSwaggerNegativelinkNegativejson ContentFormat = "swagger-link-json"
	ContentFormatWadlNegativelinkNegativejson    ContentFormat = "wadl-link-json"
	ContentFormatWadlNegativexml                 ContentFormat = "wadl-xml"
	ContentFormatWsdl                            ContentFormat = "wsdl"
	ContentFormatWsdlNegativelink                ContentFormat = "wsdl-link"
)

type CreateOrUpdateOperationOptions

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationOptions

type DeleteOperationOptions struct {
	DeleteRevisions *bool
	IfMatch         *string
}

func DefaultDeleteOperationOptions

func DefaultDeleteOperationOptions() DeleteOperationOptions

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetEntityTagOperationResponse

type GetEntityTagOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse

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

type ListByServiceCompleteResult

type ListByServiceCompleteResult struct {
	Items []ApiContract
}

type ListByServiceOperationOptions

type ListByServiceOperationOptions struct {
	ExpandApiVersionSet *bool
	Filter              *string
	Skip                *int64
	Tags                *string
	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 (ListByServiceOperationResponse) LoadMore

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

type SoapApiType string
const (
	SoapApiTypeGraphql   SoapApiType = "graphql"
	SoapApiTypeHTTP      SoapApiType = "http"
	SoapApiTypeSoap      SoapApiType = "soap"
	SoapApiTypeWebsocket SoapApiType = "websocket"
)

type SubscriptionKeyParameterNamesContract

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

type UpdateOperationOptions

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions

func DefaultUpdateOperationOptions() UpdateOperationOptions

type UpdateOperationResponse

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

type VersioningScheme

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

Jump to

Keyboard shortcuts

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