containerappsrevisionreplicas

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2024-03-01/containerappsrevisionreplicas Documentation

The containerappsrevisionreplicas SDK allows for interaction with the Azure Resource Manager Service containerapps (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-sdk/resource-manager/containerapps/2024-03-01/containerappsrevisionreplicas"

Client Initialization

client := containerappsrevisionreplicas.NewContainerAppsRevisionReplicasClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContainerAppsRevisionReplicasClient.GetReplica

ctx := context.TODO()
id := containerappsrevisionreplicas.NewReplicaID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppValue", "revisionValue", "replicaValue")

read, err := client.GetReplica(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContainerAppsRevisionReplicasClient.ListReplicas

ctx := context.TODO()
id := containerappsrevisionreplicas.NewRevisionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppValue", "revisionValue")

read, err := client.ListReplicas(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func PossibleValuesForContainerAppContainerRunningState() []string
• func PossibleValuesForContainerAppReplicaRunningState() []string
• func ValidateReplicaID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateRevisionID(input interface{}, key string) (warnings []string, errors []error)
• type ContainerAppContainerRunningState
  • func (s *ContainerAppContainerRunningState) UnmarshalJSON(bytes []byte) error
• type ContainerAppReplicaRunningState
  • func (s *ContainerAppReplicaRunningState) UnmarshalJSON(bytes []byte) error
• type ContainerAppsRevisionReplicasClient
  • func NewContainerAppsRevisionReplicasClientWithBaseURI(sdkApi sdkEnv.Api) (*ContainerAppsRevisionReplicasClient, error)
  • func (c ContainerAppsRevisionReplicasClient) GetReplica(ctx context.Context, id ReplicaId) (result GetReplicaOperationResponse, err error)
  • func (c ContainerAppsRevisionReplicasClient) ListReplicas(ctx context.Context, id RevisionId) (result ListReplicasOperationResponse, err error)
• type GetReplicaOperationResponse
• type ListReplicasOperationResponse
• type Replica
• type ReplicaCollection
• type ReplicaContainer
• type ReplicaId
  • func NewReplicaID(subscriptionId string, resourceGroupName string, containerAppName string, ...) ReplicaId
  • func ParseReplicaID(input string) (*ReplicaId, error)
  • func ParseReplicaIDInsensitively(input string) (*ReplicaId, error)
  • func (id *ReplicaId) FromParseResult(input resourceids.ParseResult) error
  • func (id ReplicaId) ID() string
  • func (id ReplicaId) Segments() []resourceids.Segment
  • func (id ReplicaId) String() string
• type ReplicaProperties
  • func (o *ReplicaProperties) GetCreatedTimeAsTime() (*time.Time, error)
  • func (o *ReplicaProperties) SetCreatedTimeAsTime(input time.Time)
• type RevisionId
  • func NewRevisionID(subscriptionId string, resourceGroupName string, containerAppName string, ...) RevisionId
  • func ParseRevisionID(input string) (*RevisionId, error)
  • func ParseRevisionIDInsensitively(input string) (*RevisionId, error)
  • func (id *RevisionId) FromParseResult(input resourceids.ParseResult) error
  • func (id RevisionId) ID() string
  • func (id RevisionId) Segments() []resourceids.Segment
  • func (id RevisionId) String() string

Functions

func PossibleValuesForContainerAppContainerRunningState

func PossibleValuesForContainerAppContainerRunningState() []string

func PossibleValuesForContainerAppReplicaRunningState

func PossibleValuesForContainerAppReplicaRunningState() []string

func ValidateReplicaID

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

ValidateReplicaID checks that 'input' can be parsed as a Replica ID

func ValidateRevisionID

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

ValidateRevisionID checks that 'input' can be parsed as a Revision ID

Types

type ContainerAppContainerRunningState

type ContainerAppContainerRunningState string

const (
	ContainerAppContainerRunningStateRunning    ContainerAppContainerRunningState = "Running"
	ContainerAppContainerRunningStateTerminated ContainerAppContainerRunningState = "Terminated"
	ContainerAppContainerRunningStateWaiting    ContainerAppContainerRunningState = "Waiting"
)

func (*ContainerAppContainerRunningState) UnmarshalJSON

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

type ContainerAppReplicaRunningState

type ContainerAppReplicaRunningState string

const (
	ContainerAppReplicaRunningStateNotRunning ContainerAppReplicaRunningState = "NotRunning"
	ContainerAppReplicaRunningStateRunning    ContainerAppReplicaRunningState = "Running"
	ContainerAppReplicaRunningStateUnknown    ContainerAppReplicaRunningState = "Unknown"
)

func (*ContainerAppReplicaRunningState) UnmarshalJSON

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

type ContainerAppsRevisionReplicasClient

type ContainerAppsRevisionReplicasClient struct {
	Client *resourcemanager.Client
}

func NewContainerAppsRevisionReplicasClientWithBaseURI

func NewContainerAppsRevisionReplicasClientWithBaseURI(sdkApi sdkEnv.Api) (*ContainerAppsRevisionReplicasClient, error)

func (ContainerAppsRevisionReplicasClient) GetReplica

func (c ContainerAppsRevisionReplicasClient) GetReplica(ctx context.Context, id ReplicaId) (result GetReplicaOperationResponse, err error)

GetReplica ...

func (ContainerAppsRevisionReplicasClient) ListReplicas

func (c ContainerAppsRevisionReplicasClient) ListReplicas(ctx context.Context, id RevisionId) (result ListReplicasOperationResponse, err error)

ListReplicas ...

type GetReplicaOperationResponse

type GetReplicaOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Replica
}

type ListReplicasOperationResponse

type ListReplicasOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ReplicaCollection
}

type Replica

type Replica struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *ReplicaProperties     `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type ReplicaCollection

type ReplicaCollection struct {
	Value []Replica `json:"value"`
}

type ReplicaContainer

type ReplicaContainer struct {
	ContainerId         *string                            `json:"containerId,omitempty"`
	ExecEndpoint        *string                            `json:"execEndpoint,omitempty"`
	LogStreamEndpoint   *string                            `json:"logStreamEndpoint,omitempty"`
	Name                *string                            `json:"name,omitempty"`
	Ready               *bool                              `json:"ready,omitempty"`
	RestartCount        *int64                             `json:"restartCount,omitempty"`
	RunningState        *ContainerAppContainerRunningState `json:"runningState,omitempty"`
	RunningStateDetails *string                            `json:"runningStateDetails,omitempty"`
	Started             *bool                              `json:"started,omitempty"`
}

type ReplicaId

type ReplicaId struct {
	SubscriptionId    string
	ResourceGroupName string
	ContainerAppName  string
	RevisionName      string
	ReplicaName       string
}

ReplicaId is a struct representing the Resource ID for a Replica

func NewReplicaID

func NewReplicaID(subscriptionId string, resourceGroupName string, containerAppName string, revisionName string, replicaName string) ReplicaId

NewReplicaID returns a new ReplicaId struct

func ParseReplicaID

func ParseReplicaID(input string) (*ReplicaId, error)

ParseReplicaID parses 'input' into a ReplicaId

func ParseReplicaIDInsensitively

func ParseReplicaIDInsensitively(input string) (*ReplicaId, error)

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

func (*ReplicaId) FromParseResult

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

func (ReplicaId) ID

func (id ReplicaId) ID() string

ID returns the formatted Replica ID

func (ReplicaId) Segments

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

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

func (ReplicaId) String

func (id ReplicaId) String() string

String returns a human-readable description of this Replica ID

type ReplicaProperties

type ReplicaProperties struct {
	Containers          *[]ReplicaContainer              `json:"containers,omitempty"`
	CreatedTime         *string                          `json:"createdTime,omitempty"`
	InitContainers      *[]ReplicaContainer              `json:"initContainers,omitempty"`
	RunningState        *ContainerAppReplicaRunningState `json:"runningState,omitempty"`
	RunningStateDetails *string                          `json:"runningStateDetails,omitempty"`
}

func (*ReplicaProperties) GetCreatedTimeAsTime

func (o *ReplicaProperties) GetCreatedTimeAsTime() (*time.Time, error)

func (*ReplicaProperties) SetCreatedTimeAsTime

func (o *ReplicaProperties) SetCreatedTimeAsTime(input time.Time)

type RevisionId

type RevisionId struct {
	SubscriptionId    string
	ResourceGroupName string
	ContainerAppName  string
	RevisionName      string
}

RevisionId is a struct representing the Resource ID for a Revision

func NewRevisionID

func NewRevisionID(subscriptionId string, resourceGroupName string, containerAppName string, revisionName string) RevisionId

NewRevisionID returns a new RevisionId struct

func ParseRevisionID

func ParseRevisionID(input string) (*RevisionId, error)

ParseRevisionID parses 'input' into a RevisionId

func ParseRevisionIDInsensitively

func ParseRevisionIDInsensitively(input string) (*RevisionId, error)

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

func (*RevisionId) FromParseResult

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

func (RevisionId) ID

func (id RevisionId) ID() string

ID returns the formatted Revision ID

func (RevisionId) Segments

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

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

func (RevisionId) String

func (id RevisionId) String() string

String returns a human-readable description of this Revision ID