README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/api
Documentation
The api
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/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 ¶
- func PossibleValuesForApiType() []string
- func PossibleValuesForBearerTokenSendingMethods() []string
- func PossibleValuesForContentFormat() []string
- func PossibleValuesForProtocol() []string
- func PossibleValuesForSoapApiType() []string
- func PossibleValuesForTranslateRequiredQueryParametersConduct() []string
- func PossibleValuesForVersioningScheme() []string
- func ValidateApiID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
- type ApiClient
- func (c ApiClient) CreateOrUpdate(ctx context.Context, id ApiId, input ApiCreateOrUpdateParameter, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c ApiClient) CreateOrUpdateThenPoll(ctx context.Context, id ApiId, input ApiCreateOrUpdateParameter, ...) error
- func (c ApiClient) Delete(ctx context.Context, id ApiId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
- func (c ApiClient) Get(ctx context.Context, id ApiId) (result GetOperationResponse, err error)
- func (c ApiClient) GetEntityTag(ctx context.Context, id ApiId) (result GetEntityTagOperationResponse, err error)
- func (c ApiClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
- func (c ApiClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
- func (c ApiClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, ...) (result ListByServiceCompleteResult, err error)
- func (c ApiClient) Update(ctx context.Context, id ApiId, input ApiUpdateContract, ...) (result UpdateOperationResponse, err error)
- type ApiContactInformation
- type ApiContract
- type ApiContractOperationPredicate
- type ApiContractProperties
- type ApiContractUpdateProperties
- type ApiCreateOrUpdateParameter
- type ApiCreateOrUpdateProperties
- type ApiCreateOrUpdatePropertiesWsdlSelector
- type ApiId
- type ApiLicenseInformation
- type ApiType
- type ApiUpdateContract
- type ApiVersionSetContractDetails
- type AuthenticationSettingsContract
- type BearerTokenSendingMethods
- type ContentFormat
- type CreateOrUpdateOperationOptions
- type CreateOrUpdateOperationResponse
- type DeleteOperationOptions
- type DeleteOperationResponse
- type GetEntityTagOperationResponse
- type GetOperationResponse
- type ListByServiceCompleteResult
- type ListByServiceOperationOptions
- type ListByServiceOperationResponse
- type OAuth2AuthenticationSettingsContract
- type OpenIdAuthenticationSettingsContract
- type Protocol
- type ServiceId
- type SoapApiType
- type SubscriptionKeyParameterNamesContract
- type TranslateRequiredQueryParametersConduct
- type UpdateOperationOptions
- type UpdateOperationResponse
- type VersioningScheme
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 PossibleValuesForTranslateRequiredQueryParametersConduct ¶
func PossibleValuesForTranslateRequiredQueryParametersConduct() []string
func PossibleValuesForVersioningScheme ¶
func PossibleValuesForVersioningScheme() []string
func ValidateApiID ¶
ValidateApiID checks that 'input' can be parsed as a Api ID
func ValidateServiceID ¶
ValidateServiceID checks that 'input' can be parsed as a Service ID
Types ¶
type ApiClient ¶
type ApiClient struct {
Client *resourcemanager.Client
}
func (ApiClient) CreateOrUpdate ¶
func (c ApiClient) CreateOrUpdate(ctx context.Context, id ApiId, input ApiCreateOrUpdateParameter, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)
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) GetEntityTag ¶
func (c ApiClient) GetEntityTag(ctx context.Context, id ApiId) (result GetEntityTagOperationResponse, err error)
GetEntityTag ...
func (ApiClient) ListByService ¶
func (c ApiClient) ListByService(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
ListByService ...
func (ApiClient) ListByServiceComplete ¶
func (c ApiClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
ListByServiceComplete retrieves all the results into a single object
func (ApiClient) ListByServiceCompleteMatchingPredicate ¶
func (c ApiClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, predicate ApiContractOperationPredicate) (result ListByServiceCompleteResult, err error)
ListByServiceCompleteMatchingPredicate retrieves all the results and then applies 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 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 ¶
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 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"` TranslateRequiredQueryParameters *TranslateRequiredQueryParametersConduct `json:"translateRequiredQueryParameters,omitempty"` Type *ApiType `json:"type,omitempty"` Value *string `json:"value,omitempty"` WsdlSelector *ApiCreateOrUpdatePropertiesWsdlSelector `json:"wsdlSelector,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 ¶
ParseApiID parses 'input' into a ApiId
func ParseApiIDInsensitively ¶
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) Segments ¶
func (id ApiId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Api ID
type ApiLicenseInformation ¶
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"` 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 ¶ added in v0.20230801.1071415
func (s *BearerTokenSendingMethods) UnmarshalJSON(bytes []byte) error
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" )
func (*ContentFormat) UnmarshalJSON ¶ added in v0.20230801.1071415
func (s *ContentFormat) UnmarshalJSON(bytes []byte) error
type CreateOrUpdateOperationOptions ¶
type CreateOrUpdateOperationOptions struct {
IfMatch *string
}
func DefaultCreateOrUpdateOperationOptions ¶
func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions
func (CreateOrUpdateOperationOptions) ToHeaders ¶ added in v0.20230801.1071415
func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers
func (CreateOrUpdateOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query
func (CreateOrUpdateOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams
type DeleteOperationOptions ¶
func DefaultDeleteOperationOptions ¶
func DefaultDeleteOperationOptions() DeleteOperationOptions
func (DeleteOperationOptions) ToHeaders ¶ added in v0.20230801.1071415
func (o DeleteOperationOptions) ToHeaders() *client.Headers
func (DeleteOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o DeleteOperationOptions) ToOData() *odata.Query
func (DeleteOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o DeleteOperationOptions) ToQuery() *client.QueryParams
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData 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
func (ListByServiceOperationOptions) ToHeaders ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToHeaders() *client.Headers
func (ListByServiceOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToOData() *odata.Query
func (ListByServiceOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams
type ListByServiceOperationResponse ¶
type ListByServiceOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]ApiContract }
type OpenIdAuthenticationSettingsContract ¶
type OpenIdAuthenticationSettingsContract struct { BearerTokenSendingMethods *[]BearerTokenSendingMethods `json:"bearerTokenSendingMethods,omitempty"` OpenidProviderId *string `json:"openidProviderId,omitempty"` }
type ServiceId ¶
ServiceId is a struct representing the Resource ID for a Service
func NewServiceID ¶
NewServiceID returns a new ServiceId struct
func ParseServiceID ¶
ParseServiceID parses 'input' into a ServiceId
func ParseServiceIDInsensitively ¶
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) Segments ¶
func (id ServiceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Service ID
type SoapApiType ¶
type SoapApiType string
const ( SoapApiTypeGraphql SoapApiType = "graphql" SoapApiTypeHTTP SoapApiType = "http" SoapApiTypeSoap SoapApiType = "soap" SoapApiTypeWebsocket SoapApiType = "websocket" )
func (*SoapApiType) UnmarshalJSON ¶ added in v0.20230801.1071415
func (s *SoapApiType) UnmarshalJSON(bytes []byte) error
type TranslateRequiredQueryParametersConduct ¶
type TranslateRequiredQueryParametersConduct string
const ( TranslateRequiredQueryParametersConductQuery TranslateRequiredQueryParametersConduct = "query" TranslateRequiredQueryParametersConductTemplate TranslateRequiredQueryParametersConduct = "template" )
func (*TranslateRequiredQueryParametersConduct) UnmarshalJSON ¶ added in v0.20230801.1071415
func (s *TranslateRequiredQueryParametersConduct) UnmarshalJSON(bytes []byte) error
type UpdateOperationOptions ¶
type UpdateOperationOptions struct {
IfMatch *string
}
func DefaultUpdateOperationOptions ¶
func DefaultUpdateOperationOptions() UpdateOperationOptions
func (UpdateOperationOptions) ToHeaders ¶ added in v0.20230801.1071415
func (o UpdateOperationOptions) ToHeaders() *client.Headers
func (UpdateOperationOptions) ToOData ¶ added in v0.20230801.1071415
func (o UpdateOperationOptions) ToOData() *odata.Query
func (UpdateOperationOptions) ToQuery ¶ added in v0.20230801.1071415
func (o UpdateOperationOptions) ToQuery() *client.QueryParams
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *ApiContract }
type VersioningScheme ¶
type VersioningScheme string
const ( VersioningSchemeHeader VersioningScheme = "Header" VersioningSchemeQuery VersioningScheme = "Query" VersioningSchemeSegment VersioningScheme = "Segment" )
func (*VersioningScheme) UnmarshalJSON ¶ added in v0.20230801.1071415
func (s *VersioningScheme) UnmarshalJSON(bytes []byte) error
Source Files ¶
- client.go
- constants.go
- id_api.go
- id_service.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_getentitytag.go
- method_listbyservice.go
- method_update.go
- model_apicontactinformation.go
- model_apicontract.go
- model_apicontractproperties.go
- model_apicontractupdateproperties.go
- model_apicreateorupdateparameter.go
- model_apicreateorupdateproperties.go
- model_apicreateorupdatepropertieswsdlselector.go
- model_apilicenseinformation.go
- model_apiupdatecontract.go
- model_apiversionsetcontractdetails.go
- model_authenticationsettingscontract.go
- model_oauth2authenticationsettingscontract.go
- model_openidauthenticationsettingscontract.go
- model_subscriptionkeyparameternamescontract.go
- predicates.go
- version.go