service

package
v0.20230419.1172249 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicefabricmanagedcluster/2021-05-01/service Documentation

The service SDK allows for interaction with the Azure Resource Manager Service servicefabricmanagedcluster (API Version 2021-05-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/servicefabricmanagedcluster/2021-05-01/service"

Client Initialization

client := service.NewServiceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServiceClient.CreateOrUpdate

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

payload := service.ServiceResource{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ServiceClient.Delete

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

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ServiceClient.Get

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

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: ServiceClient.ListByApplications

ctx := context.TODO()
id := service.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedClusterValue", "applicationValue")

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

func PossibleValuesForMoveCost() []string

func PossibleValuesForPartitionScheme 

func PossibleValuesForPartitionScheme() []string

func PossibleValuesForServiceCorrelationScheme 

func PossibleValuesForServiceCorrelationScheme() []string

func PossibleValuesForServiceKind 

func PossibleValuesForServiceKind() []string

func PossibleValuesForServiceLoadMetricWeight 

func PossibleValuesForServiceLoadMetricWeight() []string

func PossibleValuesForServicePackageActivationMode 

func PossibleValuesForServicePackageActivationMode() []string

func PossibleValuesForServicePlacementPolicyType 

func PossibleValuesForServicePlacementPolicyType() []string

func PossibleValuesForServiceScalingMechanismKind 

func PossibleValuesForServiceScalingMechanismKind() []string

func PossibleValuesForServiceScalingTriggerKind 

func PossibleValuesForServiceScalingTriggerKind() []string

func ValidateApplicationID 

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

ValidateApplicationID checks that 'input' can be parsed as a Application 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 AddRemoveIncrementalNamedPartitionScalingMechanism 

type AddRemoveIncrementalNamedPartitionScalingMechanism struct {
	MaxPartitionCount int64 `json:"maxPartitionCount"`
	MinPartitionCount int64 `json:"minPartitionCount"`
	ScaleIncrement    int64 `json:"scaleIncrement"`
}

func (AddRemoveIncrementalNamedPartitionScalingMechanism) MarshalJSON 

func (s AddRemoveIncrementalNamedPartitionScalingMechanism) MarshalJSON() ([]byte, error)

type ApplicationId 

type ApplicationId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ManagedClusterName string
	ApplicationName    string
}

ApplicationId is a struct representing the Resource ID for a Application

func NewApplicationID 

func NewApplicationID(subscriptionId string, resourceGroupName string, managedClusterName string, applicationName string) ApplicationId

NewApplicationID returns a new ApplicationId struct

func ParseApplicationID 

func ParseApplicationID(input string) (*ApplicationId, error)

ParseApplicationID parses 'input' into a ApplicationId

func ParseApplicationIDInsensitively 

func ParseApplicationIDInsensitively(input string) (*ApplicationId, error)

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

func (ApplicationId) ID 

func (id ApplicationId) ID() string

ID returns the formatted Application ID

func (ApplicationId) Segments 

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

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

func (ApplicationId) String 

func (id ApplicationId) String() string

String returns a human-readable description of this Application ID

type AveragePartitionLoadScalingTrigger 

type AveragePartitionLoadScalingTrigger struct {
	LowerLoadThreshold float64 `json:"lowerLoadThreshold"`
	MetricName         string  `json:"metricName"`
	ScaleInterval      string  `json:"scaleInterval"`
	UpperLoadThreshold float64 `json:"upperLoadThreshold"`
}

func (AveragePartitionLoadScalingTrigger) MarshalJSON 

func (s AveragePartitionLoadScalingTrigger) MarshalJSON() ([]byte, error)

type AverageServiceLoadScalingTrigger 

type AverageServiceLoadScalingTrigger struct {
	LowerLoadThreshold float64 `json:"lowerLoadThreshold"`
	MetricName         string  `json:"metricName"`
	ScaleInterval      string  `json:"scaleInterval"`
	UpperLoadThreshold float64 `json:"upperLoadThreshold"`
	UseOnlyPrimaryLoad bool    `json:"useOnlyPrimaryLoad"`
}

func (AverageServiceLoadScalingTrigger) MarshalJSON 

func (s AverageServiceLoadScalingTrigger) MarshalJSON() ([]byte, error)

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *ServiceResource
}

