containerapps

package
v0.20230103.1090844 Latest Latest
Warning

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

Go to latest
Published: Jan 3, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

The containerapps SDK allows for interaction with the Azure Resource Manager Service containerapps (API Version 2022-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/2022-03-01/containerapps"

Client Initialization

client := containerapps.NewContainerAppsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContainerAppsClient.CreateOrUpdate

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

payload := containerapps.ContainerApp{
	// ...
}


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

Example Usage: ContainerAppsClient.Delete

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

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

Example Usage: ContainerAppsClient.Get

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

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

ctx := context.TODO()
id := containerapps.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: ContainerAppsClient.ListBySubscription

ctx := context.TODO()
id := containerapps.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: ContainerAppsClient.ListCustomHostNameAnalysis

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

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

Example Usage: ContainerAppsClient.ListSecrets

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

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

Example Usage: ContainerAppsClient.Update

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

payload := containerapps.ContainerApp{
	// ...
}


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 PossibleValuesForActiveRevisionsMode

func PossibleValuesForActiveRevisionsMode() []string

func PossibleValuesForAppProtocol

func PossibleValuesForAppProtocol() []string

func PossibleValuesForBindingType

func PossibleValuesForBindingType() []string

func PossibleValuesForContainerAppProvisioningState

func PossibleValuesForContainerAppProvisioningState() []string

func PossibleValuesForDnsVerificationTestResult

func PossibleValuesForDnsVerificationTestResult() []string

func PossibleValuesForIngressTransportMethod

func PossibleValuesForIngressTransportMethod() []string

func PossibleValuesForScheme

func PossibleValuesForScheme() []string

func PossibleValuesForStorageType

func PossibleValuesForStorageType() []string

func PossibleValuesForType

func PossibleValuesForType() []string

func ValidateContainerAppID

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

ValidateContainerAppID checks that 'input' can be parsed as a Container App ID

Types

type ActiveRevisionsMode

type ActiveRevisionsMode string
const (
	ActiveRevisionsModeMultiple ActiveRevisionsMode = "Multiple"
	ActiveRevisionsModeSingle   ActiveRevisionsMode = "Single"
)

type AppProtocol

type AppProtocol string
const (
	AppProtocolGrpc AppProtocol = "grpc"
	AppProtocolHTTP AppProtocol = "http"
)

type BindingType

type BindingType string
const (
	BindingTypeDisabled   BindingType = "Disabled"
	BindingTypeSniEnabled BindingType = "SniEnabled"
)

type Configuration

type Configuration struct {
	ActiveRevisionsMode *ActiveRevisionsMode   `json:"activeRevisionsMode,omitempty"`
	Dapr                *Dapr                  `json:"dapr,omitempty"`
	Ingress             *Ingress               `json:"ingress,omitempty"`
	Registries          *[]RegistryCredentials `json:"registries,omitempty"`
	Secrets             *[]Secret              `json:"secrets,omitempty"`
}

type Container

type Container 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"`
	Probes       *[]ContainerAppProbe `json:"probes,omitempty"`
	Resources    *ContainerResources  `json:"resources,omitempty"`
	VolumeMounts *[]VolumeMount       `json:"volumeMounts,omitempty"`
}

type ContainerApp

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

type ContainerAppId

type ContainerAppId struct {
	SubscriptionId    string
	ResourceGroupName string
	ContainerAppName  string
}

ContainerAppId is a struct representing the Resource ID for a Container App

func NewContainerAppID

func NewContainerAppID(subscriptionId string, resourceGroupName string, containerAppName string) ContainerAppId

NewContainerAppID returns a new ContainerAppId struct

func ParseContainerAppID

func ParseContainerAppID(input string) (*ContainerAppId, error)

ParseContainerAppID parses 'input' into a ContainerAppId

func ParseContainerAppIDInsensitively

func ParseContainerAppIDInsensitively(input string) (*ContainerAppId, error)

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

func (ContainerAppId) ID

func (id ContainerAppId) ID() string

ID returns the formatted Container App ID

