managedenvironments

package
v0.20220901.1111930 Latest Latest
Warning

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

Go to latest
Published: Sep 1, 2022 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

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

Client Initialization

client := managedenvironments.NewManagedEnvironmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedEnvironmentsClient.CertificatesCreateOrUpdate

ctx := context.TODO()
id := managedenvironments.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue", "certificateValue")

payload := managedenvironments.Certificate{
	// ...
}


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

Example Usage: ManagedEnvironmentsClient.CertificatesDelete

ctx := context.TODO()
id := managedenvironments.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue", "certificateValue")

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

Example Usage: ManagedEnvironmentsClient.CertificatesGet

ctx := context.TODO()
id := managedenvironments.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue", "certificateValue")

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

Example Usage: ManagedEnvironmentsClient.CertificatesList

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

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

Example Usage: ManagedEnvironmentsClient.CertificatesUpdate

ctx := context.TODO()
id := managedenvironments.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "environmentValue", "certificateValue")

payload := managedenvironments.CertificatePatch{
	// ...
}


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

Example Usage: ManagedEnvironmentsClient.CreateOrUpdate

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

payload := managedenvironments.ManagedEnvironment{
	// ...
}


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

Example Usage: ManagedEnvironmentsClient.Delete

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

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

Example Usage: ManagedEnvironmentsClient.Get

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

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

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

ctx := context.TODO()
id := managedenvironments.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: ManagedEnvironmentsClient.NamespacesCheckNameAvailability

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

payload := managedenvironments.CheckNameAvailabilityRequest{
	// ...
}


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

Example Usage: ManagedEnvironmentsClient.Update

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

payload := managedenvironments.ManagedEnvironment{
	// ...
}


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 PossibleValuesForCertificateProvisioningState

func PossibleValuesForCertificateProvisioningState() []string

func PossibleValuesForCheckNameAvailabilityReason

func PossibleValuesForCheckNameAvailabilityReason() []string

func PossibleValuesForEnvironmentProvisioningState

func PossibleValuesForEnvironmentProvisioningState() []string

func ValidateCertificateID

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

ValidateCertificateID checks that 'input' can be parsed as a Certificate 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 AppLogsConfiguration

type AppLogsConfiguration struct {
	Destination               *string                    `json:"destination,omitempty"`
	LogAnalyticsConfiguration *LogAnalyticsConfiguration `json:"logAnalyticsConfiguration,omitempty"`
}

type Certificate

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

type CertificateId

type CertificateId struct {
	SubscriptionId    string
	ResourceGroupName string
	EnvironmentName   string
	CertificateName   string
}

CertificateId is a struct representing the Resource ID for a Certificate

func NewCertificateID

func NewCertificateID(subscriptionId string, resourceGroupName string, environmentName string, certificateName string) CertificateId

NewCertificateID returns a new CertificateId struct

func ParseCertificateID

func ParseCertificateID(input string) (*CertificateId, error)

ParseCertificateID parses 'input' into a CertificateId

func ParseCertificateIDInsensitively

func ParseCertificateIDInsensitively(input string) (*CertificateId, error)

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

func (CertificateId) ID

func (id CertificateId) ID() string

ID returns the formatted Certificate ID

func (CertificateId) Segments

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

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

func (CertificateId) String

func (id CertificateId) String() string

String returns a human-readable description of this Certificate ID

type CertificateOperationPredicate

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

func (CertificateOperationPredicate) Matches

type CertificatePatch

type CertificatePatch struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type CertificateProperties

type CertificateProperties struct {
	ExpirationDate    *string                       `json:"expirationDate,omitempty"`
	IssueDate         *string                       `json:"issueDate,omitempty"`
	Issuer            *string                       `json:"issuer,omitempty"`
	Password          *string                       `json:"password,omitempty"`
	ProvisioningState *CertificateProvisioningState `json:"provisioningState,omitempty"`
	PublicKeyHash     *string                       `json:"publicKeyHash,omitempty"`
	SubjectName       *string                       `json:"subjectName,omitempty"`
	Thumbprint        *string                       `json:"thumbprint,omitempty"`
	Valid             *bool                         `json:"valid,omitempty"`
	Value             *string                       `json:"value,omitempty"`
}

func (*CertificateProperties) GetExpirationDateAsTime

func (o *CertificateProperties) GetExpirationDateAsTime() (*time.Time, error)