type ListByApplicationsCompleteResult 

type ListByApplicationsCompleteResult struct {
	Items []ServiceResource
}

type ListByApplicationsOperationResponse 

type ListByApplicationsOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]ServiceResource
	// contains filtered or unexported fields
}

func (ListByApplicationsOperationResponse) HasMore 

func (r ListByApplicationsOperationResponse) HasMore() bool

func (ListByApplicationsOperationResponse) LoadMore 

func (r ListByApplicationsOperationResponse) LoadMore(ctx context.Context) (resp ListByApplicationsOperationResponse, err error)

type MoveCost 

type MoveCost string
const (
	MoveCostHigh   MoveCost = "High"
	MoveCostLow    MoveCost = "Low"
	MoveCostMedium MoveCost = "Medium"
	MoveCostZero   MoveCost = "Zero"
)

type NamedPartitionScheme 

type NamedPartitionScheme struct {
	Names []string `json:"names"`
}

func (NamedPartitionScheme) MarshalJSON 

func (s NamedPartitionScheme) MarshalJSON() ([]byte, error)

type Partition 

type Partition interface {
}

type PartitionInstanceCountScaleMechanism 

type PartitionInstanceCountScaleMechanism struct {
	MaxInstanceCount int64 `json:"maxInstanceCount"`
	MinInstanceCount int64 `json:"minInstanceCount"`
	ScaleIncrement   int64 `json:"scaleIncrement"`
}

func (PartitionInstanceCountScaleMechanism) MarshalJSON 

func (s PartitionInstanceCountScaleMechanism) MarshalJSON() ([]byte, error)

type PartitionScheme 

type PartitionScheme string
const (
	PartitionSchemeNamed                  PartitionScheme = "Named"
	PartitionSchemeSingleton              PartitionScheme = "Singleton"
	PartitionSchemeUniformIntSixFourRange PartitionScheme = "UniformInt64Range"
)

type ScalingMechanism 

type ScalingMechanism interface {
}

type ScalingPolicy 

type ScalingPolicy struct {
	ScalingMechanism ScalingMechanism `json:"scalingMechanism"`
	ScalingTrigger   ScalingTrigger   `json:"scalingTrigger"`
}

func (*ScalingPolicy) UnmarshalJSON 

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

type ScalingTrigger 

type ScalingTrigger interface {
}

type ServiceClient 

type ServiceClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewServiceClientWithBaseURI 

func NewServiceClientWithBaseURI(endpoint string) ServiceClient

func (ServiceClient) CreateOrUpdate 

func (c ServiceClient) CreateOrUpdate(ctx context.Context, id ServiceId, input ServiceResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ServiceClient) CreateOrUpdateThenPoll 

func (c ServiceClient) CreateOrUpdateThenPoll(ctx context.Context, id ServiceId, input ServiceResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ServiceClient) Delete 

func (c ServiceClient) Delete(ctx context.Context, id ServiceId) (result DeleteOperationResponse, err error)

Delete ...

func (ServiceClient) DeleteThenPoll 

func (c ServiceClient) DeleteThenPoll(ctx context.Context, id ServiceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ServiceClient) Get 

func (c ServiceClient) Get(ctx context.Context, id ServiceId) (result GetOperationResponse, err error)

Get ...

func (ServiceClient) ListByApplications 

func (c ServiceClient) ListByApplications(ctx context.Context, id ApplicationId) (resp ListByApplicationsOperationResponse, err error)

ListByApplications ...

func (ServiceClient) ListByApplicationsComplete 

