connectedenvironments

package
v0.20240222.1164640 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2023-05-01/connectedenvironments Documentation

The connectedenvironments SDK allows for interaction with the Azure Resource Manager Service containerapps (API Version 2023-05-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2023-05-01/connectedenvironments"

Client Initialization

client := connectedenvironments.NewConnectedEnvironmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConnectedEnvironmentsClient.CertificatesCreateOrUpdate

ctx := context.TODO()
id := connectedenvironments.NewConnectedEnvironmentCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentValue", "certificateValue")

payload := connectedenvironments.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: ConnectedEnvironmentsClient.CertificatesDelete

ctx := context.TODO()
id := connectedenvironments.NewConnectedEnvironmentCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentValue", "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: ConnectedEnvironmentsClient.CertificatesGet

ctx := context.TODO()
id := connectedenvironments.NewConnectedEnvironmentCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentValue", "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: ConnectedEnvironmentsClient.CertificatesList

ctx := context.TODO()
id := connectedenvironments.NewConnectedEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentValue")

// 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: ConnectedEnvironmentsClient.CertificatesUpdate

ctx := context.TODO()
id := connectedenvironments.NewConnectedEnvironmentCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentValue", "certificateValue")

payload := connectedenvironments.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: ConnectedEnvironmentsClient.CheckNameAvailability

ctx := context.TODO()
id := connectedenvironments.NewConnectedEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentValue")

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


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

Example Usage: ConnectedEnvironmentsClient.CreateOrUpdate

ctx := context.TODO()
id := connectedenvironments.NewConnectedEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentValue")

payload := connectedenvironments.ConnectedEnvironment{
	// ...
}


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

Example Usage: ConnectedEnvironmentsClient.Delete

ctx := context.TODO()
id := connectedenvironments.NewConnectedEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentValue")

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

Example Usage: ConnectedEnvironmentsClient.Get

ctx := context.TODO()
id := connectedenvironments.NewConnectedEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentValue")

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

ctx := context.TODO()
id := connectedenvironments.NewConnectedEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCertificateProvisioningState

func PossibleValuesForCertificateProvisioningState() []string

func PossibleValuesForCheckNameAvailabilityReason

func PossibleValuesForCheckNameAvailabilityReason() []string

func PossibleValuesForConnectedEnvironmentProvisioningState

func PossibleValuesForConnectedEnvironmentProvisioningState() []string

func PossibleValuesForExtendedLocationTypes

func PossibleValuesForExtendedLocationTypes() []string

func ValidateConnectedEnvironmentCertificateID

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

ValidateConnectedEnvironmentCertificateID checks that 'input' can be parsed as a Connected Environment Certificate ID

func ValidateConnectedEnvironmentID

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

ValidateConnectedEnvironmentID checks that 'input' can be parsed as a Connected Environment ID

Types

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 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"`
	SubjectAlternativeNames *[]string                     `json:"subjectAlternativeNames,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"
)

func (*CertificateProvisioningState) UnmarshalJSON added in v0.20240212.1141705

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

type CertificatesCreateOrUpdateOperationResponse

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

type CertificatesDeleteOperationResponse

type CertificatesDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type CertificatesGetOperationResponse

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

type CertificatesListCompleteResult

type CertificatesListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Certificate
}

type CertificatesListOperationResponse

type CertificatesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Certificate
}

type CertificatesUpdateOperationResponse

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

type CheckNameAvailabilityOperationResponse

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckNameAvailabilityResponse
}

type CheckNameAvailabilityReason

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

func (*CheckNameAvailabilityReason) UnmarshalJSON added in v0.20240212.1141705

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

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 ConnectedEnvironment

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

type ConnectedEnvironmentCertificateId

type ConnectedEnvironmentCertificateId struct {
	SubscriptionId           string
	ResourceGroupName        string
	ConnectedEnvironmentName string
	CertificateName          string
}

ConnectedEnvironmentCertificateId is a struct representing the Resource ID for a Connected Environment Certificate

func NewConnectedEnvironmentCertificateID

func NewConnectedEnvironmentCertificateID(subscriptionId string, resourceGroupName string, connectedEnvironmentName string, certificateName string) ConnectedEnvironmentCertificateId

NewConnectedEnvironmentCertificateID returns a new ConnectedEnvironmentCertificateId struct

func ParseConnectedEnvironmentCertificateID

func ParseConnectedEnvironmentCertificateID(input string) (*ConnectedEnvironmentCertificateId, error)

ParseConnectedEnvironmentCertificateID parses 'input' into a ConnectedEnvironmentCertificateId

func ParseConnectedEnvironmentCertificateIDInsensitively

func ParseConnectedEnvironmentCertificateIDInsensitively(input string) (*ConnectedEnvironmentCertificateId, error)

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

func (*ConnectedEnvironmentCertificateId) FromParseResult

func (ConnectedEnvironmentCertificateId) ID

ID returns the formatted Connected Environment Certificate ID

func (ConnectedEnvironmentCertificateId) Segments

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

func (ConnectedEnvironmentCertificateId) String

String returns a human-readable description of this Connected Environment Certificate ID

type ConnectedEnvironmentId

type ConnectedEnvironmentId struct {
	SubscriptionId           string
	ResourceGroupName        string
	ConnectedEnvironmentName string
}

ConnectedEnvironmentId is a struct representing the Resource ID for a Connected Environment

func NewConnectedEnvironmentID

func NewConnectedEnvironmentID(subscriptionId string, resourceGroupName string, connectedEnvironmentName string) ConnectedEnvironmentId

NewConnectedEnvironmentID returns a new ConnectedEnvironmentId struct

func ParseConnectedEnvironmentID

func ParseConnectedEnvironmentID(input string) (*ConnectedEnvironmentId, error)

ParseConnectedEnvironmentID parses 'input' into a ConnectedEnvironmentId

func ParseConnectedEnvironmentIDInsensitively

func ParseConnectedEnvironmentIDInsensitively(input string) (*ConnectedEnvironmentId, error)

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

func (*ConnectedEnvironmentId) FromParseResult

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

func (ConnectedEnvironmentId) ID

ID returns the formatted Connected Environment ID

func (ConnectedEnvironmentId) Segments

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

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

func (ConnectedEnvironmentId) String

func (id ConnectedEnvironmentId) String() string

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

type ConnectedEnvironmentOperationPredicate

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

func (ConnectedEnvironmentOperationPredicate) Matches

type ConnectedEnvironmentProperties

type ConnectedEnvironmentProperties struct {
	CustomDomainConfiguration *CustomDomainConfiguration             `json:"customDomainConfiguration,omitempty"`
	DaprAIConnectionString    *string                                `json:"daprAIConnectionString,omitempty"`
	DefaultDomain             *string                                `json:"defaultDomain,omitempty"`
	DeploymentErrors          *string                                `json:"deploymentErrors,omitempty"`
	ProvisioningState         *ConnectedEnvironmentProvisioningState `json:"provisioningState,omitempty"`
	StaticIP                  *string                                `json:"staticIp,omitempty"`
}

type ConnectedEnvironmentProvisioningState

type ConnectedEnvironmentProvisioningState string
const (
	ConnectedEnvironmentProvisioningStateCanceled                      ConnectedEnvironmentProvisioningState = "Canceled"
	ConnectedEnvironmentProvisioningStateFailed                        ConnectedEnvironmentProvisioningState = "Failed"
	ConnectedEnvironmentProvisioningStateInfrastructureSetupComplete   ConnectedEnvironmentProvisioningState = "InfrastructureSetupComplete"
	ConnectedEnvironmentProvisioningStateInfrastructureSetupInProgress ConnectedEnvironmentProvisioningState = "InfrastructureSetupInProgress"
	ConnectedEnvironmentProvisioningStateInitializationInProgress      ConnectedEnvironmentProvisioningState = "InitializationInProgress"
	ConnectedEnvironmentProvisioningStateScheduledForDelete            ConnectedEnvironmentProvisioningState = "ScheduledForDelete"
	ConnectedEnvironmentProvisioningStateSucceeded                     ConnectedEnvironmentProvisioningState = "Succeeded"
	ConnectedEnvironmentProvisioningStateWaiting                       ConnectedEnvironmentProvisioningState = "Waiting"
)

func (*ConnectedEnvironmentProvisioningState) UnmarshalJSON added in v0.20240212.1141705

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

type ConnectedEnvironmentsClient

type ConnectedEnvironmentsClient struct {
	Client *resourcemanager.Client
}

func NewConnectedEnvironmentsClientWithBaseURI

func NewConnectedEnvironmentsClientWithBaseURI(sdkApi sdkEnv.Api) (*ConnectedEnvironmentsClient, error)

func (ConnectedEnvironmentsClient) CertificatesCreateOrUpdate

CertificatesCreateOrUpdate ...

func (ConnectedEnvironmentsClient) CertificatesDelete

CertificatesDelete ...

func (ConnectedEnvironmentsClient) CertificatesGet

CertificatesGet ...

func (ConnectedEnvironmentsClient) CertificatesList

CertificatesList ...

func (ConnectedEnvironmentsClient) CertificatesListComplete

CertificatesListComplete retrieves all the results into a single object

func (ConnectedEnvironmentsClient) CertificatesListCompleteMatchingPredicate

func (c ConnectedEnvironmentsClient) CertificatesListCompleteMatchingPredicate(ctx context.Context, id ConnectedEnvironmentId, predicate CertificateOperationPredicate) (result CertificatesListCompleteResult, err error)

CertificatesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConnectedEnvironmentsClient) CertificatesUpdate

CertificatesUpdate ...

func (ConnectedEnvironmentsClient) CheckNameAvailability

CheckNameAvailability ...

func (ConnectedEnvironmentsClient) CreateOrUpdate

CreateOrUpdate ...

func (ConnectedEnvironmentsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ConnectedEnvironmentsClient) Delete

Delete ...

func (ConnectedEnvironmentsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ConnectedEnvironmentsClient) Get

Get ...

func (ConnectedEnvironmentsClient) ListByResourceGroup

ListByResourceGroup ...

func (ConnectedEnvironmentsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (ConnectedEnvironmentsClient) ListByResourceGroupCompleteMatchingPredicate

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConnectedEnvironmentsClient) ListBySubscription

ListBySubscription ...

func (ConnectedEnvironmentsClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (ConnectedEnvironmentsClient) ListBySubscriptionCompleteMatchingPredicate

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConnectedEnvironmentsClient) Update

Update ...

type CreateOrUpdateOperationResponse

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

type CustomDomainConfiguration

type CustomDomainConfiguration struct {
	CertificatePassword        *string `json:"certificatePassword,omitempty"`
	CertificateValue           *string `json:"certificateValue,omitempty"`
	CustomDomainVerificationId *string `json:"customDomainVerificationId,omitempty"`
	DnsSuffix                  *string `json:"dnsSuffix,omitempty"`
	ExpirationDate             *string `json:"expirationDate,omitempty"`
	SubjectName                *string `json:"subjectName,omitempty"`
	Thumbprint                 *string `json:"thumbprint,omitempty"`
}

func (*CustomDomainConfiguration) GetExpirationDateAsTime

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

func (*CustomDomainConfiguration) SetExpirationDateAsTime

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

type DeleteOperationResponse

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

type ExtendedLocation

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

type ExtendedLocationTypes

type ExtendedLocationTypes string
const (
	ExtendedLocationTypesCustomLocation ExtendedLocationTypes = "CustomLocation"
)

func (*ExtendedLocationTypes) UnmarshalJSON added in v0.20240212.1141705

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

type GetOperationResponse

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

type ListByResourceGroupCompleteResult

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

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ConnectedEnvironment
}

type ListBySubscriptionCompleteResult

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

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ConnectedEnvironment
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectedEnvironment
}

Jump to

Keyboard shortcuts

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