func (*CertificateProperties) GetIssueDateAsTime

func (o *CertificateProperties) GetIssueDateAsTime() (*time.Time, error)

func (*CertificateProperties) SetExpirationDateAsTime

func (o *CertificateProperties) SetExpirationDateAsTime(input time.Time)

func (*CertificateProperties) SetIssueDateAsTime

func (o *CertificateProperties) SetIssueDateAsTime(input time.Time)

type CertificateProvisioningState

type CertificateProvisioningState string
const (
	CertificateProvisioningStateCanceled     CertificateProvisioningState = "Canceled"
	CertificateProvisioningStateDeleteFailed CertificateProvisioningState = "DeleteFailed"
	CertificateProvisioningStateFailed       CertificateProvisioningState = "Failed"
	CertificateProvisioningStatePending      CertificateProvisioningState = "Pending"
	CertificateProvisioningStateSucceeded    CertificateProvisioningState = "Succeeded"
)

type CertificatesCreateOrUpdateOperationResponse

type CertificatesCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *Certificate
}

type CertificatesDeleteOperationResponse

type CertificatesDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type CertificatesGetOperationResponse

type CertificatesGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *Certificate
}

type CertificatesListCompleteResult

type CertificatesListCompleteResult struct {
	Items []Certificate
}

type CertificatesListOperationResponse

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

func (CertificatesListOperationResponse) HasMore

func (CertificatesListOperationResponse) LoadMore

type CertificatesUpdateOperationResponse

type CertificatesUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *Certificate
}

type CheckNameAvailabilityReason

type CheckNameAvailabilityReason string
const (
	CheckNameAvailabilityReasonAlreadyExists CheckNameAvailabilityReason = "AlreadyExists"
	CheckNameAvailabilityReasonInvalid       CheckNameAvailabilityReason = "Invalid"
)

type CheckNameAvailabilityRequest

type CheckNameAvailabilityRequest struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type CheckNameAvailabilityResponse

type CheckNameAvailabilityResponse struct {
	Message       *string                      `json:"message,omitempty"`
	NameAvailable *bool                        `json:"nameAvailable,omitempty"`
	Reason        *CheckNameAvailabilityReason `json:"reason,omitempty"`
}

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type EnvironmentProvisioningState

type EnvironmentProvisioningState string
const (
	EnvironmentProvisioningStateCanceled                      EnvironmentProvisioningState = "Canceled"
	EnvironmentProvisioningStateFailed                        EnvironmentProvisioningState = "Failed"
	EnvironmentProvisioningStateInfrastructureSetupComplete   EnvironmentProvisioningState = "InfrastructureSetupComplete"
	EnvironmentProvisioningStateInfrastructureSetupInProgress EnvironmentProvisioningState = "InfrastructureSetupInProgress"
	EnvironmentProvisioningStateInitializationInProgress      EnvironmentProvisioningState = "InitializationInProgress"
	EnvironmentProvisioningStateScheduledForDelete            EnvironmentProvisioningState = "ScheduledForDelete"
	EnvironmentProvisioningStateSucceeded                     EnvironmentProvisioningState = "Succeeded"
	EnvironmentProvisioningStateUpgradeFailed                 EnvironmentProvisioningState = "UpgradeFailed"
	EnvironmentProvisioningStateUpgradeRequested              EnvironmentProvisioningState = "UpgradeRequested"
	EnvironmentProvisioningStateWaiting                       EnvironmentProvisioningState = "Waiting"
)

type GetOperationResponse

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

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []ManagedEnvironment
}

type ListByResourceGroupOperationResponse

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

func (ListByResourceGroupOperationResponse) HasMore

func (ListByResourceGroupOperationResponse) LoadMore

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []ManagedEnvironment
}

type ListBySubscriptionOperationResponse

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

func (ListBySubscriptionOperationResponse) HasMore

func (ListBySubscriptionOperationResponse) LoadMore

type LogAnalyticsConfiguration

type LogAnalyticsConfiguration struct {
	CustomerId *string `json:"customerId,omitempty"`
	SharedKey  *string `json:"sharedKey,omitempty"`
}

type ManagedEnvironment

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

type ManagedEnvironmentId

type ManagedEnvironmentId struct {
	SubscriptionId    string
	ResourceGroupName string
	EnvironmentName   string
}

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

func NewManagedEnvironmentID