func (ContainerAppId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Container App ID

func (ContainerAppId) String

func (id ContainerAppId) String() string

String returns a human-readable description of this Container App ID

type ContainerAppOperationPredicate

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

func (ContainerAppOperationPredicate) Matches

type ContainerAppProbe

type ContainerAppProbe struct {
	FailureThreshold              *int64                      `json:"failureThreshold,omitempty"`
	HTTPGet                       *ContainerAppProbeHTTPGet   `json:"httpGet,omitempty"`
	InitialDelaySeconds           *int64                      `json:"initialDelaySeconds,omitempty"`
	PeriodSeconds                 *int64                      `json:"periodSeconds,omitempty"`
	SuccessThreshold              *int64                      `json:"successThreshold,omitempty"`
	TcpSocket                     *ContainerAppProbeTcpSocket `json:"tcpSocket,omitempty"`
	TerminationGracePeriodSeconds *int64                      `json:"terminationGracePeriodSeconds,omitempty"`
	TimeoutSeconds                *int64                      `json:"timeoutSeconds,omitempty"`
	Type                          *Type                       `json:"type,omitempty"`
}

type ContainerAppProbeHTTPGet added in v0.20220830.1105041

type ContainerAppProbeHTTPGet struct {
	HTTPHeaders *[]ContainerAppProbeHTTPGetHTTPHeadersInlined `json:"httpHeaders,omitempty"`
	Host        *string                                       `json:"host,omitempty"`
	Path        *string                                       `json:"path,omitempty"`
	Port        int64                                         `json:"port"`
	Scheme      *Scheme                                       `json:"scheme,omitempty"`
}

type ContainerAppProbeHTTPGetHTTPHeadersInlined added in v0.20220830.1105041

type ContainerAppProbeHTTPGetHTTPHeadersInlined struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type ContainerAppProbeTcpSocket

type ContainerAppProbeTcpSocket struct {
	Host *string `json:"host,omitempty"`
	Port int64   `json:"port"`
}

type ContainerAppProperties

type ContainerAppProperties struct {
	Configuration              *Configuration                 `json:"configuration,omitempty"`
	CustomDomainVerificationId *string                        `json:"customDomainVerificationId,omitempty"`
	LatestRevisionFqdn         *string                        `json:"latestRevisionFqdn,omitempty"`
	LatestRevisionName         *string                        `json:"latestRevisionName,omitempty"`
	ManagedEnvironmentId       *string                        `json:"managedEnvironmentId,omitempty"`
	OutboundIPAddresses        *[]string                      `json:"outboundIpAddresses,omitempty"`
	ProvisioningState          *ContainerAppProvisioningState `json:"provisioningState,omitempty"`
	Template                   *Template                      `json:"template,omitempty"`
}

type ContainerAppProvisioningState

type ContainerAppProvisioningState string
const (
	ContainerAppProvisioningStateCanceled   ContainerAppProvisioningState = "Canceled"
	ContainerAppProvisioningStateDeleting   ContainerAppProvisioningState = "Deleting"
	ContainerAppProvisioningStateFailed     ContainerAppProvisioningState = "Failed"
	ContainerAppProvisioningStateInProgress ContainerAppProvisioningState = "InProgress"
	ContainerAppProvisioningStateSucceeded  ContainerAppProvisioningState = "Succeeded"
)

type ContainerAppSecret

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

type ContainerAppsClient

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

func NewContainerAppsClientWithBaseURI

func NewContainerAppsClientWithBaseURI(endpoint string) ContainerAppsClient

func (ContainerAppsClient) CreateOrUpdate

CreateOrUpdate ...

func (ContainerAppsClient) CreateOrUpdateThenPoll

func (c ContainerAppsClient) CreateOrUpdateThenPoll(ctx context.Context, id ContainerAppId, input ContainerApp) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ContainerAppsClient) Delete

Delete ...

func (ContainerAppsClient) DeleteThenPoll

func (c ContainerAppsClient) DeleteThenPoll(ctx context.Context, id ContainerAppId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ContainerAppsClient) Get

Get ...

func (ContainerAppsClient) ListByResourceGroup

ListByResourceGroup ...

