apiversionset

package
v0.20240409.1113035 Latest Latest
Warning

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

Go to latest
Published: Apr 9, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

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

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

Example Usage: ApiVersionSetClient.WorkspaceApiVersionSetCreateOrUpdate

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

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


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

Example Usage: ApiVersionSetClient.WorkspaceApiVersionSetGet

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

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

Example Usage: ApiVersionSetClient.WorkspaceApiVersionSetGetEntityTag

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

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

Example Usage: ApiVersionSetClient.WorkspaceApiVersionSetListByService

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

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

Example Usage: ApiVersionSetClient.WorkspaceApiVersionSetUpdate

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

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


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

func ValidateWorkspaceApiVersionSetID

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

ValidateWorkspaceApiVersionSetID checks that 'input' can be parsed as a Workspace Api Version Set ID

func ValidateWorkspaceID

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type ApiVersionSetClient

type ApiVersionSetClient struct {
	Client *resourcemanager.Client
}

func NewApiVersionSetClientWithBaseURI

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

func (ApiVersionSetClient) CreateOrUpdate

CreateOrUpdate ...

func (ApiVersionSetClient) Get

Get ...

func (ApiVersionSetClient) GetEntityTag

GetEntityTag ...

func (ApiVersionSetClient) ListByService

ListByService ...

func (ApiVersionSetClient) ListByServiceComplete

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

Update ...

func (ApiVersionSetClient) WorkspaceApiVersionSetCreateOrUpdate

WorkspaceApiVersionSetCreateOrUpdate ...

func (ApiVersionSetClient) WorkspaceApiVersionSetGet

WorkspaceApiVersionSetGet ...

func (ApiVersionSetClient) WorkspaceApiVersionSetGetEntityTag

WorkspaceApiVersionSetGetEntityTag ...

func (ApiVersionSetClient) WorkspaceApiVersionSetListByService

WorkspaceApiVersionSetListByService ...

func (ApiVersionSetClient) WorkspaceApiVersionSetListByServiceComplete

WorkspaceApiVersionSetListByServiceComplete retrieves all the results into a single object

func (ApiVersionSetClient) WorkspaceApiVersionSetListByServiceCompleteMatchingPredicate

WorkspaceApiVersionSetListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApiVersionSetClient) WorkspaceApiVersionSetUpdate

WorkspaceApiVersionSetUpdate ...

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

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

func (id *ApiVersionSetId) FromParseResult(input resourceids.ParseResult) error

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

func (CreateOrUpdateOperationOptions) ToOData

func (CreateOrUpdateOperationOptions) ToQuery

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 {
	LatestHttpResponse *http.Response
	Items              []ApiVersionSetContract
}

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        *[]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) FromParseResult

func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error

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

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

func (UpdateOperationOptions) ToOData

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

func (UpdateOperationOptions) ToQuery

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

func (s *VersioningScheme) UnmarshalJSON(bytes []byte) error

type WorkspaceApiVersionSetCreateOrUpdateOperationOptions

type WorkspaceApiVersionSetCreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultWorkspaceApiVersionSetCreateOrUpdateOperationOptions

func DefaultWorkspaceApiVersionSetCreateOrUpdateOperationOptions() WorkspaceApiVersionSetCreateOrUpdateOperationOptions

func (WorkspaceApiVersionSetCreateOrUpdateOperationOptions) ToHeaders

func (WorkspaceApiVersionSetCreateOrUpdateOperationOptions) ToOData

func (WorkspaceApiVersionSetCreateOrUpdateOperationOptions) ToQuery

type WorkspaceApiVersionSetCreateOrUpdateOperationResponse

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

type WorkspaceApiVersionSetGetEntityTagOperationResponse

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

type WorkspaceApiVersionSetGetOperationResponse

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

type WorkspaceApiVersionSetId

type WorkspaceApiVersionSetId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
	VersionSetId      string
}

WorkspaceApiVersionSetId is a struct representing the Resource ID for a Workspace Api Version Set

func NewWorkspaceApiVersionSetID

func NewWorkspaceApiVersionSetID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string, versionSetId string) WorkspaceApiVersionSetId

NewWorkspaceApiVersionSetID returns a new WorkspaceApiVersionSetId struct

func ParseWorkspaceApiVersionSetID

func ParseWorkspaceApiVersionSetID(input string) (*WorkspaceApiVersionSetId, error)

ParseWorkspaceApiVersionSetID parses 'input' into a WorkspaceApiVersionSetId

func ParseWorkspaceApiVersionSetIDInsensitively

func ParseWorkspaceApiVersionSetIDInsensitively(input string) (*WorkspaceApiVersionSetId, error)

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

func (*WorkspaceApiVersionSetId) FromParseResult

func (id *WorkspaceApiVersionSetId) FromParseResult(input resourceids.ParseResult) error

func (WorkspaceApiVersionSetId) ID

ID returns the formatted Workspace Api Version Set ID

func (WorkspaceApiVersionSetId) Segments

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

func (WorkspaceApiVersionSetId) String

func (id WorkspaceApiVersionSetId) String() string

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

type WorkspaceApiVersionSetListByServiceCompleteResult

type WorkspaceApiVersionSetListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApiVersionSetContract
}

type WorkspaceApiVersionSetListByServiceOperationOptions

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

func DefaultWorkspaceApiVersionSetListByServiceOperationOptions

func DefaultWorkspaceApiVersionSetListByServiceOperationOptions() WorkspaceApiVersionSetListByServiceOperationOptions

func (WorkspaceApiVersionSetListByServiceOperationOptions) ToHeaders

func (WorkspaceApiVersionSetListByServiceOperationOptions) ToOData

func (WorkspaceApiVersionSetListByServiceOperationOptions) ToQuery

type WorkspaceApiVersionSetListByServiceOperationResponse

type WorkspaceApiVersionSetListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiVersionSetContract
}

type WorkspaceApiVersionSetUpdateOperationOptions

type WorkspaceApiVersionSetUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultWorkspaceApiVersionSetUpdateOperationOptions

func DefaultWorkspaceApiVersionSetUpdateOperationOptions() WorkspaceApiVersionSetUpdateOperationOptions

func (WorkspaceApiVersionSetUpdateOperationOptions) ToHeaders

func (WorkspaceApiVersionSetUpdateOperationOptions) ToOData

func (WorkspaceApiVersionSetUpdateOperationOptions) ToQuery

type WorkspaceApiVersionSetUpdateOperationResponse

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

type WorkspaceId

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

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID

func NewWorkspaceID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (*WorkspaceId) FromParseResult

func (id *WorkspaceId) FromParseResult(input resourceids.ParseResult) error

func (WorkspaceId) ID

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments

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

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

func (WorkspaceId) String

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

Jump to

Keyboard shortcuts

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