containerappssourcecontrols

package
v0.20241029.1112340 Latest Latest
Warning

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

 Go to latest Published: Oct 29, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

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

The containerappssourcecontrols 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/containerappssourcecontrols"

Client Initialization

client := containerappssourcecontrols.NewContainerAppsSourceControlsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContainerAppsSourceControlsClient.CreateOrUpdate

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

payload := containerappssourcecontrols.SourceControl{
	// ...
}


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

Example Usage: ContainerAppsSourceControlsClient.Delete

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

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

Example Usage: ContainerAppsSourceControlsClient.Get

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

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForSourceControlOperationState 

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

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

ValidateSourceControlID checks that 'input' can be parsed as a Source Control ID

Types

type AzureCredentials 

type AzureCredentials struct {
	ClientId       *string `json:"clientId,omitempty"`
	ClientSecret   *string `json:"clientSecret,omitempty"`
	Kind           *string `json:"kind,omitempty"`
	SubscriptionId *string `json:"subscriptionId,omitempty"`
	TenantId       *string `json:"tenantId,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) 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 ContainerAppsSourceControlsClient 

type ContainerAppsSourceControlsClient struct {
	Client *resourcemanager.Client
}

func NewContainerAppsSourceControlsClientWithBaseURI 

func NewContainerAppsSourceControlsClientWithBaseURI(sdkApi sdkEnv.Api) (*ContainerAppsSourceControlsClient, error)

func (ContainerAppsSourceControlsClient) CreateOrUpdate 

func (c ContainerAppsSourceControlsClient) CreateOrUpdate(ctx context.Context, id SourceControlId, input SourceControl, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ContainerAppsSourceControlsClient) CreateOrUpdateThenPoll 

func (c ContainerAppsSourceControlsClient) CreateOrUpdateThenPoll(ctx context.Context, id SourceControlId, input SourceControl, options CreateOrUpdateOperationOptions) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ContainerAppsSourceControlsClient) Delete 

func (c ContainerAppsSourceControlsClient) Delete(ctx context.Context, id SourceControlId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (ContainerAppsSourceControlsClient) DeleteThenPoll 

func (c ContainerAppsSourceControlsClient) DeleteThenPoll(ctx context.Context, id SourceControlId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (ContainerAppsSourceControlsClient) Get 

func (c ContainerAppsSourceControlsClient) Get(ctx context.Context, id SourceControlId) (result GetOperationResponse, err error)

Get ...

func (ContainerAppsSourceControlsClient) ListByContainerApp 

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

ListByContainerApp ...

func (ContainerAppsSourceControlsClient) ListByContainerAppComplete 

func (c ContainerAppsSourceControlsClient) ListByContainerAppComplete(ctx context.Context, id ContainerAppId) (ListByContainerAppCompleteResult, error)

ListByContainerAppComplete retrieves all the results into a single object

func (ContainerAppsSourceControlsClient) ListByContainerAppCompleteMatchingPredicate 

func (c ContainerAppsSourceControlsClient) ListByContainerAppCompleteMatchingPredicate(ctx context.Context, id ContainerAppId, predicate SourceControlOperationPredicate) (result ListByContainerAppCompleteResult, err error)

ListByContainerAppCompleteMatchingPredicate retrieves all the results and then applies the predicate

type CreateOrUpdateOperationOptions added in v0.20240819.1075239 

type CreateOrUpdateOperationOptions struct {
	XMsGitHubAuxiliary *string
}

func DefaultCreateOrUpdateOperationOptions added in v0.20240819.1075239 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders added in v0.20240819.1075239 

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

func (CreateOrUpdateOperationOptions) ToOData added in v0.20240819.1075239 

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

func (CreateOrUpdateOperationOptions) ToQuery added in v0.20240819.1075239 

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

type CreateOrUpdateOperationResponse 

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

type DeleteOperationOptions added in v0.20240819.1075239 

type DeleteOperationOptions struct {
	DeleteWorkflow                *bool
	IgnoreWorkflowDeletionFailure *bool
	XMsGitHubAuxiliary            *string
}

func DefaultDeleteOperationOptions added in v0.20240819.1075239 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders added in v0.20240819.1075239 

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

func (DeleteOperationOptions) ToOData added in v0.20240819.1075239 

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

func (DeleteOperationOptions) ToQuery added in v0.20240819.1075239 

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

type DeleteOperationResponse 

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

type EnvironmentVariable 

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

type GetOperationResponse 

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

type GithubActionConfiguration 

type GithubActionConfiguration struct {
	AzureCredentials          *AzureCredentials      `json:"azureCredentials,omitempty"`
	BuildEnvironmentVariables *[]EnvironmentVariable `json:"buildEnvironmentVariables,omitempty"`
	ContextPath               *string                `json:"contextPath,omitempty"`
	GitHubPersonalAccessToken *string                `json:"githubPersonalAccessToken,omitempty"`
	Image                     *string                `json:"image,omitempty"`
	Os                        *string                `json:"os,omitempty"`
	PublishType               *string                `json:"publishType,omitempty"`
	RegistryInfo              *RegistryInfo          `json:"registryInfo,omitempty"`
	RuntimeStack              *string                `json:"runtimeStack,omitempty"`
	RuntimeVersion            *string                `json:"runtimeVersion,omitempty"`
}

type ListByContainerAppCompleteResult 

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

type ListByContainerAppCustomPager 

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

type ListByContainerAppOperationResponse 

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

type RegistryInfo 

type RegistryInfo struct {
	RegistryPassword *string `json:"registryPassword,omitempty"`
	RegistryURL      *string `json:"registryUrl,omitempty"`
	RegistryUserName *string `json:"registryUserName,omitempty"`
}

type SourceControl 

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

type SourceControlId 

type SourceControlId struct {
	SubscriptionId    string
	ResourceGroupName string
	ContainerAppName  string
	SourceControlName string
}

SourceControlId is a struct representing the Resource ID for a Source Control

func NewSourceControlID 

func NewSourceControlID(subscriptionId string, resourceGroupName string, containerAppName string, sourceControlName string) SourceControlId

NewSourceControlID returns a new SourceControlId struct

func ParseSourceControlID 

func ParseSourceControlID(input string) (*SourceControlId, error)

ParseSourceControlID parses 'input' into a SourceControlId

func ParseSourceControlIDInsensitively 

func ParseSourceControlIDInsensitively(input string) (*SourceControlId, error)

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

func (*SourceControlId) FromParseResult 

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

func (SourceControlId) ID 

func (id SourceControlId) ID() string

ID returns the formatted Source Control ID

func (SourceControlId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Source Control ID

func (SourceControlId) String 

func (id SourceControlId) String() string

String returns a human-readable description of this Source Control ID

type SourceControlOperationPredicate 

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

func (SourceControlOperationPredicate) Matches 

func (p SourceControlOperationPredicate) Matches(input SourceControl) bool

type SourceControlOperationState 

type SourceControlOperationState string
const (
	SourceControlOperationStateCanceled   SourceControlOperationState = "Canceled"
	SourceControlOperationStateFailed     SourceControlOperationState = "Failed"
	SourceControlOperationStateInProgress SourceControlOperationState = "InProgress"
	SourceControlOperationStateSucceeded  SourceControlOperationState = "Succeeded"
)

func (*SourceControlOperationState) UnmarshalJSON 

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

type SourceControlProperties 

type SourceControlProperties struct {
	Branch                    *string                      `json:"branch,omitempty"`
	GitHubActionConfiguration *GithubActionConfiguration   `json:"githubActionConfiguration,omitempty"`
	OperationState            *SourceControlOperationState `json:"operationState,omitempty"`
	RepoURL                   *string                      `json:"repoUrl,omitempty"`
}

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.