apiversionset

package
v0.20230901.1170029 Latest Latest
Warning

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

 Go to latest Published: Sep 1, 2023 License: MPL-2.0 Imports: 10 Imported by: 0

README

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

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

Client Initialization

client := apiversionset.NewApiVersionSetClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiVersionSetClient.CreateOrUpdate

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

payload := apiversionset.ApiVersionSetContract{
	// ...
}


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

Example Usage: ApiVersionSetClient.Get

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

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

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

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

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

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

Example Usage: ApiVersionSetClient.Update

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

payload := apiversionset.ApiVersionSetUpdateParameters{
	// ...
}


read, err := client.Update(ctx, id, payload, apiversionset.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 PossibleValuesForVersioningScheme 

func PossibleValuesForVersioningScheme() []string

func ValidateApiVersionSetID 

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

ValidateApiVersionSetID checks that 'input' can be parsed as a Api Version Set 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 ApiVersionSetClient 

type ApiVersionSetClient struct {
	Client *resourcemanager.Client
}

func NewApiVersionSetClientWithBaseURI 

func NewApiVersionSetClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiVersionSetClient, error)

func (ApiVersionSetClient) CreateOrUpdate 

func (c ApiVersionSetClient) CreateOrUpdate(ctx context.Context, id ApiVersionSetId, input ApiVersionSetContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ApiVersionSetClient) Get 

func (c ApiVersionSetClient) Get(ctx context.Context, id ApiVersionSetId) (result GetOperationResponse, err error)

Get ...

func (ApiVersionSetClient) GetEntityTag 

func (c ApiVersionSetClient) GetEntityTag(ctx context.Context, id ApiVersionSetId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (ApiVersionSetClient) ListByService 

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

ListByService ...

func (ApiVersionSetClient) ListByServiceComplete 

func (c ApiVersionSetClient) ListByServiceComplete(ctx context.Context, id ServiceId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (ApiVersionSetClient) ListByServiceCompleteMatchingPredicate 

func (c ApiVersionSetClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, options ListByServiceOperationOptions, predicate ApiVersionSetContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApiVersionSetClient) Update 

func (c ApiVersionSetClient) Update(ctx context.Context, id ApiVersionSetId, input ApiVersionSetUpdateParameters, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

type ApiVersionSetContract 

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

type ApiVersionSetContractOperationPredicate 

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

func (ApiVersionSetContractOperationPredicate) Matches 

func (p ApiVersionSetContractOperationPredicate) Matches(input ApiVersionSetContract) bool

type ApiVersionSetContractProperties 

type ApiVersionSetContractProperties struct {
	Description       *string          `json:"description,omitempty"`
	DisplayName       string           `json:"displayName"`
	VersionHeaderName *string          `json:"versionHeaderName,omitempty"`
	VersionQueryName  *string          `json:"versionQueryName,omitempty"`
	VersioningScheme  VersioningScheme `json:"versioningScheme"`
}

type ApiVersionSetId 

type ApiVersionSetId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	VersionSetId      string
}

ApiVersionSetId is a struct representing the Resource ID for a Api Version Set

func NewApiVersionSetID 

func NewApiVersionSetID(subscriptionId string, resourceGroupName string, serviceName string, versionSetId string) ApiVersionSetId

NewApiVersionSetID returns a new ApiVersionSetId struct

func ParseApiVersionSetID 

func ParseApiVersionSetID(input string) (*ApiVersionSetId, error)

ParseApiVersionSetID parses 'input' into a ApiVersionSetId

func ParseApiVersionSetIDInsensitively 

func ParseApiVersionSetIDInsensitively(input string) (*ApiVersionSetId, error)

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

func (ApiVersionSetId) ID 

func (id ApiVersionSetId) ID() string

ID returns the formatted Api Version Set ID

func (ApiVersionSetId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Api Version Set ID

func (ApiVersionSetId) String 

func (id ApiVersionSetId) String() string

String returns a human-readable description of this Api Version Set ID

type ApiVersionSetUpdateParameters 

type ApiVersionSetUpdateParameters struct {
	Properties *ApiVersionSetUpdateParametersProperties `json:"properties,omitempty"`
}

type ApiVersionSetUpdateParametersProperties 

type ApiVersionSetUpdateParametersProperties struct {
	Description       *string           `json:"description,omitempty"`
	DisplayName       *string           `json:"displayName,omitempty"`
	VersionHeaderName *string           `json:"versionHeaderName,omitempty"`
	VersionQueryName  *string           `json:"versionQueryName,omitempty"`
	VersioningScheme  *VersioningScheme `json:"versioningScheme,omitempty"`
}

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 CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiVersionSetContract
}

type GetEntityTagOperationResponse 

type GetEntityTagOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiVersionSetContract
}

type ListByServiceCompleteResult 

type ListByServiceCompleteResult struct {
	Items []ApiVersionSetContract
}

type ListByServiceOperationOptions 

type ListByServiceOperationOptions struct {
	Filter *string
	Skip   *int64
	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        *[]ApiVersionSetContract
}

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 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        *ApiVersionSetContract
}

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

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.