func (ContainerAppsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all of the results into a single object

func (ContainerAppsClient) ListByResourceGroupCompleteMatchingPredicate

func (c ContainerAppsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ContainerAppOperationPredicate) (resp ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ContainerAppsClient) ListBySubscription

ListBySubscription ...

func (ContainerAppsClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all of the results into a single object

func (ContainerAppsClient) ListBySubscriptionCompleteMatchingPredicate

func (c ContainerAppsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ContainerAppOperationPredicate) (resp ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ContainerAppsClient) ListCustomHostNameAnalysis

ListCustomHostNameAnalysis ...

func (ContainerAppsClient) ListSecrets

ListSecrets ...

func (ContainerAppsClient) Update

Update ...

func (ContainerAppsClient) UpdateThenPoll

func (c ContainerAppsClient) UpdateThenPoll(ctx context.Context, id ContainerAppId, input ContainerApp) error

UpdateThenPoll performs Update then polls until it's completed

type ContainerResources

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

type CreateOrUpdateOperationResponse

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

type CustomDomain

type CustomDomain struct {
	BindingType   *BindingType `json:"bindingType,omitempty"`
	CertificateId string       `json:"certificateId"`
	Name          string       `json:"name"`
}

type CustomHostnameAnalysisResult

type CustomHostnameAnalysisResult struct {
	ARecords                            *[]string                                                        `json:"aRecords,omitempty"`
	AlternateCNameRecords               *[]string                                                        `json:"alternateCNameRecords,omitempty"`
	AlternateTxtRecords                 *[]string                                                        `json:"alternateTxtRecords,omitempty"`
	CNameRecords                        *[]string                                                        `json:"cNameRecords,omitempty"`
	ConflictWithEnvironmentCustomDomain *bool                                                            `json:"conflictWithEnvironmentCustomDomain,omitempty"`
	ConflictingContainerAppResourceId   *string                                                          `json:"conflictingContainerAppResourceId,omitempty"`
	CustomDomainVerificationFailureInfo *CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo `json:"customDomainVerificationFailureInfo,omitempty"`
	CustomDomainVerificationTest        *DnsVerificationTestResult                                       `json:"customDomainVerificationTest,omitempty"`
	HasConflictOnManagedEnvironment     *bool                                                            `json:"hasConflictOnManagedEnvironment,omitempty"`
	HostName                            *string                                                          `json:"hostName,omitempty"`
	IsHostnameAlreadyVerified           *bool                                                            `json:"isHostnameAlreadyVerified,omitempty"`
	TxtRecords                          *[]string                                                        `json:"txtRecords,omitempty"`
}

type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo added in v0.20220809.1092704

type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo struct {
	Code    *string                                                                          `json:"code,omitempty"`
	Details *[]CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsInlined `json:"details,omitempty"`
	Message *string                                                                          `json:"message,omitempty"`
	Target  *string                                                                          `json:"target,omitempty"`
}

type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsInlined added in v0.20220809.1092704

type CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsInlined struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
	Target  *string `json:"target,omitempty"`
}

type CustomScaleRule

type CustomScaleRule struct {
	Auth     *[]ScaleRuleAuth   `json:"auth,omitempty"`
	Metadata *map[string]string `json:"metadata,omitempty"`
	Type     *string            `json:"type,omitempty"`
}

type Dapr

type Dapr struct {
	AppId       *string      `json:"appId,omitempty"`
	AppPort     *int64       `json:"appPort,omitempty"`
	AppProtocol *AppProtocol `json:"appProtocol,omitempty"`
	Enabled     *bool        `json:"enabled,omitempty"`
}

type DeleteOperationResponse

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

type DnsVerificationTestResult

type DnsVerificationTestResult string
const (
	DnsVerificationTestResultFailed  DnsVerificationTestResult = "Failed"
	DnsVerificationTestResultPassed  DnsVerificationTestResult = "Passed"
	DnsVerificationTestResultSkipped DnsVerificationTestResult = "Skipped"
)

type EnvironmentVar

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

type GetOperationResponse

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

type HTTPScaleRule added in v0.20220830.1105041

type HTTPScaleRule struct {
	Auth     *[]ScaleRuleAuth   `json:"auth,omitempty"`
	Metadata *map[string]string `json:"metadata,omitempty"`
}

type Ingress

type Ingress struct {
	AllowInsecure *bool                   `json:"allowInsecure,omitempty"`
	CustomDomains *[]CustomDomain         `json:"customDomains,omitempty"`
	External      *bool                   `json:"external,omitempty"`
	Fqdn          *string                 `json:"fqdn,omitempty"`
	TargetPort    *int64                  `json:"targetPort,omitempty"`
	Traffic       *[]TrafficWeight        `json:"traffic,omitempty"`
	Transport     *IngressTransportMethod `json:"transport,omitempty"`
}

type IngressTransportMethod

type IngressTransportMethod string
const (
	IngressTransportMethodAuto    IngressTransportMethod = "auto"
	IngressTransportMethodHTTP    IngressTransportMethod = "http"
	IngressTransportMethodHTTPTwo IngressTransportMethod = "http2"
)

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []ContainerApp
}

