apirevision

package
v0.20231012.1141427 Latest Latest
Warning

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

Go to latest
Published: Oct 12, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

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

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

Example Usage: ApiRevisionClient.WorkspaceApiRevisionListByService

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

// alternatively `client.WorkspaceApiRevisionListByService(ctx, id, apirevision.DefaultWorkspaceApiRevisionListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.WorkspaceApiRevisionListByServiceComplete(ctx, id, apirevision.DefaultWorkspaceApiRevisionListByServiceOperationOptions())
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 ValidateApiID

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

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

func ValidateWorkspaceApiID

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

ValidateWorkspaceApiID checks that 'input' can be parsed as a Workspace 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) 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

ListByService ...

func (ApiRevisionClient) ListByServiceComplete

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

func (ApiRevisionClient) WorkspaceApiRevisionListByService

WorkspaceApiRevisionListByService ...

func (ApiRevisionClient) WorkspaceApiRevisionListByServiceComplete

WorkspaceApiRevisionListByServiceComplete retrieves all the results into a single object

func (ApiRevisionClient) WorkspaceApiRevisionListByServiceCompleteMatchingPredicate

WorkspaceApiRevisionListByServiceCompleteMatchingPredicate 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

type ListByServiceCompleteResult

type ListByServiceCompleteResult struct {
	Items []ApiRevisionContract
}

type ListByServiceOperationOptions

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

func DefaultListByServiceOperationOptions

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

func (ListByServiceOperationOptions) ToHeaders

func (ListByServiceOperationOptions) ToOData

func (ListByServiceOperationOptions) ToQuery

type ListByServiceOperationResponse

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

type WorkspaceApiId

type WorkspaceApiId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
	ApiId             string
}

WorkspaceApiId is a struct representing the Resource ID for a Workspace Api

func NewWorkspaceApiID

func NewWorkspaceApiID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string, apiId string) WorkspaceApiId

NewWorkspaceApiID returns a new WorkspaceApiId struct

func ParseWorkspaceApiID

func ParseWorkspaceApiID(input string) (*WorkspaceApiId, error)

ParseWorkspaceApiID parses 'input' into a WorkspaceApiId

func ParseWorkspaceApiIDInsensitively

func ParseWorkspaceApiIDInsensitively(input string) (*WorkspaceApiId, error)

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

func (WorkspaceApiId) ID

func (id WorkspaceApiId) ID() string

ID returns the formatted Workspace Api ID

func (WorkspaceApiId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Workspace Api ID

func (WorkspaceApiId) String

func (id WorkspaceApiId) String() string

String returns a human-readable description of this Workspace Api ID

type WorkspaceApiRevisionListByServiceCompleteResult

type WorkspaceApiRevisionListByServiceCompleteResult struct {
	Items []ApiRevisionContract
}

type WorkspaceApiRevisionListByServiceOperationOptions

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

func DefaultWorkspaceApiRevisionListByServiceOperationOptions

func DefaultWorkspaceApiRevisionListByServiceOperationOptions() WorkspaceApiRevisionListByServiceOperationOptions

func (WorkspaceApiRevisionListByServiceOperationOptions) ToHeaders

func (WorkspaceApiRevisionListByServiceOperationOptions) ToOData

func (WorkspaceApiRevisionListByServiceOperationOptions) ToQuery

type WorkspaceApiRevisionListByServiceOperationResponse

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

Jump to

Keyboard shortcuts

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