standbycontainergrouppools

package
v0.20250115.1141151 Latest Latest
Warning

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

 Go to latest Published: Jan 15, 2025 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/standbypool/2024-03-01/standbycontainergrouppools Documentation

The standbycontainergrouppools SDK allows for interaction with Azure Resource Manager standbypool (API Version 2024-03-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/standbypool/2024-03-01/standbycontainergrouppools"

Client Initialization

client := standbycontainergrouppools.NewStandbyContainerGroupPoolsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StandbyContainerGroupPoolsClient.CreateOrUpdate

ctx := context.TODO()
id := standbycontainergrouppools.NewStandbyContainerGroupPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "standbyContainerGroupPoolName")

payload := standbycontainergrouppools.StandbyContainerGroupPoolResource{
	// ...
}


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

Example Usage: StandbyContainerGroupPoolsClient.Delete

ctx := context.TODO()
id := standbycontainergrouppools.NewStandbyContainerGroupPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "standbyContainerGroupPoolName")

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

Example Usage: StandbyContainerGroupPoolsClient.Get

ctx := context.TODO()
id := standbycontainergrouppools.NewStandbyContainerGroupPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "standbyContainerGroupPoolName")

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: StandbyContainerGroupPoolsClient.ListByResourceGroup

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

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

Example Usage: StandbyContainerGroupPoolsClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: StandbyContainerGroupPoolsClient.Update

ctx := context.TODO()
id := standbycontainergrouppools.NewStandbyContainerGroupPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "standbyContainerGroupPoolName")

payload := standbycontainergrouppools.StandbyContainerGroupPoolResourceUpdate{
	// ...
}


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 PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForRefillPolicy 

func PossibleValuesForRefillPolicy() []string

func ValidateStandbyContainerGroupPoolID 

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

ValidateStandbyContainerGroupPoolID checks that 'input' can be parsed as a Standby Container Group Pool ID

Types

type ContainerGroupProfile 

type ContainerGroupProfile struct {
	Id       string `json:"id"`
	Revision *int64 `json:"revision,omitempty"`
}

type ContainerGroupProperties 