type ListByResourceGroupOperationResponse

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

func (ListByResourceGroupOperationResponse) HasMore

func (ListByResourceGroupOperationResponse) LoadMore

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []ContainerApp
}

type ListBySubscriptionOperationResponse

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

func (ListBySubscriptionOperationResponse) HasMore

func (ListBySubscriptionOperationResponse) LoadMore

type ListCustomHostNameAnalysisOperationOptions

type ListCustomHostNameAnalysisOperationOptions struct {
	CustomHostname *string
}

func DefaultListCustomHostNameAnalysisOperationOptions

func DefaultListCustomHostNameAnalysisOperationOptions() ListCustomHostNameAnalysisOperationOptions

type ListCustomHostNameAnalysisOperationResponse

type ListCustomHostNameAnalysisOperationResponse struct {
	HttpResponse *http.Response
	Model        *CustomHostnameAnalysisResult
}

type ListSecretsOperationResponse

type ListSecretsOperationResponse struct {
	HttpResponse *http.Response
	Model        *SecretsCollection
}

type QueueScaleRule

type QueueScaleRule struct {
	Auth        *[]ScaleRuleAuth `json:"auth,omitempty"`
	QueueLength *int64           `json:"queueLength,omitempty"`
	QueueName   *string          `json:"queueName,omitempty"`
}

type RegistryCredentials

type RegistryCredentials struct {
	Identity          *string `json:"identity,omitempty"`
	PasswordSecretRef *string `json:"passwordSecretRef,omitempty"`
	Server            *string `json:"server,omitempty"`
	Username          *string `json:"username,omitempty"`
}

type Scale

type Scale struct {
	MaxReplicas *int64       `json:"maxReplicas,omitempty"`
	MinReplicas *int64       `json:"minReplicas,omitempty"`
	Rules       *[]ScaleRule `json:"rules,omitempty"`
}

type ScaleRule

type ScaleRule struct {
	AzureQueue *QueueScaleRule  `json:"azureQueue,omitempty"`
	Custom     *CustomScaleRule `json:"custom,omitempty"`
	HTTP       *HTTPScaleRule   `json:"http,omitempty"`
	Name       *string          `json:"name,omitempty"`
}

type ScaleRuleAuth

type ScaleRuleAuth struct {
	SecretRef        *string `json:"secretRef,omitempty"`
	TriggerParameter *string `json:"triggerParameter,omitempty"`
}

type Scheme

type Scheme string
const (
	SchemeHTTP  Scheme = "HTTP"
	SchemeHTTPS Scheme = "HTTPS"
)

type Secret

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

type SecretsCollection

type SecretsCollection struct {
	Value []ContainerAppSecret `json:"value"`
}

type StorageType

type StorageType string
const (
	StorageTypeAzureFile StorageType = "AzureFile"
	StorageTypeEmptyDir  StorageType = "EmptyDir"
)

type Template

type Template struct {
	Containers     *[]Container `json:"containers,omitempty"`
	RevisionSuffix *string      `json:"revisionSuffix,omitempty"`
	Scale          *Scale       `json:"scale,omitempty"`
	Volumes        *[]Volume    `json:"volumes,omitempty"`
}

type TrafficWeight

type TrafficWeight struct {
	Label          *string `json:"label,omitempty"`
	LatestRevision *bool   `json:"latestRevision,omitempty"`
	RevisionName   *string `json:"revisionName,omitempty"`
	Weight         *int64  `json:"weight,omitempty"`
}

type Type

type Type string
const (
	TypeLiveness  Type = "Liveness"
	TypeReadiness Type = "Readiness"
	TypeStartup   Type = "Startup"
)

type UpdateOperationResponse

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

type Volume

type Volume struct {
	Name        *string      `json:"name,omitempty"`
	StorageName *string      `json:"storageName,omitempty"`
	StorageType *StorageType `json:"storageType,omitempty"`
}

type VolumeMount

type VolumeMount struct {
	MountPath  *string `json:"mountPath,omitempty"`
	VolumeName *string `json:"volumeName,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL