apirevision

README

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

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

Client Initialization

client := apirevision.NewApiRevisionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiRevisionClient.ListByService

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

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

Documentation

Index

• func ValidateApiID(input interface{}, key string) (warnings []string, errors []error)
• type ApiId
  • func NewApiID(subscriptionId string, resourceGroupName string, serviceName string, ...) ApiId
  • func ParseApiID(input string) (*ApiId, error)
  • func ParseApiIDInsensitively(input string) (*ApiId, error)
  • func (id *ApiId) FromParseResult(input resourceids.ParseResult) error
  • func (id ApiId) ID() string
  • func (id ApiId) Segments() []resourceids.Segment
  • func (id ApiId) String() string
• type ApiRevisionClient
  • func NewApiRevisionClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiRevisionClient, error)
  • func (c ApiRevisionClient) ListByService(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)
  • func (c ApiRevisionClient) ListByServiceComplete(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)
  • func (c ApiRevisionClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ApiId, options ListByServiceOperationOptions, ...) (result ListByServiceCompleteResult, err error)
• type ApiRevisionContract
  • func (o *ApiRevisionContract) GetCreatedDateTimeAsTime() (*time.Time, error)
  • func (o *ApiRevisionContract) GetUpdatedDateTimeAsTime() (*time.Time, error)
  • func (o *ApiRevisionContract) SetCreatedDateTimeAsTime(input time.Time)
  • func (o *ApiRevisionContract) SetUpdatedDateTimeAsTime(input time.Time)
• type ApiRevisionContractOperationPredicate
  • func (p ApiRevisionContractOperationPredicate) Matches(input ApiRevisionContract) bool
• type ListByServiceCompleteResult
• type ListByServiceCustomPager
  • func (p *ListByServiceCustomPager) NextPageLink() *odata.Link
• type ListByServiceOperationOptions
  • func DefaultListByServiceOperationOptions() ListByServiceOperationOptions
  • func (o ListByServiceOperationOptions) ToHeaders() *client.Headers
  • func (o ListByServiceOperationOptions) ToOData() *odata.Query
  • func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams
• type ListByServiceOperationResponse

Functions

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

type ApiRevisionClient struct {
	Client *resourcemanager.Client
}

func NewApiRevisionClientWithBaseURI

func NewApiRevisionClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiRevisionClient, error)

func (ApiRevisionClient) ListByService

func (c ApiRevisionClient) ListByService(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)

ListByService ...

func (ApiRevisionClient) ListByServiceComplete

func (c ApiRevisionClient) ListByServiceComplete(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (ApiRevisionClient) ListByServiceCompleteMatchingPredicate

func (c ApiRevisionClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ApiId, options ListByServiceOperationOptions, predicate ApiRevisionContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ApiRevisionContract

type ApiRevisionContract struct {
	ApiId           *string `json:"apiId,omitempty"`
	ApiRevision     *string `json:"apiRevision,omitempty"`
	CreatedDateTime *string `json:"createdDateTime,omitempty"`
	Description     *string `json:"description,omitempty"`
	IsCurrent       *bool   `json:"isCurrent,omitempty"`
	IsOnline        *bool   `json:"isOnline,omitempty"`
	PrivateUrl      *string `json:"privateUrl,omitempty"`
	UpdatedDateTime *string `json:"updatedDateTime,omitempty"`
}

func (*ApiRevisionContract) GetCreatedDateTimeAsTime

func (o *ApiRevisionContract) GetCreatedDateTimeAsTime() (*time.Time, error)

func (*ApiRevisionContract) GetUpdatedDateTimeAsTime

func (o *ApiRevisionContract) GetUpdatedDateTimeAsTime() (*time.Time, error)

func (*ApiRevisionContract) SetCreatedDateTimeAsTime

func (o *ApiRevisionContract) SetCreatedDateTimeAsTime(input time.Time)

func (*ApiRevisionContract) SetUpdatedDateTimeAsTime

func (o *ApiRevisionContract) SetUpdatedDateTimeAsTime(input time.Time)

type ApiRevisionContractOperationPredicate

type ApiRevisionContractOperationPredicate struct {
	ApiId           *string
	ApiRevision     *string
	CreatedDateTime *string
	Description     *string
	IsCurrent       *bool
	IsOnline        *bool
	PrivateUrl      *string
	UpdatedDateTime *string
}

func (ApiRevisionContractOperationPredicate) Matches

func (p ApiRevisionContractOperationPredicate) Matches(input ApiRevisionContract) bool

type ListByServiceCompleteResult

type ListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApiRevisionContract
}

type ListByServiceCustomPager

type ListByServiceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByServiceCustomPager) NextPageLink

func (p *ListByServiceCustomPager) NextPageLink() *odata.Link

type ListByServiceOperationOptions

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

func DefaultListByServiceOperationOptions

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

func (ListByServiceOperationOptions) ToHeaders

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

func (ListByServiceOperationOptions) ToOData

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

func (ListByServiceOperationOptions) ToQuery

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

type ListByServiceOperationResponse

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiRevisionContract
}