func (c ServiceClient) ListByApplicationsComplete(ctx context.Context, id ApplicationId) (ListByApplicationsCompleteResult, error)

ListByApplicationsComplete retrieves all of the results into a single object

func (ServiceClient) ListByApplicationsCompleteMatchingPredicate 

func (c ServiceClient) ListByApplicationsCompleteMatchingPredicate(ctx context.Context, id ApplicationId, predicate ServiceResourceOperationPredicate) (resp ListByApplicationsCompleteResult, err error)

ListByApplicationsCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type ServiceCorrelation 

type ServiceCorrelation struct {
	Scheme      ServiceCorrelationScheme `json:"scheme"`
	ServiceName string                   `json:"serviceName"`
}

type ServiceCorrelationScheme 

type ServiceCorrelationScheme string
const (
	ServiceCorrelationSchemeAlignedAffinity    ServiceCorrelationScheme = "AlignedAffinity"
	ServiceCorrelationSchemeNonAlignedAffinity ServiceCorrelationScheme = "NonAlignedAffinity"
)

type ServiceId 

type ServiceId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ManagedClusterName string
	ApplicationName    string
	ServiceName        string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID 

func NewServiceID(subscriptionId string, resourceGroupName string, managedClusterName string, applicationName 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 ServiceKind 

type ServiceKind string
const (
	ServiceKindStateful  ServiceKind = "Stateful"
	ServiceKindStateless ServiceKind = "Stateless"
)

type ServiceLoadMetric 

type ServiceLoadMetric struct {
	DefaultLoad          *int64                   `json:"defaultLoad,omitempty"`
	Name                 string                   `json:"name"`
	PrimaryDefaultLoad   *int64                   `json:"primaryDefaultLoad,omitempty"`
	SecondaryDefaultLoad *int64                   `json:"secondaryDefaultLoad,omitempty"`
	Weight               *ServiceLoadMetricWeight `json:"weight,omitempty"`
}

type ServiceLoadMetricWeight 

type ServiceLoadMetricWeight string
const (
	ServiceLoadMetricWeightHigh   ServiceLoadMetricWeight = "High"
	ServiceLoadMetricWeightLow    ServiceLoadMetricWeight = "Low"
	ServiceLoadMetricWeightMedium ServiceLoadMetricWeight = "Medium"
	ServiceLoadMetricWeightZero   ServiceLoadMetricWeight = "Zero"
)

type ServicePackageActivationMode 

type ServicePackageActivationMode string
const (
	ServicePackageActivationModeExclusiveProcess ServicePackageActivationMode = "ExclusiveProcess"
	ServicePackageActivationModeSharedProcess    ServicePackageActivationMode = "SharedProcess"
)

type ServicePlacementInvalidDomainPolicy 

type ServicePlacementInvalidDomainPolicy struct {
	DomainName string `json:"domainName"`
}

func (ServicePlacementInvalidDomainPolicy) MarshalJSON 

func (s ServicePlacementInvalidDomainPolicy) MarshalJSON() ([]byte, error)

type ServicePlacementNonPartiallyPlaceServicePolicy 

type ServicePlacementNonPartiallyPlaceServicePolicy struct {
}

func (ServicePlacementNonPartiallyPlaceServicePolicy) MarshalJSON 

func (s ServicePlacementNonPartiallyPlaceServicePolicy) MarshalJSON() ([]byte, error)

type ServicePlacementPolicy 

type ServicePlacementPolicy interface {
}

type ServicePlacementPolicyType 

type ServicePlacementPolicyType string
const (
	ServicePlacementPolicyTypeInvalidDomain              ServicePlacementPolicyType = "InvalidDomain"
	ServicePlacementPolicyTypeNonPartiallyPlaceService   ServicePlacementPolicyType = "NonPartiallyPlaceService"
	ServicePlacementPolicyTypePreferredPrimaryDomain     ServicePlacementPolicyType = "PreferredPrimaryDomain"
	ServicePlacementPolicyTypeRequiredDomain             ServicePlacementPolicyType = "RequiredDomain"
	ServicePlacementPolicyTypeRequiredDomainDistribution ServicePlacementPolicyType = "RequiredDomainDistribution"
)

type ServicePlacementPreferPrimaryDomainPolicy 

type ServicePlacementPreferPrimaryDomainPolicy struct {
	DomainName string `json:"domainName"`
}

func (ServicePlacementPreferPrimaryDomainPolicy) MarshalJSON 

func (s ServicePlacementPreferPrimaryDomainPolicy) MarshalJSON() ([]byte, error)

type ServicePlacementRequireDomainDistributionPolicy 

type ServicePlacementRequireDomainDistributionPolicy struct {
	DomainName string `json:"domainName"`
}

func (ServicePlacementRequireDomainDistributionPolicy) MarshalJSON 

func (s ServicePlacementRequireDomainDistributionPolicy) MarshalJSON() ([]byte, error)

type ServicePlacementRequiredDomainPolicy 

type ServicePlacementRequiredDomainPolicy struct {
	DomainName string `json:"domainName"`
}

func (ServicePlacementRequiredDomainPolicy) MarshalJSON 

func (s ServicePlacementRequiredDomainPolicy) MarshalJSON() ([]byte, error)

type ServiceResource 

type ServiceResource struct {
	Id         *string                    `json:"id,omitempty"`
	Location   *string                    `json:"location,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties *ServiceResourceProperties `json:"properties,omitempty"`
	SystemData *SystemData                `json:"systemData,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

func (*ServiceResource) UnmarshalJSON 

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

type ServiceResourceOperationPredicate 

type ServiceResourceOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ServiceResourceOperationPredicate) Matches 

func (p ServiceResourceOperationPredicate) Matches(input ServiceResource) bool

type ServiceResourceProperties 

type ServiceResourceProperties interface {
}

type ServiceScalingMechanismKind 

type ServiceScalingMechanismKind string
const (
	ServiceScalingMechanismKindAddRemoveIncrementalNamedPartition ServiceScalingMechanismKind = "AddRemoveIncrementalNamedPartition"
	ServiceScalingMechanismKindScalePartitionInstanceCount        ServiceScalingMechanismKind = "ScalePartitionInstanceCount"
)

type ServiceScalingTriggerKind 

type ServiceScalingTriggerKind string
const (
	ServiceScalingTriggerKindAveragePartitionLoad ServiceScalingTriggerKind = "AveragePartitionLoad"
	ServiceScalingTriggerKindAverageServiceLoad   ServiceScalingTriggerKind = "AverageServiceLoad"
)

type SingletonPartitionScheme 

type SingletonPartitionScheme struct {
}

func (SingletonPartitionScheme) MarshalJSON 

func (s SingletonPartitionScheme) MarshalJSON() ([]byte, error)

type StatefulServiceProperties 

type StatefulServiceProperties struct {
	HasPersistedState          *bool   `json:"hasPersistedState,omitempty"`
	MinReplicaSetSize          *int64  `json:"minReplicaSetSize,omitempty"`
	QuorumLossWaitDuration     *string `json:"quorumLossWaitDuration,omitempty"`
	ReplicaRestartWaitDuration *string `json:"replicaRestartWaitDuration,omitempty"`
	ServicePlacementTimeLimit  *string `json:"servicePlacementTimeLimit,omitempty"`
	StandByReplicaKeepDuration *string `json:"standByReplicaKeepDuration,omitempty"`
	TargetReplicaSetSize       *int64  `json:"targetReplicaSetSize,omitempty"`

	// Fields inherited from ServiceResourceProperties
	CorrelationScheme            *[]ServiceCorrelation         `json:"correlationScheme,omitempty"`
	DefaultMoveCost              *MoveCost                     `json:"defaultMoveCost,omitempty"`
	PartitionDescription         Partition                     `json:"partitionDescription"`
	PlacementConstraints         *string                       `json:"placementConstraints,omitempty"`
	ProvisioningState            *string                       `json:"provisioningState,omitempty"`
	ScalingPolicies              *[]ScalingPolicy              `json:"scalingPolicies,omitempty"`
	ServiceLoadMetrics           *[]ServiceLoadMetric          `json:"serviceLoadMetrics,omitempty"`
	ServicePackageActivationMode *ServicePackageActivationMode `json:"servicePackageActivationMode,omitempty"`
	ServicePlacementPolicies     *[]ServicePlacementPolicy     `json:"servicePlacementPolicies,omitempty"`
	ServiceTypeName              string                        `json:"serviceTypeName"`
}

func (StatefulServiceProperties) MarshalJSON 

func (s StatefulServiceProperties) MarshalJSON() ([]byte, error)

func (*StatefulServiceProperties) UnmarshalJSON added in v0.20220704.1074157 

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

type StatelessServiceProperties 

type StatelessServiceProperties struct {
	InstanceCount         int64  `json:"instanceCount"`
	MinInstanceCount      *int64 `json:"minInstanceCount,omitempty"`
	MinInstancePercentage *int64 `json:"minInstancePercentage,omitempty"`

	// Fields inherited from ServiceResourceProperties
	CorrelationScheme            *[]ServiceCorrelation         `json:"correlationScheme,omitempty"`
	DefaultMoveCost              *MoveCost                     `json:"defaultMoveCost,omitempty"`
	PartitionDescription         Partition                     `json:"partitionDescription"`
	PlacementConstraints         *string                       `json:"placementConstraints,omitempty"`
	ProvisioningState            *string                       `json:"provisioningState,omitempty"`
	ScalingPolicies              *[]ScalingPolicy              `json:"scalingPolicies,omitempty"`
	ServiceLoadMetrics           *[]ServiceLoadMetric          `json:"serviceLoadMetrics,omitempty"`
	ServicePackageActivationMode *ServicePackageActivationMode `json:"servicePackageActivationMode,omitempty"`
	ServicePlacementPolicies     *[]ServicePlacementPolicy     `json:"servicePlacementPolicies,omitempty"`
	ServiceTypeName              string                        `json:"serviceTypeName"`
}

func (StatelessServiceProperties) MarshalJSON 

func (s StatelessServiceProperties) MarshalJSON() ([]byte, error)

func (*StatelessServiceProperties) UnmarshalJSON added in v0.20220704.1074157 

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

type SystemData 

type SystemData struct {
	CreatedAt          *string `json:"createdAt,omitempty"`
	CreatedBy          *string `json:"createdBy,omitempty"`
	CreatedByType      *string `json:"createdByType,omitempty"`
	LastModifiedAt     *string `json:"lastModifiedAt,omitempty"`
	LastModifiedBy     *string `json:"lastModifiedBy,omitempty"`
	LastModifiedByType *string `json:"lastModifiedByType,omitempty"`
}

func (*SystemData) GetCreatedAtAsTime 

func (o *SystemData) GetCreatedAtAsTime() (*time.Time, error)

func (*SystemData) GetLastModifiedAtAsTime 

func (o *SystemData) GetLastModifiedAtAsTime() (*time.Time, error)

func (*SystemData) SetCreatedAtAsTime 

func (o *SystemData) SetCreatedAtAsTime(input time.Time)

func (*SystemData) SetLastModifiedAtAsTime 

func (o *SystemData) SetLastModifiedAtAsTime(input time.Time)

type UniformInt64RangePartitionScheme 

type UniformInt64RangePartitionScheme struct {
	Count   int64 `json:"count"`
	HighKey int64 `json:"highKey"`
	LowKey  int64 `json:"lowKey"`
}

func (UniformInt64RangePartitionScheme) MarshalJSON 

func (s UniformInt64RangePartitionScheme) MarshalJSON() ([]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.