dotnetcomponents

package
v0.20241004.1180715 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := dotnetcomponents.NewDotNetComponentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DotNetComponentsClient.CreateOrUpdate

ctx := context.TODO()
id := dotnetcomponents.NewDotNetComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentName", "name")

payload := dotnetcomponents.DotNetComponent{
	// ...
}


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

Example Usage: DotNetComponentsClient.Delete

ctx := context.TODO()
id := dotnetcomponents.NewDotNetComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentName", "name")

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

Example Usage: DotNetComponentsClient.Get

ctx := context.TODO()
id := dotnetcomponents.NewDotNetComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentName", "name")

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: DotNetComponentsClient.List

ctx := context.TODO()
id := dotnetcomponents.NewManagedEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentName")

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

Example Usage: DotNetComponentsClient.Update

ctx := context.TODO()
id := dotnetcomponents.NewDotNetComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentName", "name")

payload := dotnetcomponents.DotNetComponent{
	// ...
}


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 PossibleValuesForDotNetComponentProvisioningState 

func PossibleValuesForDotNetComponentProvisioningState() []string

func PossibleValuesForDotNetComponentType 

func PossibleValuesForDotNetComponentType() []string

func ValidateDotNetComponentID 

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

ValidateDotNetComponentID checks that 'input' can be parsed as a Dot Net Component ID

func ValidateManagedEnvironmentID 

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

ValidateManagedEnvironmentID checks that 'input' can be parsed as a Managed Environment ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type DotNetComponent 

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

type DotNetComponentConfigurationProperty 

type DotNetComponentConfigurationProperty struct {
	PropertyName *string `json:"propertyName,omitempty"`
	Value        *string `json:"value,omitempty"`
}

type DotNetComponentId 

type DotNetComponentId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ManagedEnvironmentName string
	DotNetComponentName    string
}

DotNetComponentId is a struct representing the Resource ID for a Dot Net Component

func NewDotNetComponentID 

func NewDotNetComponentID(subscriptionId string, resourceGroupName string, managedEnvironmentName string, dotNetComponentName string) DotNetComponentId

NewDotNetComponentID returns a new DotNetComponentId struct

func ParseDotNetComponentID 

func ParseDotNetComponentID(input string) (*DotNetComponentId, error)

ParseDotNetComponentID parses 'input' into a DotNetComponentId

func ParseDotNetComponentIDInsensitively 

func ParseDotNetComponentIDInsensitively(input string) (*DotNetComponentId, error)

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

func (*DotNetComponentId) FromParseResult 

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

func (DotNetComponentId) ID 

func (id DotNetComponentId) ID() string

ID returns the formatted Dot Net Component ID

func (DotNetComponentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Dot Net Component ID

func (DotNetComponentId) String 

func (id DotNetComponentId) String() string

String returns a human-readable description of this Dot Net Component ID

type DotNetComponentOperationPredicate 

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

func (DotNetComponentOperationPredicate) Matches 

func (p DotNetComponentOperationPredicate) Matches(input DotNetComponent) bool

type DotNetComponentProperties 

type DotNetComponentProperties struct {
	ComponentType     *DotNetComponentType                    `json:"componentType,omitempty"`
	Configurations    *[]DotNetComponentConfigurationProperty `json:"configurations,omitempty"`
	ProvisioningState *DotNetComponentProvisioningState       `json:"provisioningState,omitempty"`
	ServiceBinds      *[]DotNetComponentServiceBind           `json:"serviceBinds,omitempty"`
}

type DotNetComponentProvisioningState 

type DotNetComponentProvisioningState string
const (
	DotNetComponentProvisioningStateCanceled   DotNetComponentProvisioningState = "Canceled"
	DotNetComponentProvisioningStateDeleting   DotNetComponentProvisioningState = "Deleting"
	DotNetComponentProvisioningStateFailed     DotNetComponentProvisioningState = "Failed"
	DotNetComponentProvisioningStateInProgress DotNetComponentProvisioningState = "InProgress"
	DotNetComponentProvisioningStateSucceeded  DotNetComponentProvisioningState = "Succeeded"
)

func (*DotNetComponentProvisioningState) UnmarshalJSON 

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

type DotNetComponentServiceBind 

type DotNetComponentServiceBind struct {
	Name      *string `json:"name,omitempty"`
	ServiceId *string `json:"serviceId,omitempty"`
}

type DotNetComponentType 

type DotNetComponentType string
const (
	DotNetComponentTypeAspireDashboard DotNetComponentType = "AspireDashboard"
)

func (*DotNetComponentType) UnmarshalJSON 

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

type DotNetComponentsClient 

type DotNetComponentsClient struct {
	Client *resourcemanager.Client
}

func NewDotNetComponentsClientWithBaseURI 

func NewDotNetComponentsClientWithBaseURI(sdkApi sdkEnv.Api) (*DotNetComponentsClient, error)

func (DotNetComponentsClient) CreateOrUpdate 

func (c DotNetComponentsClient) CreateOrUpdate(ctx context.Context, id DotNetComponentId, input DotNetComponent) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DotNetComponentsClient) CreateOrUpdateThenPoll 

