managedcertificates

package
v0.20240516.1080701 Latest Latest
Warning

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

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

README

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

The managedcertificates 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-sdk/resource-manager/containerapps/2023-05-01/managedcertificates"

Client Initialization

client := managedcertificates.NewManagedCertificatesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedCertificatesClient.CreateOrUpdate

ctx := context.TODO()
id := managedcertificates.NewManagedCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedEnvironmentValue", "managedCertificateValue")

payload := managedcertificates.ManagedCertificate{
	// ...
}


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

Example Usage: ManagedCertificatesClient.Delete

ctx := context.TODO()
id := managedcertificates.NewManagedCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedEnvironmentValue", "managedCertificateValue")

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

Example Usage: ManagedCertificatesClient.Get

ctx := context.TODO()
id := managedcertificates.NewManagedCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedEnvironmentValue", "managedCertificateValue")

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

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

// 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: ManagedCertificatesClient.Update

ctx := context.TODO()
id := managedcertificates.NewManagedCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedEnvironmentValue", "managedCertificateValue")

payload := managedcertificates.ManagedCertificatePatch{
	// ...
}


read, err := client.Update(ctx, id, payload)
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 PossibleValuesForManagedCertificateDomainControlValidation 

func PossibleValuesForManagedCertificateDomainControlValidation() []string

func ValidateManagedCertificateID 

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

ValidateManagedCertificateID checks that 'input' can be parsed as a Managed 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 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 CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListOperationResponse 

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

type ManagedCertificate 

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

type ManagedCertificateDomainControlValidation 

type ManagedCertificateDomainControlValidation string
const (
	ManagedCertificateDomainControlValidationCNAME ManagedCertificateDomainControlValidation = "CNAME"
	ManagedCertificateDomainControlValidationHTTP  ManagedCertificateDomainControlValidation = "HTTP"
	ManagedCertificateDomainControlValidationTXT   ManagedCertificateDomainControlValidation = "TXT"
)

func (*ManagedCertificateDomainControlValidation) UnmarshalJSON added in v0.20240212.1141705 

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

type ManagedCertificateId 

type ManagedCertificateId struct {
	SubscriptionId         string
	ResourceGroupName      string
	ManagedEnvironmentName string
	ManagedCertificateName string
}

ManagedCertificateId is a struct representing the Resource ID for a Managed Certificate

func NewManagedCertificateID 

func NewManagedCertificateID(subscriptionId string, resourceGroupName string, managedEnvironmentName string, managedCertificateName string) ManagedCertificateId

NewManagedCertificateID returns a new ManagedCertificateId struct

func ParseManagedCertificateID 

func ParseManagedCertificateID(input string) (*ManagedCertificateId, error)

ParseManagedCertificateID parses 'input' into a ManagedCertificateId

func ParseManagedCertificateIDInsensitively 

func ParseManagedCertificateIDInsensitively(input string) (*ManagedCertificateId, error)

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

func (*ManagedCertificateId) FromParseResult 

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

func (ManagedCertificateId) ID 

func (id ManagedCertificateId) ID() string

ID returns the formatted Managed Certificate ID

func (ManagedCertificateId) Segments 

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

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

func (ManagedCertificateId) String 

func (id ManagedCertificateId) String() string

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

type ManagedCertificateOperationPredicate 

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

func (ManagedCertificateOperationPredicate) Matches 

func (p ManagedCertificateOperationPredicate) Matches(input ManagedCertificate) bool

type ManagedCertificatePatch 

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

type ManagedCertificateProperties 

type ManagedCertificateProperties struct {
	DomainControlValidation *ManagedCertificateDomainControlValidation `json:"domainControlValidation,omitempty"`
	Error                   *string                                    `json:"error,omitempty"`
	ProvisioningState       *CertificateProvisioningState              `json:"provisioningState,omitempty"`
	SubjectName             *string                                    `json:"subjectName,omitempty"`
	ValidationToken         *string                                    `json:"validationToken,omitempty"`
}

type ManagedCertificatesClient 

type ManagedCertificatesClient struct {
	Client *resourcemanager.Client
}

func NewManagedCertificatesClientWithBaseURI 

func NewManagedCertificatesClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedCertificatesClient, error)

func (ManagedCertificatesClient) CreateOrUpdate 

func (c ManagedCertificatesClient) CreateOrUpdate(ctx context.Context, id ManagedCertificateId, input ManagedCertificate) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ManagedCertificatesClient) CreateOrUpdateThenPoll 

func (c ManagedCertificatesClient) CreateOrUpdateThenPoll(ctx context.Context, id ManagedCertificateId, input ManagedCertificate) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ManagedCertificatesClient) Delete 

func (c ManagedCertificatesClient) Delete(ctx context.Context, id ManagedCertificateId) (result DeleteOperationResponse, err error)

Delete ...

func (ManagedCertificatesClient) Get 

func (c ManagedCertificatesClient) Get(ctx context.Context, id ManagedCertificateId) (result GetOperationResponse, err error)

Get ...

func (ManagedCertificatesClient) List 

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

List ...

func (ManagedCertificatesClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (ManagedCertificatesClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedCertificatesClient) Update 

func (c ManagedCertificatesClient) Update(ctx context.Context, id ManagedCertificateId, input ManagedCertificatePatch) (result UpdateOperationResponse, err error)

Update ...

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 {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedCertificate
}

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.