application

package
v0.20240923.1142107 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicefabricmanagedcluster/2024-04-01/application Documentation

The application SDK allows for interaction with Azure Resource Manager servicefabricmanagedcluster (API Version 2024-04-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/2024-04-01/application"

Client Initialization

client := application.NewApplicationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApplicationClient.CreateOrUpdate

ctx := context.TODO()
id := application.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "applicationName")

payload := application.ApplicationResource{
	// ...
}


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

Example Usage: ApplicationClient.Delete

ctx := context.TODO()
id := application.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "applicationName")

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

Example Usage: ApplicationClient.Get

ctx := context.TODO()
id := application.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "applicationName")

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: ApplicationClient.List

ctx := context.TODO()
id := application.NewManagedClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName")

// 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: ApplicationClient.ReadUpgrade

ctx := context.TODO()
id := application.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "applicationName")

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

Example Usage: ApplicationClient.ResumeUpgrade

ctx := context.TODO()
id := application.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "applicationName")

payload := application.RuntimeResumeApplicationUpgradeParameters{
	// ...
}


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

Example Usage: ApplicationClient.StartRollback

ctx := context.TODO()
id := application.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "applicationName")

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

Example Usage: ApplicationClient.Update

ctx := context.TODO()
id := application.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "applicationName")

payload := application.ApplicationUpdateParameters{
	// ...
}


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

func PossibleValuesForFailureAction() []string

func PossibleValuesForRollingUpgradeMode 

func PossibleValuesForRollingUpgradeMode() []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 ValidateManagedClusterID 

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

ValidateManagedClusterID checks that 'input' can be parsed as a Managed Cluster ID

Types

type ApplicationClient 

type ApplicationClient struct {
	Client *resourcemanager.Client
}

func NewApplicationClientWithBaseURI 

func NewApplicationClientWithBaseURI(sdkApi sdkEnv.Api) (*ApplicationClient, error)

func (ApplicationClient) CreateOrUpdate 

func (c ApplicationClient) CreateOrUpdate(ctx context.Context, id ApplicationId, input ApplicationResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ApplicationClient) CreateOrUpdateThenPoll 

func (c ApplicationClient) CreateOrUpdateThenPoll(ctx context.Context, id ApplicationId, input ApplicationResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ApplicationClient) Delete 

func (c ApplicationClient) Delete(ctx context.Context, id ApplicationId) (result DeleteOperationResponse, err error)

Delete ...

func (ApplicationClient) DeleteThenPoll 

func (c ApplicationClient) DeleteThenPoll(ctx context.Context, id ApplicationId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ApplicationClient) Get 

func (c ApplicationClient) Get(ctx context.Context, id ApplicationId) (result GetOperationResponse, err error)

Get ...

func (ApplicationClient) List 

func (c ApplicationClient) List(ctx context.Context, id ManagedClusterId) (result ListOperationResponse, err error)

List ...

func (ApplicationClient) ListComplete 

func (c ApplicationClient) ListComplete(ctx context.Context, id ManagedClusterId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ApplicationClient) ListCompleteMatchingPredicate 

func (c ApplicationClient) ListCompleteMatchingPredicate(ctx context.Context, id ManagedClusterId, predicate ApplicationResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApplicationClient) ReadUpgrade 

func (c ApplicationClient) ReadUpgrade(ctx context.Context, id ApplicationId) (result ReadUpgradeOperationResponse, err error)

ReadUpgrade ...

func (ApplicationClient) ReadUpgradeThenPoll 

func (c ApplicationClient) ReadUpgradeThenPoll(ctx context.Context, id ApplicationId) error

ReadUpgradeThenPoll performs ReadUpgrade then polls until it's completed

func (ApplicationClient) ResumeUpgrade 

func (c ApplicationClient) ResumeUpgrade(ctx context.Context, id ApplicationId, input RuntimeResumeApplicationUpgradeParameters) (result ResumeUpgradeOperationResponse, err error)

ResumeUpgrade ...

func (ApplicationClient) ResumeUpgradeThenPoll 

func (c ApplicationClient) ResumeUpgradeThenPoll(ctx context.Context, id ApplicationId, input RuntimeResumeApplicationUpgradeParameters) error

ResumeUpgradeThenPoll performs ResumeUpgrade then polls until it's completed

func (ApplicationClient) StartRollback 

func (c ApplicationClient) StartRollback(ctx context.Context, id ApplicationId) (result StartRollbackOperationResponse, err error)

StartRollback ...

func (ApplicationClient) StartRollbackThenPoll 

func (c ApplicationClient) StartRollbackThenPoll(ctx context.Context, id ApplicationId) error

StartRollbackThenPoll performs StartRollback then polls until it's completed

func (ApplicationClient) Update 

func (c ApplicationClient) Update(ctx context.Context, id ApplicationId, input ApplicationUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

type ApplicationHealthPolicy 

type ApplicationHealthPolicy struct {
	ConsiderWarningAsError                  bool                                `json:"considerWarningAsError"`
	DefaultServiceTypeHealthPolicy          *ServiceTypeHealthPolicy            `json:"defaultServiceTypeHealthPolicy,omitempty"`
	MaxPercentUnhealthyDeployedApplications int64                               `json:"maxPercentUnhealthyDeployedApplications"`
	ServiceTypeHealthPolicyMap              *map[string]ServiceTypeHealthPolicy `json:"serviceTypeHealthPolicyMap,omitempty"`
}

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

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

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 ApplicationResource 

type ApplicationResource struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *ApplicationResourceProperties     `json:"properties,omitempty"`
	SystemData *SystemData                        `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type ApplicationResourceOperationPredicate 

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

func (ApplicationResourceOperationPredicate) Matches 

func (p ApplicationResourceOperationPredicate) Matches(input ApplicationResource) bool

type ApplicationResourceProperties 

type ApplicationResourceProperties struct {
	ManagedIdentities *[]ApplicationUserAssignedIdentity `json:"managedIdentities,omitempty"`
	Parameters        *map[string]string                 `json:"parameters,omitempty"`
	ProvisioningState *string                            `json:"provisioningState,omitempty"`
	UpgradePolicy     *ApplicationUpgradePolicy          `json:"upgradePolicy,omitempty"`
	Version           *string                            `json:"version,omitempty"`
}

type ApplicationUpdateParameters 

type ApplicationUpdateParameters struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type ApplicationUpgradePolicy 

type ApplicationUpgradePolicy struct {
	ApplicationHealthPolicy        *ApplicationHealthPolicy        `json:"applicationHealthPolicy,omitempty"`
	ForceRestart                   *bool                           `json:"forceRestart,omitempty"`
	InstanceCloseDelayDuration     *int64                          `json:"instanceCloseDelayDuration,omitempty"`
	RecreateApplication            *bool                           `json:"recreateApplication,omitempty"`
	RollingUpgradeMonitoringPolicy *RollingUpgradeMonitoringPolicy `json:"rollingUpgradeMonitoringPolicy,omitempty"`
	UpgradeMode                    *RollingUpgradeMode             `json:"upgradeMode,omitempty"`
	UpgradeReplicaSetCheckTimeout  *int64                          `json:"upgradeReplicaSetCheckTimeout,omitempty"`
}

type ApplicationUserAssignedIdentity 

type ApplicationUserAssignedIdentity struct {
	Name        string `json:"name"`
	PrincipalId string `json:"principalId"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationResource
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type FailureAction 

type FailureAction string
const (
	FailureActionManual   FailureAction = "Manual"
	FailureActionRollback FailureAction = "Rollback"
)

func (*FailureAction) UnmarshalJSON 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

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        *[]ApplicationResource
}

type ManagedClusterId 

type ManagedClusterId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ManagedClusterName string
}

ManagedClusterId is a struct representing the Resource ID for a Managed Cluster

func NewManagedClusterID 

func NewManagedClusterID(subscriptionId string, resourceGroupName string, managedClusterName string) ManagedClusterId

NewManagedClusterID returns a new ManagedClusterId struct

func ParseManagedClusterID 

func ParseManagedClusterID(input string) (*ManagedClusterId, error)

ParseManagedClusterID parses 'input' into a ManagedClusterId

func ParseManagedClusterIDInsensitively 

func ParseManagedClusterIDInsensitively(input string) (*ManagedClusterId, error)

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

func (*ManagedClusterId) FromParseResult 

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

func (ManagedClusterId) ID 

func (id ManagedClusterId) ID() string

ID returns the formatted Managed Cluster ID

func (ManagedClusterId) Segments 

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

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

func (ManagedClusterId) String 

func (id ManagedClusterId) String() string

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

type ReadUpgradeOperationResponse 

type ReadUpgradeOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ResumeUpgradeOperationResponse 

type ResumeUpgradeOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type RollingUpgradeMode 

type RollingUpgradeMode string
const (
	RollingUpgradeModeMonitored       RollingUpgradeMode = "Monitored"
	RollingUpgradeModeUnmonitoredAuto RollingUpgradeMode = "UnmonitoredAuto"
)

func (*RollingUpgradeMode) UnmarshalJSON 

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

type RollingUpgradeMonitoringPolicy 

type RollingUpgradeMonitoringPolicy struct {
	FailureAction             FailureAction `json:"failureAction"`
	HealthCheckRetryTimeout   string        `json:"healthCheckRetryTimeout"`
	HealthCheckStableDuration string        `json:"healthCheckStableDuration"`
	HealthCheckWaitDuration   string        `json:"healthCheckWaitDuration"`
	UpgradeDomainTimeout      string        `json:"upgradeDomainTimeout"`
	UpgradeTimeout            string        `json:"upgradeTimeout"`
}

type RuntimeResumeApplicationUpgradeParameters 

type RuntimeResumeApplicationUpgradeParameters struct {
	UpgradeDomainName *string `json:"upgradeDomainName,omitempty"`
}

type ServiceTypeHealthPolicy 

type ServiceTypeHealthPolicy struct {
	MaxPercentUnhealthyPartitionsPerService int64 `json:"maxPercentUnhealthyPartitionsPerService"`
	MaxPercentUnhealthyReplicasPerPartition int64 `json:"maxPercentUnhealthyReplicasPerPartition"`
	MaxPercentUnhealthyServices             int64 `json:"maxPercentUnhealthyServices"`
}

type StartRollbackOperationResponse 

type StartRollbackOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

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 UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationResource
}

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.