containerappssessionpools

package
v0.20241209.1115630 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2024-02-02-preview/containerappssessionpools Documentation

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

Client Initialization

client := containerappssessionpools.NewContainerAppsSessionPoolsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContainerAppsSessionPoolsClient.CreateOrUpdate

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

payload := containerappssessionpools.SessionPool{
	// ...
}


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

Example Usage: ContainerAppsSessionPoolsClient.Delete

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

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

Example Usage: ContainerAppsSessionPoolsClient.Get

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

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: ContainerAppsSessionPoolsClient.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: ContainerAppsSessionPoolsClient.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: ContainerAppsSessionPoolsClient.Update

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

payload := containerappssessionpools.SessionPoolUpdatableProperties{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForContainerType 

func PossibleValuesForContainerType() []string

func PossibleValuesForExecutionType 

func PossibleValuesForExecutionType() []string

func PossibleValuesForPoolManagementType 

func PossibleValuesForPoolManagementType() []string

func PossibleValuesForSessionNetworkStatus 

func PossibleValuesForSessionNetworkStatus() []string

func PossibleValuesForSessionPoolProvisioningState 

func PossibleValuesForSessionPoolProvisioningState() []string

func ValidateSessionPoolID 

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

ValidateSessionPoolID checks that 'input' can be parsed as a Session Pool ID

Types

type ContainerAppsSessionPoolsClient 

type ContainerAppsSessionPoolsClient struct {
	Client *resourcemanager.Client
}

func NewContainerAppsSessionPoolsClientWithBaseURI 

func NewContainerAppsSessionPoolsClientWithBaseURI(sdkApi sdkEnv.Api) (*ContainerAppsSessionPoolsClient, error)

func (ContainerAppsSessionPoolsClient) CreateOrUpdate 

func (c ContainerAppsSessionPoolsClient) CreateOrUpdate(ctx context.Context, id SessionPoolId, input SessionPool) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ContainerAppsSessionPoolsClient) CreateOrUpdateThenPoll 

func (c ContainerAppsSessionPoolsClient) CreateOrUpdateThenPoll(ctx context.Context, id SessionPoolId, input SessionPool) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ContainerAppsSessionPoolsClient) Delete 

func (c ContainerAppsSessionPoolsClient) Delete(ctx context.Context, id SessionPoolId) (result DeleteOperationResponse, err error)

Delete ...

func (ContainerAppsSessionPoolsClient) DeleteThenPoll 

func (c ContainerAppsSessionPoolsClient) DeleteThenPoll(ctx context.Context, id SessionPoolId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ContainerAppsSessionPoolsClient) Get 

func (c ContainerAppsSessionPoolsClient) Get(ctx context.Context, id SessionPoolId) (result GetOperationResponse, err error)

Get ...

func (ContainerAppsSessionPoolsClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (ContainerAppsSessionPoolsClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (ContainerAppsSessionPoolsClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContainerAppsSessionPoolsClient) ListBySubscription 

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

ListBySubscription ...

func (ContainerAppsSessionPoolsClient) ListBySubscriptionComplete 

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

ListBySubscriptionComplete retrieves all the results into a single object

func (ContainerAppsSessionPoolsClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContainerAppsSessionPoolsClient) Update 

func (c ContainerAppsSessionPoolsClient) Update(ctx context.Context, id SessionPoolId, input SessionPoolUpdatableProperties) (result UpdateOperationResponse, err error)

Update ...

func (ContainerAppsSessionPoolsClient) UpdateThenPoll 

func (c ContainerAppsSessionPoolsClient) UpdateThenPoll(ctx context.Context, id SessionPoolId, input SessionPoolUpdatableProperties) error

UpdateThenPoll performs Update then polls until it's completed

type ContainerType 

type ContainerType string
const (
	ContainerTypeCustomContainer ContainerType = "CustomContainer"
	ContainerTypePythonLTS       ContainerType = "PythonLTS"
)

func (*ContainerType) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

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

type CustomContainerTemplate 

type CustomContainerTemplate struct {
	Containers          *[]SessionContainer         `json:"containers,omitempty"`
	Ingress             *SessionIngress             `json:"ingress,omitempty"`
	RegistryCredentials *SessionRegistryCredentials `json:"registryCredentials,omitempty"`
}

type DeleteOperationResponse 

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

type DynamicPoolConfiguration 

type DynamicPoolConfiguration struct {
	CooldownPeriodInSeconds *int64         `json:"cooldownPeriodInSeconds,omitempty"`
	ExecutionType           *ExecutionType `json:"executionType,omitempty"`
}

type EnvironmentVar 

type EnvironmentVar struct {
	Name      *string `json:"name,omitempty"`
	SecretRef *string `json:"secretRef,omitempty"`
	Value     *string `json:"value,omitempty"`
}

type ExecutionType 

type ExecutionType string
const (
	ExecutionTypeTimed ExecutionType = "Timed"
)

func (*ExecutionType) UnmarshalJSON 

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

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

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

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

type ListBySubscriptionCompleteResult 

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

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

type PoolManagementType 

type PoolManagementType string
const (
	PoolManagementTypeDynamic PoolManagementType = "Dynamic"
	PoolManagementTypeManual  PoolManagementType = "Manual"
)

func (*PoolManagementType) UnmarshalJSON 

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

type ScaleConfiguration 

type ScaleConfiguration struct {
	MaxConcurrentSessions *int64 `json:"maxConcurrentSessions,omitempty"`
	ReadySessionInstances *int64 `json:"readySessionInstances,omitempty"`
}

type SessionContainer 

type SessionContainer struct {
	Args      *[]string                  `json:"args,omitempty"`
	Command   *[]string                  `json:"command,omitempty"`
	Env       *[]EnvironmentVar          `json:"env,omitempty"`
	Image     *string                    `json:"image,omitempty"`
	Name      *string                    `json:"name,omitempty"`
	Resources *SessionContainerResources `json:"resources,omitempty"`
}

type SessionContainerResources 

type SessionContainerResources struct {
	Cpu    *float64 `json:"cpu,omitempty"`
	Memory *string  `json:"memory,omitempty"`
}

type SessionIngress 

type SessionIngress struct {
	TargetPort *int64 `json:"targetPort,omitempty"`
}

type SessionNetworkConfiguration 

type SessionNetworkConfiguration struct {
	Status *SessionNetworkStatus `json:"status,omitempty"`
}

type SessionNetworkStatus 

type SessionNetworkStatus string
const (
	SessionNetworkStatusEgressDisabled SessionNetworkStatus = "EgressDisabled"
	SessionNetworkStatusEgressEnabled  SessionNetworkStatus = "EgressEnabled"
)

func (*SessionNetworkStatus) UnmarshalJSON 

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

type SessionPool 

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

type SessionPoolId 

type SessionPoolId struct {
	SubscriptionId    string
	ResourceGroupName string
	SessionPoolName   string
}

SessionPoolId is a struct representing the Resource ID for a Session Pool

func NewSessionPoolID 

func NewSessionPoolID(subscriptionId string, resourceGroupName string, sessionPoolName string) SessionPoolId

NewSessionPoolID returns a new SessionPoolId struct

func ParseSessionPoolID 

func ParseSessionPoolID(input string) (*SessionPoolId, error)

ParseSessionPoolID parses 'input' into a SessionPoolId

func ParseSessionPoolIDInsensitively 

func ParseSessionPoolIDInsensitively(input string) (*SessionPoolId, error)

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

func (*SessionPoolId) FromParseResult 

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

func (SessionPoolId) ID 

func (id SessionPoolId) ID() string

ID returns the formatted Session Pool ID

func (SessionPoolId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Session Pool ID

func (SessionPoolId) String 

func (id SessionPoolId) String() string

String returns a human-readable description of this Session Pool ID

type SessionPoolOperationPredicate 

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

func (SessionPoolOperationPredicate) Matches 

func (p SessionPoolOperationPredicate) Matches(input SessionPool) bool

type SessionPoolProperties 

type SessionPoolProperties struct {
	ContainerType               *ContainerType                `json:"containerType,omitempty"`
	CustomContainerTemplate     *CustomContainerTemplate      `json:"customContainerTemplate,omitempty"`
	DynamicPoolConfiguration    *DynamicPoolConfiguration     `json:"dynamicPoolConfiguration,omitempty"`
	EnvironmentId               *string                       `json:"environmentId,omitempty"`
	NodeCount                   *int64                        `json:"nodeCount,omitempty"`
	PoolManagementEndpoint      *string                       `json:"poolManagementEndpoint,omitempty"`
	PoolManagementType          *PoolManagementType           `json:"poolManagementType,omitempty"`
	ProvisioningState           *SessionPoolProvisioningState `json:"provisioningState,omitempty"`
	ScaleConfiguration          *ScaleConfiguration           `json:"scaleConfiguration,omitempty"`
	Secrets                     *[]SessionPoolSecret          `json:"secrets,omitempty"`
	SessionNetworkConfiguration *SessionNetworkConfiguration  `json:"sessionNetworkConfiguration,omitempty"`
}

type SessionPoolProvisioningState 

type SessionPoolProvisioningState string
const (
	SessionPoolProvisioningStateCanceled   SessionPoolProvisioningState = "Canceled"
	SessionPoolProvisioningStateDeleting   SessionPoolProvisioningState = "Deleting"
	SessionPoolProvisioningStateFailed     SessionPoolProvisioningState = "Failed"
	SessionPoolProvisioningStateInProgress SessionPoolProvisioningState = "InProgress"
	SessionPoolProvisioningStateSucceeded  SessionPoolProvisioningState = "Succeeded"
)

func (*SessionPoolProvisioningState) UnmarshalJSON 

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

type SessionPoolSecret 

type SessionPoolSecret struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type SessionPoolUpdatableProperties 

type SessionPoolUpdatableProperties struct {
	Properties *SessionPoolUpdatablePropertiesProperties `json:"properties,omitempty"`
}

type SessionPoolUpdatablePropertiesProperties 

type SessionPoolUpdatablePropertiesProperties struct {
	CustomContainerTemplate     *CustomContainerTemplate     `json:"customContainerTemplate,omitempty"`
	DynamicPoolConfiguration    *DynamicPoolConfiguration    `json:"dynamicPoolConfiguration,omitempty"`
	ScaleConfiguration          *ScaleConfiguration          `json:"scaleConfiguration,omitempty"`
	Secrets                     *[]SessionPoolSecret         `json:"secrets,omitempty"`
	SessionNetworkConfiguration *SessionNetworkConfiguration `json:"sessionNetworkConfiguration,omitempty"`
}

type SessionRegistryCredentials 

type SessionRegistryCredentials struct {
	PasswordSecretRef *string `json:"passwordSecretRef,omitempty"`
	RegistryServer    *string `json:"registryServer,omitempty"`
	Username          *string `json:"username,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SessionPool
}

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.