builders

package
v0.20241206.1180327 Latest Latest
Warning

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

 Go to latest Published: Dec 6, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

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

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

Client Initialization

client := builders.NewBuildersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BuildersClient.CreateOrUpdate

ctx := context.TODO()
id := builders.NewBuilderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "builderName")

payload := builders.BuilderResource{
	// ...
}


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

Example Usage: BuildersClient.Delete

ctx := context.TODO()
id := builders.NewBuilderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "builderName")

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

Example Usage: BuildersClient.Get

ctx := context.TODO()
id := builders.NewBuilderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "builderName")

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

ctx := context.TODO()
id := builders.NewBuilderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "builderName")

payload := builders.BuilderResourceUpdate{
	// ...
}


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 PossibleValuesForBuilderProvisioningState 

func PossibleValuesForBuilderProvisioningState() []string

func ValidateBuilderID 

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

ValidateBuilderID checks that 'input' can be parsed as a Builder ID

Types

type BuilderId 

type BuilderId struct {
	SubscriptionId    string
	ResourceGroupName string
	BuilderName       string
}

BuilderId is a struct representing the Resource ID for a Builder

func NewBuilderID 

func NewBuilderID(subscriptionId string, resourceGroupName string, builderName string) BuilderId

NewBuilderID returns a new BuilderId struct

func ParseBuilderID 

func ParseBuilderID(input string) (*BuilderId, error)

ParseBuilderID parses 'input' into a BuilderId

func ParseBuilderIDInsensitively 

func ParseBuilderIDInsensitively(input string) (*BuilderId, error)

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

func (*BuilderId) FromParseResult 

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

func (BuilderId) ID 

func (id BuilderId) ID() string

ID returns the formatted Builder ID

func (BuilderId) Segments 

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

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

func (BuilderId) String 

func (id BuilderId) String() string

String returns a human-readable description of this Builder ID

type BuilderProperties 

type BuilderProperties struct {
	ContainerRegistries *[]ContainerRegistry      `json:"containerRegistries,omitempty"`
	EnvironmentId       string                    `json:"environmentId"`
	ProvisioningState   *BuilderProvisioningState `json:"provisioningState,omitempty"`
}

type BuilderProvisioningState 

type BuilderProvisioningState string
const (
	BuilderProvisioningStateCanceled  BuilderProvisioningState = "Canceled"
	BuilderProvisioningStateCreating  BuilderProvisioningState = "Creating"
	BuilderProvisioningStateDeleting  BuilderProvisioningState = "Deleting"
	BuilderProvisioningStateFailed    BuilderProvisioningState = "Failed"
	BuilderProvisioningStateSucceeded BuilderProvisioningState = "Succeeded"
	BuilderProvisioningStateUpdating  BuilderProvisioningState = "Updating"
)

func (*BuilderProvisioningState) UnmarshalJSON 

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

type BuilderResource 

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

type BuilderResourceOperationPredicate 

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

func (BuilderResourceOperationPredicate) Matches 

func (p BuilderResourceOperationPredicate) Matches(input BuilderResource) bool

type BuilderResourceUpdate 

type BuilderResourceUpdate struct {
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Properties *BuilderResourceUpdateProperties         `json:"properties,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
}

type BuilderResourceUpdateProperties 

type BuilderResourceUpdateProperties struct {
	EnvironmentId *string `json:"environmentId,omitempty"`
}

type BuildersClient 

type BuildersClient struct {
	Client *resourcemanager.Client
}

func NewBuildersClientWithBaseURI 

func NewBuildersClientWithBaseURI(sdkApi sdkEnv.Api) (*BuildersClient, error)

func (BuildersClient) CreateOrUpdate 

func (c BuildersClient) CreateOrUpdate(ctx context.Context, id BuilderId, input BuilderResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (BuildersClient) CreateOrUpdateThenPoll 

func (c BuildersClient) CreateOrUpdateThenPoll(ctx context.Context, id BuilderId, input BuilderResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (BuildersClient) Delete 

func (c BuildersClient) Delete(ctx context.Context, id BuilderId) (result DeleteOperationResponse, err error)

Delete ...

func (BuildersClient) DeleteThenPoll 

func (c BuildersClient) DeleteThenPoll(ctx context.Context, id BuilderId) error

DeleteThenPoll performs Delete then polls until it's completed

func (BuildersClient) Get 

func (c BuildersClient) Get(ctx context.Context, id BuilderId) (result GetOperationResponse, err error)

Get ...

func (BuildersClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (BuildersClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (BuildersClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BuildersClient) ListBySubscription 

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

ListBySubscription ...

func (BuildersClient) ListBySubscriptionComplete 

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

ListBySubscriptionComplete retrieves all the results into a single object

func (BuildersClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BuildersClient) Update 

func (c BuildersClient) Update(ctx context.Context, id BuilderId, input BuilderResourceUpdate) (result UpdateOperationResponse, err error)

Update ...

func (BuildersClient) UpdateThenPoll 

func (c BuildersClient) UpdateThenPoll(ctx context.Context, id BuilderId, input BuilderResourceUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type ContainerRegistry 

type ContainerRegistry struct {
	ContainerRegistryServer string `json:"containerRegistryServer"`
	IdentityResourceId      string `json:"identityResourceId"`
}

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

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

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

type ListBySubscriptionCompleteResult 

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

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

type UpdateOperationResponse 

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

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.