func (c DotNetComponentsClient) CreateOrUpdateThenPoll(ctx context.Context, id DotNetComponentId, input DotNetComponent) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DotNetComponentsClient) Delete 

func (c DotNetComponentsClient) Delete(ctx context.Context, id DotNetComponentId) (result DeleteOperationResponse, err error)

Delete ...

func (DotNetComponentsClient) DeleteThenPoll 

func (c DotNetComponentsClient) DeleteThenPoll(ctx context.Context, id DotNetComponentId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DotNetComponentsClient) Get 

func (c DotNetComponentsClient) Get(ctx context.Context, id DotNetComponentId) (result GetOperationResponse, err error)

Get ...

func (DotNetComponentsClient) List 

func (c DotNetComponentsClient) List(ctx context.Context, id ManagedEnvironmentId) (result ListOperationResponse, err error)

List ...

func (DotNetComponentsClient) ListComplete 

func (c DotNetComponentsClient) ListComplete(ctx context.Context, id ManagedEnvironmentId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (DotNetComponentsClient) ListCompleteMatchingPredicate 

func (c DotNetComponentsClient) ListCompleteMatchingPredicate(ctx context.Context, id ManagedEnvironmentId, predicate DotNetComponentOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DotNetComponentsClient) Update 

func (c DotNetComponentsClient) Update(ctx context.Context, id DotNetComponentId, input DotNetComponent) (result UpdateOperationResponse, err error)

Update ...

func (DotNetComponentsClient) UpdateThenPoll 

func (c DotNetComponentsClient) UpdateThenPoll(ctx context.Context, id DotNetComponentId, input DotNetComponent) error

UpdateThenPoll performs Update then polls until it's completed

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DotNetComponent
}

type ListCustomPager 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DotNetComponent
}

type ManagedEnvironmentId 

type ManagedEnvironmentId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ManagedEnvironmentName string
}

ManagedEnvironmentId is a struct representing the Resource ID for a Managed Environment

func NewManagedEnvironmentID 

func NewManagedEnvironmentID(subscriptionId string, resourceGroupName string, managedEnvironmentName string) ManagedEnvironmentId

NewManagedEnvironmentID returns a new ManagedEnvironmentId struct

func ParseManagedEnvironmentID 

func ParseManagedEnvironmentID(input string) (*ManagedEnvironmentId, error)

ParseManagedEnvironmentID parses 'input' into a ManagedEnvironmentId

func ParseManagedEnvironmentIDInsensitively 

func ParseManagedEnvironmentIDInsensitively(input string) (*ManagedEnvironmentId, error)

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

func (*ManagedEnvironmentId) FromParseResult 

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

func (ManagedEnvironmentId) ID 

func (id ManagedEnvironmentId) ID() string

ID returns the formatted Managed Environment ID

func (ManagedEnvironmentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Managed Environment ID

func (ManagedEnvironmentId) String 

func (id ManagedEnvironmentId) String() string

String returns a human-readable description of this Managed Environment ID

type UpdateOperationResponse 

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

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.