containerappspatches

package
v0.20241126.2320 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

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

The containerappspatches 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-sdk/resource-manager/containerapps/2024-02-02-preview/containerappspatches"

Client Initialization

client := containerappspatches.NewContainerAppsPatchesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContainerAppsPatchesClient.Apply

ctx := context.TODO()
id := containerappspatches.NewPatchID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "patchName")

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

Example Usage: ContainerAppsPatchesClient.Delete

ctx := context.TODO()
id := containerappspatches.NewPatchID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "patchName")

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

Example Usage: ContainerAppsPatchesClient.Get

ctx := context.TODO()
id := containerappspatches.NewPatchID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "patchName")

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: ContainerAppsPatchesClient.ListByContainerApp

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

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

Example Usage: ContainerAppsPatchesClient.SkipConfigure

ctx := context.TODO()
id := containerappspatches.NewPatchID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "patchName")

payload := containerappspatches.PatchSkipConfig{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDetectionStatus 

func PossibleValuesForDetectionStatus() []string

func PossibleValuesForPatchApplyStatus 

func PossibleValuesForPatchApplyStatus() []string

func PossibleValuesForPatchType 

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

func ValidatePatchID 

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

ValidatePatchID checks that 'input' can be parsed as a Patch ID

Types

type ApplyOperationResponse 

type ApplyOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ContainerAppsPatchResource
}

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

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

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 ContainerAppsPatchResource 

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

type ContainerAppsPatchResourceOperationPredicate 

type ContainerAppsPatchResourceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ContainerAppsPatchResourceOperationPredicate) Matches 

func (p ContainerAppsPatchResourceOperationPredicate) Matches(input ContainerAppsPatchResource) bool

type ContainerAppsPatchesClient 

type ContainerAppsPatchesClient struct {
	Client *resourcemanager.Client
}

func NewContainerAppsPatchesClientWithBaseURI 

func NewContainerAppsPatchesClientWithBaseURI(sdkApi sdkEnv.Api) (*ContainerAppsPatchesClient, error)

func (ContainerAppsPatchesClient) Apply 

func (c ContainerAppsPatchesClient) Apply(ctx context.Context, id PatchId) (result ApplyOperationResponse, err error)

Apply ...

func (ContainerAppsPatchesClient) ApplyThenPoll 

func (c ContainerAppsPatchesClient) ApplyThenPoll(ctx context.Context, id PatchId) error

ApplyThenPoll performs Apply then polls until it's completed

func (ContainerAppsPatchesClient) Delete 

func (c ContainerAppsPatchesClient) Delete(ctx context.Context, id PatchId) (result DeleteOperationResponse, err error)

Delete ...

func (ContainerAppsPatchesClient) DeleteThenPoll 

func (c ContainerAppsPatchesClient) DeleteThenPoll(ctx context.Context, id PatchId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ContainerAppsPatchesClient) Get 

func (c ContainerAppsPatchesClient) Get(ctx context.Context, id PatchId) (result GetOperationResponse, err error)

Get ...

func (ContainerAppsPatchesClient) ListByContainerApp 

func (c ContainerAppsPatchesClient) ListByContainerApp(ctx context.Context, id ContainerAppId, options ListByContainerAppOperationOptions) (result ListByContainerAppOperationResponse, err error)

ListByContainerApp ...

func (ContainerAppsPatchesClient) ListByContainerAppComplete 

func (c ContainerAppsPatchesClient) ListByContainerAppComplete(ctx context.Context, id ContainerAppId, options ListByContainerAppOperationOptions) (ListByContainerAppCompleteResult, error)

ListByContainerAppComplete retrieves all the results into a single object

func (ContainerAppsPatchesClient) ListByContainerAppCompleteMatchingPredicate 

func (c ContainerAppsPatchesClient) ListByContainerAppCompleteMatchingPredicate(ctx context.Context, id ContainerAppId, options ListByContainerAppOperationOptions, predicate ContainerAppsPatchResourceOperationPredicate) (result ListByContainerAppCompleteResult, err error)

ListByContainerAppCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContainerAppsPatchesClient) SkipConfigure 

func (c ContainerAppsPatchesClient) SkipConfigure(ctx context.Context, id PatchId, input PatchSkipConfig) (result SkipConfigureOperationResponse, err error)

SkipConfigure ...

func (ContainerAppsPatchesClient) SkipConfigureThenPoll 

func (c ContainerAppsPatchesClient) SkipConfigureThenPoll(ctx context.Context, id PatchId, input PatchSkipConfig) error

SkipConfigureThenPoll performs SkipConfigure then polls until it's completed

type DeleteOperationResponse 

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

type DetectionStatus 

type DetectionStatus string
const (
	DetectionStatusFailed              DetectionStatus = "Failed"
	DetectionStatusRegistryLoginFailed DetectionStatus = "RegistryLoginFailed"
	DetectionStatusSucceeded           DetectionStatus = "Succeeded"
)

func (*DetectionStatus) UnmarshalJSON 

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

type GetOperationResponse 

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

type ListByContainerAppCompleteResult 

type ListByContainerAppCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ContainerAppsPatchResource
}

type ListByContainerAppCustomPager 

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

type ListByContainerAppOperationOptions 

type ListByContainerAppOperationOptions struct {
	Filter *string
}

func DefaultListByContainerAppOperationOptions 

func DefaultListByContainerAppOperationOptions() ListByContainerAppOperationOptions

func (ListByContainerAppOperationOptions) ToHeaders 

func (o ListByContainerAppOperationOptions) ToHeaders() *client.Headers

func (ListByContainerAppOperationOptions) ToOData 

func (o ListByContainerAppOperationOptions) ToOData() *odata.Query

func (ListByContainerAppOperationOptions) ToQuery 

func (o ListByContainerAppOperationOptions) ToQuery() *client.QueryParams

type ListByContainerAppOperationResponse 

type ListByContainerAppOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ContainerAppsPatchResource
}

type PatchApplyStatus 

type PatchApplyStatus string
const (
	PatchApplyStatusCanceled               PatchApplyStatus = "Canceled"
	PatchApplyStatusCreatingRevision       PatchApplyStatus = "CreatingRevision"
	PatchApplyStatusImagePushPullFailed    PatchApplyStatus = "ImagePushPullFailed"
	PatchApplyStatusManuallySkipped        PatchApplyStatus = "ManuallySkipped"
	PatchApplyStatusNotStarted             PatchApplyStatus = "NotStarted"
	PatchApplyStatusRebaseFailed           PatchApplyStatus = "RebaseFailed"
	PatchApplyStatusRebaseInProgress       PatchApplyStatus = "RebaseInProgress"
	PatchApplyStatusRevisionCreationFailed PatchApplyStatus = "RevisionCreationFailed"
	PatchApplyStatusSucceeded              PatchApplyStatus = "Succeeded"
)

func (*PatchApplyStatus) UnmarshalJSON 

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

type PatchDetails 

type PatchDetails struct {
	DetectionStatus     DetectionStatus       `json:"detectionStatus"`
	LastDetectionTime   string                `json:"lastDetectionTime"`
	NewImageName        *string               `json:"newImageName,omitempty"`
	NewLayer            *PatchDetailsNewLayer `json:"newLayer,omitempty"`
	OldLayer            *PatchDetailsOldLayer `json:"oldLayer,omitempty"`
	PatchType           *PatchType            `json:"patchType,omitempty"`
	TargetContainerName string                `json:"targetContainerName"`
	TargetImage         string                `json:"targetImage"`
}

func (*PatchDetails) GetLastDetectionTimeAsTime 

func (o *PatchDetails) GetLastDetectionTimeAsTime() (*time.Time, error)

func (*PatchDetails) SetLastDetectionTimeAsTime 

func (o *PatchDetails) SetLastDetectionTimeAsTime(input time.Time)

type PatchDetailsNewLayer 

type PatchDetailsNewLayer struct {
	FrameworkAndVersion *string `json:"frameworkAndVersion,omitempty"`
	Name                *string `json:"name,omitempty"`
	OsAndVersion        *string `json:"osAndVersion,omitempty"`
}

type PatchDetailsOldLayer 

type PatchDetailsOldLayer struct {
	FrameworkAndVersion *string `json:"frameworkAndVersion,omitempty"`
	Name                *string `json:"name,omitempty"`
	OsAndVersion        *string `json:"osAndVersion,omitempty"`
}

type PatchId 

type PatchId struct {
	SubscriptionId    string
	ResourceGroupName string
	ContainerAppName  string
	PatchName         string
}

PatchId is a struct representing the Resource ID for a Patch

func NewPatchID 

func NewPatchID(subscriptionId string, resourceGroupName string, containerAppName string, patchName string) PatchId

NewPatchID returns a new PatchId struct

func ParsePatchID 

func ParsePatchID(input string) (*PatchId, error)

ParsePatchID parses 'input' into a PatchId

func ParsePatchIDInsensitively 

func ParsePatchIDInsensitively(input string) (*PatchId, error)

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

func (*PatchId) FromParseResult 

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

func (PatchId) ID 

func (id PatchId) ID() string

ID returns the formatted Patch ID

func (PatchId) Segments 

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

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

func (PatchId) String 

func (id PatchId) String() string

String returns a human-readable description of this Patch ID

type PatchProperties 

type PatchProperties struct {
	CreatedAt            *string           `json:"createdAt,omitempty"`
	LastModifiedAt       *string           `json:"lastModifiedAt,omitempty"`
	PatchApplyStatus     *PatchApplyStatus `json:"patchApplyStatus,omitempty"`
	PatchDetails         *[]PatchDetails   `json:"patchDetails,omitempty"`
	TargetContainerAppId *string           `json:"targetContainerAppId,omitempty"`
	TargetEnvironmentId  *string           `json:"targetEnvironmentId,omitempty"`
	TargetRevisionId     *string           `json:"targetRevisionId,omitempty"`
}

func (*PatchProperties) GetCreatedAtAsTime 

func (o *PatchProperties) GetCreatedAtAsTime() (*time.Time, error)

func (*PatchProperties) GetLastModifiedAtAsTime 

func (o *PatchProperties) GetLastModifiedAtAsTime() (*time.Time, error)

func (*PatchProperties) SetCreatedAtAsTime 

func (o *PatchProperties) SetCreatedAtAsTime(input time.Time)

func (*PatchProperties) SetLastModifiedAtAsTime 

func (o *PatchProperties) SetLastModifiedAtAsTime(input time.Time)

type PatchSkipConfig 

type PatchSkipConfig struct {
	Skip *bool `json:"skip,omitempty"`
}

type PatchType 

type PatchType string
const (
	PatchTypeFrameworkAndOSSecurity PatchType = "FrameworkAndOSSecurity"
	PatchTypeFrameworkSecurity      PatchType = "FrameworkSecurity"
	PatchTypeOSSecurity             PatchType = "OSSecurity"
	PatchTypeOther                  PatchType = "Other"
)

func (*PatchType) UnmarshalJSON 

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

type SkipConfigureOperationResponse 

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

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.