clusterversion

package
v0.20241203.1090052 Latest Latest
Warning

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

 Go to latest Published: Dec 3, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicefabric/2021-06-01/clusterversion Documentation

The clusterversion SDK allows for interaction with Azure Resource Manager servicefabric (API Version 2021-06-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/servicefabric/2021-06-01/clusterversion"

Client Initialization

client := clusterversion.NewClusterVersionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ClusterVersionClient.Get

ctx := context.TODO()
id := clusterversion.NewClusterVersionID("12345678-1234-9876-4563-123456789012", "locationName", "clusterVersionName")

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

Example Usage: ClusterVersionClient.GetByEnvironment

ctx := context.TODO()
id := clusterversion.NewEnvironmentClusterVersionID("12345678-1234-9876-4563-123456789012", "locationName", "Linux", "clusterVersionName")

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

Example Usage: ClusterVersionClient.List

ctx := context.TODO()
id := clusterversion.NewLocationID("12345678-1234-9876-4563-123456789012", "locationName")

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

Example Usage: ClusterVersionClient.ListByEnvironment

ctx := context.TODO()
id := clusterversion.NewEnvironmentID("12345678-1234-9876-4563-123456789012", "locationName", "Linux")

// alternatively `client.ListByEnvironment(ctx, id)` can be used to do batched pagination
items, err := client.ListByEnvironmentComplete(ctx, id)
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 PossibleValuesForClusterVersionsEnvironment 

func PossibleValuesForClusterVersionsEnvironment() []string

func PossibleValuesForEnvironment 

func PossibleValuesForEnvironment() []string

func ValidateClusterVersionID 

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

ValidateClusterVersionID checks that 'input' can be parsed as a Cluster Version ID

func ValidateEnvironmentClusterVersionID 

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

ValidateEnvironmentClusterVersionID checks that 'input' can be parsed as a Environment Cluster Version ID

func ValidateEnvironmentID 

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

ValidateEnvironmentID checks that 'input' can be parsed as a Environment ID

func ValidateLocationID 

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type ClusterCodeVersionsResult 

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

type ClusterCodeVersionsResultOperationPredicate added in v0.20240226.1173038 

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

func (ClusterCodeVersionsResultOperationPredicate) Matches added in v0.20240226.1173038 

func (p ClusterCodeVersionsResultOperationPredicate) Matches(input ClusterCodeVersionsResult) bool

type ClusterVersionClient 

type ClusterVersionClient struct {
	Client *resourcemanager.Client
}

func NewClusterVersionClientWithBaseURI 

func NewClusterVersionClientWithBaseURI(sdkApi sdkEnv.Api) (*ClusterVersionClient, error)

func (ClusterVersionClient) Get 

func (c ClusterVersionClient) Get(ctx context.Context, id ClusterVersionId) (result GetOperationResponse, err error)

Get ...

func (ClusterVersionClient) GetByEnvironment 

func (c ClusterVersionClient) GetByEnvironment(ctx context.Context, id EnvironmentClusterVersionId) (result GetByEnvironmentOperationResponse, err error)

GetByEnvironment ...

func (ClusterVersionClient) GetByEnvironmentComplete added in v0.20240226.1173038 

func (c ClusterVersionClient) GetByEnvironmentComplete(ctx context.Context, id EnvironmentClusterVersionId) (GetByEnvironmentCompleteResult, error)

GetByEnvironmentComplete retrieves all the results into a single object

func (ClusterVersionClient) GetByEnvironmentCompleteMatchingPredicate added in v0.20240226.1173038 

func (c ClusterVersionClient) GetByEnvironmentCompleteMatchingPredicate(ctx context.Context, id EnvironmentClusterVersionId, predicate ClusterCodeVersionsResultOperationPredicate) (result GetByEnvironmentCompleteResult, err error)

GetByEnvironmentCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ClusterVersionClient) GetComplete added in v0.20240226.1173038 

func (c ClusterVersionClient) GetComplete(ctx context.Context, id ClusterVersionId) (GetCompleteResult, error)

GetComplete retrieves all the results into a single object

func (ClusterVersionClient) GetCompleteMatchingPredicate added in v0.20240226.1173038 

func (c ClusterVersionClient) GetCompleteMatchingPredicate(ctx context.Context, id ClusterVersionId, predicate ClusterCodeVersionsResultOperationPredicate) (result GetCompleteResult, err error)

GetCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ClusterVersionClient) List 

func (c ClusterVersionClient) List(ctx context.Context, id LocationId) (result ListOperationResponse, err error)

List ...

func (ClusterVersionClient) ListByEnvironment 

func (c ClusterVersionClient) ListByEnvironment(ctx context.Context, id EnvironmentId) (result ListByEnvironmentOperationResponse, err error)

ListByEnvironment ...

func (ClusterVersionClient) ListByEnvironmentComplete added in v0.20240226.1173038 

func (c ClusterVersionClient) ListByEnvironmentComplete(ctx context.Context, id EnvironmentId) (ListByEnvironmentCompleteResult, error)

ListByEnvironmentComplete retrieves all the results into a single object

func (ClusterVersionClient) ListByEnvironmentCompleteMatchingPredicate added in v0.20240226.1173038 

func (c ClusterVersionClient) ListByEnvironmentCompleteMatchingPredicate(ctx context.Context, id EnvironmentId, predicate ClusterCodeVersionsResultOperationPredicate) (result ListByEnvironmentCompleteResult, err error)

ListByEnvironmentCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ClusterVersionClient) ListComplete added in v0.20240226.1173038 

func (c ClusterVersionClient) ListComplete(ctx context.Context, id LocationId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ClusterVersionClient) ListCompleteMatchingPredicate added in v0.20240226.1173038 

func (c ClusterVersionClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate ClusterCodeVersionsResultOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ClusterVersionDetails 

type ClusterVersionDetails struct {
	CodeVersion      *string      `json:"codeVersion,omitempty"`
	Environment      *Environment `json:"environment,omitempty"`
	SupportExpiryUtc *string      `json:"supportExpiryUtc,omitempty"`
}

type ClusterVersionId 

type ClusterVersionId struct {
	SubscriptionId     string
	LocationName       string
	ClusterVersionName string
}

ClusterVersionId is a struct representing the Resource ID for a Cluster Version

func NewClusterVersionID 

func NewClusterVersionID(subscriptionId string, locationName string, clusterVersionName string) ClusterVersionId

NewClusterVersionID returns a new ClusterVersionId struct

func ParseClusterVersionID 

func ParseClusterVersionID(input string) (*ClusterVersionId, error)

ParseClusterVersionID parses 'input' into a ClusterVersionId

func ParseClusterVersionIDInsensitively 

func ParseClusterVersionIDInsensitively(input string) (*ClusterVersionId, error)

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

func (*ClusterVersionId) FromParseResult 

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

func (ClusterVersionId) ID 

func (id ClusterVersionId) ID() string

ID returns the formatted Cluster Version ID

func (ClusterVersionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Cluster Version ID

func (ClusterVersionId) String 

func (id ClusterVersionId) String() string

String returns a human-readable description of this Cluster Version ID

type ClusterVersionsEnvironment 

type ClusterVersionsEnvironment string
const (
	ClusterVersionsEnvironmentLinux   ClusterVersionsEnvironment = "Linux"
	ClusterVersionsEnvironmentWindows ClusterVersionsEnvironment = "Windows"
)

func (*ClusterVersionsEnvironment) UnmarshalJSON added in v0.20240222.1121651 

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

type Environment 

type Environment string
const (
	EnvironmentLinux   Environment = "Linux"
	EnvironmentWindows Environment = "Windows"
)

func (*Environment) UnmarshalJSON added in v0.20240222.1121651 

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

type EnvironmentClusterVersionId 

type EnvironmentClusterVersionId struct {
	SubscriptionId     string
	LocationName       string
	Environment        ClusterVersionsEnvironment
	ClusterVersionName string
}

EnvironmentClusterVersionId is a struct representing the Resource ID for a Environment Cluster Version

func NewEnvironmentClusterVersionID 

func NewEnvironmentClusterVersionID(subscriptionId string, locationName string, environment ClusterVersionsEnvironment, clusterVersionName string) EnvironmentClusterVersionId

NewEnvironmentClusterVersionID returns a new EnvironmentClusterVersionId struct

func ParseEnvironmentClusterVersionID 

func ParseEnvironmentClusterVersionID(input string) (*EnvironmentClusterVersionId, error)

ParseEnvironmentClusterVersionID parses 'input' into a EnvironmentClusterVersionId

func ParseEnvironmentClusterVersionIDInsensitively 

func ParseEnvironmentClusterVersionIDInsensitively(input string) (*EnvironmentClusterVersionId, error)

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

func (*EnvironmentClusterVersionId) FromParseResult 

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

func (EnvironmentClusterVersionId) ID 

func (id EnvironmentClusterVersionId) ID() string

ID returns the formatted Environment Cluster Version ID

func (EnvironmentClusterVersionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Environment Cluster Version ID

func (EnvironmentClusterVersionId) String 

func (id EnvironmentClusterVersionId) String() string

String returns a human-readable description of this Environment Cluster Version ID

type EnvironmentId 

type EnvironmentId struct {
	SubscriptionId string
	LocationName   string
	Environment    ClusterVersionsEnvironment
}

EnvironmentId is a struct representing the Resource ID for a Environment

func NewEnvironmentID 

func NewEnvironmentID(subscriptionId string, locationName string, environment ClusterVersionsEnvironment) EnvironmentId

NewEnvironmentID returns a new EnvironmentId struct

func ParseEnvironmentID 

func ParseEnvironmentID(input string) (*EnvironmentId, error)

ParseEnvironmentID parses 'input' into a EnvironmentId

func ParseEnvironmentIDInsensitively 

func ParseEnvironmentIDInsensitively(input string) (*EnvironmentId, error)

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

func (*EnvironmentId) FromParseResult 

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

func (EnvironmentId) ID 

func (id EnvironmentId) ID() string

ID returns the formatted Environment ID

func (EnvironmentId) Segments 

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

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

func (EnvironmentId) String 

func (id EnvironmentId) String() string

String returns a human-readable description of this Environment ID

type GetByEnvironmentCompleteResult added in v0.20240226.1173038 

type GetByEnvironmentCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ClusterCodeVersionsResult
}

type GetByEnvironmentCustomPager added in v0.20240628.1153531 

type GetByEnvironmentCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *GetByEnvironmentCustomPager) NextPageLink() *odata.Link

type GetByEnvironmentOperationResponse 

type GetByEnvironmentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ClusterCodeVersionsResult
}

type GetCompleteResult added in v0.20240226.1173038 

type GetCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ClusterCodeVersionsResult
}

type GetCustomPager added in v0.20240628.1153531 

type GetCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *GetCustomPager) NextPageLink() *odata.Link

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ClusterCodeVersionsResult
}

type ListByEnvironmentCompleteResult added in v0.20240226.1173038 

type ListByEnvironmentCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ClusterCodeVersionsResult
}

type ListByEnvironmentCustomPager added in v0.20240628.1153531 

type ListByEnvironmentCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByEnvironmentCustomPager) NextPageLink() *odata.Link

type ListByEnvironmentOperationResponse 

type ListByEnvironmentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ClusterCodeVersionsResult
}

type ListCompleteResult added in v0.20240226.1173038 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ClusterCodeVersionsResult
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ClusterCodeVersionsResult
}

type LocationId 

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID 

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively 

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult 

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

func (LocationId) ID 

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments 

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

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

func (LocationId) String 

func (id LocationId) String() string

String returns a human-readable description of this Location ID

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.