type ContainerGroupProperties struct {
	ContainerGroupProfile ContainerGroupProfile `json:"containerGroupProfile"`
	SubnetIds             *[]Subnet             `json:"subnetIds,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StandbyContainerGroupPoolResource
}

type ListByResourceGroupCustomPager 

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

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StandbyContainerGroupPoolResource
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StandbyContainerGroupPoolResource
}

type ListBySubscriptionCustomPager 

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

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StandbyContainerGroupPoolResource
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON 

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

type RefillPolicy 

type RefillPolicy string
const (
	RefillPolicyAlways RefillPolicy = "always"
)

func (*RefillPolicy) UnmarshalJSON 

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

type StandbyContainerGroupPoolElasticityProfile 

type StandbyContainerGroupPoolElasticityProfile struct {
	MaxReadyCapacity int64         `json:"maxReadyCapacity"`
	RefillPolicy     *RefillPolicy `json:"refillPolicy,omitempty"`
}

type StandbyContainerGroupPoolId 

type StandbyContainerGroupPoolId struct {
	SubscriptionId                string
	ResourceGroupName             string
	StandbyContainerGroupPoolName string
}

StandbyContainerGroupPoolId is a struct representing the Resource ID for a Standby Container Group Pool

func NewStandbyContainerGroupPoolID 

func NewStandbyContainerGroupPoolID(subscriptionId string, resourceGroupName string, standbyContainerGroupPoolName string) StandbyContainerGroupPoolId

NewStandbyContainerGroupPoolID returns a new StandbyContainerGroupPoolId struct

func ParseStandbyContainerGroupPoolID 

func ParseStandbyContainerGroupPoolID(input string) (*StandbyContainerGroupPoolId, error)

ParseStandbyContainerGroupPoolID parses 'input' into a StandbyContainerGroupPoolId

func ParseStandbyContainerGroupPoolIDInsensitively 

func ParseStandbyContainerGroupPoolIDInsensitively(input string) (*StandbyContainerGroupPoolId, error)

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

func (*StandbyContainerGroupPoolId) FromParseResult 

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

func (StandbyContainerGroupPoolId) ID 

func (id StandbyContainerGroupPoolId) ID() string

ID returns the formatted Standby Container Group Pool ID

func (StandbyContainerGroupPoolId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Standby Container Group Pool ID

func (StandbyContainerGroupPoolId) String 

func (id StandbyContainerGroupPoolId) String() string

String returns a human-readable description of this Standby Container Group Pool ID

type StandbyContainerGroupPoolResource 

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

type StandbyContainerGroupPoolResourceOperationPredicate 

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

func (StandbyContainerGroupPoolResourceOperationPredicate) Matches 

func (p StandbyContainerGroupPoolResourceOperationPredicate) Matches(input StandbyContainerGroupPoolResource) bool

type StandbyContainerGroupPoolResourceProperties 

type StandbyContainerGroupPoolResourceProperties struct {
	ContainerGroupProperties ContainerGroupProperties                   `json:"containerGroupProperties"`
	ElasticityProfile        StandbyContainerGroupPoolElasticityProfile `json:"elasticityProfile"`
	ProvisioningState        *ProvisioningState                         `json:"provisioningState,omitempty"`
}

type StandbyContainerGroupPoolResourceUpdate 

type StandbyContainerGroupPoolResourceUpdate struct {
	Properties *StandbyContainerGroupPoolResourceUpdateProperties `json:"properties,omitempty"`
	Tags       *map[string]string                                 `json:"tags,omitempty"`
}

type StandbyContainerGroupPoolResourceUpdateProperties 

type StandbyContainerGroupPoolResourceUpdateProperties struct {
	ContainerGroupProperties *ContainerGroupProperties                   `json:"containerGroupProperties,omitempty"`
	ElasticityProfile        *StandbyContainerGroupPoolElasticityProfile `json:"elasticityProfile,omitempty"`
}

type StandbyContainerGroupPoolsClient 

type StandbyContainerGroupPoolsClient struct {
	Client *resourcemanager.Client
}

func NewStandbyContainerGroupPoolsClientWithBaseURI 

func NewStandbyContainerGroupPoolsClientWithBaseURI(sdkApi sdkEnv.Api) (*StandbyContainerGroupPoolsClient, error)

func (StandbyContainerGroupPoolsClient) CreateOrUpdate 

func (c StandbyContainerGroupPoolsClient) CreateOrUpdate(ctx context.Context, id StandbyContainerGroupPoolId, input StandbyContainerGroupPoolResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (StandbyContainerGroupPoolsClient) CreateOrUpdateThenPoll 

func (c StandbyContainerGroupPoolsClient) CreateOrUpdateThenPoll(ctx context.Context, id StandbyContainerGroupPoolId, input StandbyContainerGroupPoolResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (StandbyContainerGroupPoolsClient) Delete 

func (c StandbyContainerGroupPoolsClient) Delete(ctx context.Context, id StandbyContainerGroupPoolId) (result DeleteOperationResponse, err error)

Delete ...

func (StandbyContainerGroupPoolsClient) DeleteThenPoll 

func (c StandbyContainerGroupPoolsClient) DeleteThenPoll(ctx context.Context, id StandbyContainerGroupPoolId) error

DeleteThenPoll performs Delete then polls until it's completed

func (StandbyContainerGroupPoolsClient) Get 

func (c StandbyContainerGroupPoolsClient) Get(ctx context.Context, id StandbyContainerGroupPoolId) (result GetOperationResponse, err error)

Get ...

func (StandbyContainerGroupPoolsClient) ListByResourceGroup 

func (c StandbyContainerGroupPoolsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (StandbyContainerGroupPoolsClient) ListByResourceGroupComplete 

func (c StandbyContainerGroupPoolsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (StandbyContainerGroupPoolsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c StandbyContainerGroupPoolsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate StandbyContainerGroupPoolResourceOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (StandbyContainerGroupPoolsClient) ListBySubscription 

func (c StandbyContainerGroupPoolsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (StandbyContainerGroupPoolsClient) ListBySubscriptionComplete 

func (c StandbyContainerGroupPoolsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (StandbyContainerGroupPoolsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c StandbyContainerGroupPoolsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate StandbyContainerGroupPoolResourceOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (StandbyContainerGroupPoolsClient) Update 

func (c StandbyContainerGroupPoolsClient) Update(ctx context.Context, id StandbyContainerGroupPoolId, input StandbyContainerGroupPoolResourceUpdate) (result UpdateOperationResponse, err error)

Update ...

type Subnet 

type Subnet struct {
	Id string `json:"id"`
}

type UpdateOperationResponse 

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

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.