func NewManagedEnvironmentID(subscriptionId string, resourceGroupName string, environmentName 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) 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 ManagedEnvironmentOperationPredicate

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

func (ManagedEnvironmentOperationPredicate) Matches

type ManagedEnvironmentProperties

type ManagedEnvironmentProperties struct {
	AppLogsConfiguration     *AppLogsConfiguration         `json:"appLogsConfiguration,omitempty"`
	DaprAIConnectionString   *string                       `json:"daprAIConnectionString,omitempty"`
	DaprAIInstrumentationKey *string                       `json:"daprAIInstrumentationKey,omitempty"`
	DefaultDomain            *string                       `json:"defaultDomain,omitempty"`
	DeploymentErrors         *string                       `json:"deploymentErrors,omitempty"`
	ProvisioningState        *EnvironmentProvisioningState `json:"provisioningState,omitempty"`
	StaticIP                 *string                       `json:"staticIp,omitempty"`
	VnetConfiguration        *VnetConfiguration            `json:"vnetConfiguration,omitempty"`
	ZoneRedundant            *bool                         `json:"zoneRedundant,omitempty"`
}

type ManagedEnvironmentsClient

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

func NewManagedEnvironmentsClientWithBaseURI

func NewManagedEnvironmentsClientWithBaseURI(endpoint string) ManagedEnvironmentsClient

func (ManagedEnvironmentsClient) CertificatesCreateOrUpdate

func (c ManagedEnvironmentsClient) CertificatesCreateOrUpdate(ctx context.Context, id CertificateId, input Certificate) (result CertificatesCreateOrUpdateOperationResponse, err error)

CertificatesCreateOrUpdate ...

func (ManagedEnvironmentsClient) CertificatesDelete

CertificatesDelete ...

func (ManagedEnvironmentsClient) CertificatesGet

CertificatesGet ...

func (ManagedEnvironmentsClient) CertificatesList

CertificatesList ...

func (ManagedEnvironmentsClient) CertificatesListComplete

CertificatesListComplete retrieves all of the results into a single object

func (ManagedEnvironmentsClient) CertificatesListCompleteMatchingPredicate

func (c ManagedEnvironmentsClient) CertificatesListCompleteMatchingPredicate(ctx context.Context, id ManagedEnvironmentId, predicate CertificateOperationPredicate) (resp CertificatesListCompleteResult, err error)

CertificatesListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ManagedEnvironmentsClient) CertificatesUpdate

CertificatesUpdate ...

func (ManagedEnvironmentsClient) CreateOrUpdate

CreateOrUpdate ...

func (ManagedEnvironmentsClient) CreateOrUpdateThenPoll

func (c ManagedEnvironmentsClient) CreateOrUpdateThenPoll(ctx context.Context, id ManagedEnvironmentId, input ManagedEnvironment) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ManagedEnvironmentsClient) Delete

Delete ...

func (ManagedEnvironmentsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ManagedEnvironmentsClient) Get

Get ...

func (ManagedEnvironmentsClient) ListByResourceGroup

ListByResourceGroup ...

func (ManagedEnvironmentsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all of the results into a single object

func (ManagedEnvironmentsClient) ListByResourceGroupCompleteMatchingPredicate

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

ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ManagedEnvironmentsClient) ListBySubscription

ListBySubscription ...

func (ManagedEnvironmentsClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all of the results into a single object

func (ManagedEnvironmentsClient) ListBySubscriptionCompleteMatchingPredicate

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

ListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ManagedEnvironmentsClient) NamespacesCheckNameAvailability

NamespacesCheckNameAvailability ...

func (ManagedEnvironmentsClient) Update

Update ...

func (ManagedEnvironmentsClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type NamespacesCheckNameAvailabilityOperationResponse

type NamespacesCheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	Model        *CheckNameAvailabilityResponse
}

type UpdateOperationResponse

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

type VnetConfiguration

type VnetConfiguration struct {
	DockerBridgeCidr       *string `json:"dockerBridgeCidr,omitempty"`
	InfrastructureSubnetId *string `json:"infrastructureSubnetId,omitempty"`
	Internal               *bool   `json:"internal,omitempty"`
	PlatformReservedCidr   *string `json:"platformReservedCidr,omitempty"`
	PlatformReservedDnsIP  *string `json:"platformReservedDnsIP,omitempty"`
	RuntimeSubnetId        *string `json:"runtimeSubnetId,omitempty"`
}

Jump to

Keyboard shortcuts

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