certificates

package
v0.20241023.1122425 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := certificates.NewCertificatesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CertificatesClient.ConnectedEnvironmentsCertificatesCreateOrUpdate

ctx := context.TODO()
id := certificates.NewConnectedEnvironmentCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentName", "certificateName")

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


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

Example Usage: CertificatesClient.ConnectedEnvironmentsCertificatesDelete

ctx := context.TODO()
id := certificates.NewConnectedEnvironmentCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentName", "certificateName")

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

Example Usage: CertificatesClient.ConnectedEnvironmentsCertificatesGet

ctx := context.TODO()
id := certificates.NewConnectedEnvironmentCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentName", "certificateName")

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

Example Usage: CertificatesClient.ConnectedEnvironmentsCertificatesList

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

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

Example Usage: CertificatesClient.ConnectedEnvironmentsCertificatesUpdate

ctx := context.TODO()
id := certificates.NewConnectedEnvironmentCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "connectedEnvironmentName", "certificateName")

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


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

Example Usage: CertificatesClient.CreateOrUpdate

ctx := context.TODO()
id := certificates.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedEnvironmentName", "certificateName")

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


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

Example Usage: CertificatesClient.Delete

ctx := context.TODO()
id := certificates.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedEnvironmentName", "certificateName")

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: CertificatesClient.Get

ctx := context.TODO()
id := certificates.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedEnvironmentName", "certificateName")

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

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

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

ctx := context.TODO()
id := certificates.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedEnvironmentName", "certificateName")

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


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 PossibleValuesForCertificateType 

func PossibleValuesForCertificateType() []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 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

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 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
	ManagedEnvironmentName string
	CertificateName        string
}

CertificateId is a struct representing the Resource ID for a Certificate

func NewCertificateID 

func NewCertificateID(subscriptionId string, resourceGroupName string, managedEnvironmentName 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) FromParseResult 

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

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 CertificateKeyVaultProperties 

type CertificateKeyVaultProperties struct {
	Identity    *string `json:"identity,omitempty"`
	KeyVaultURL *string `json:"keyVaultUrl,omitempty"`
}

type CertificateOperationPredicate 

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

func (CertificateOperationPredicate) Matches 

func (p CertificateOperationPredicate) Matches(input Certificate) bool

type CertificatePatch 

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

type CertificateProperties 

type CertificateProperties struct {
	CertificateKeyVaultProperties *CertificateKeyVaultProperties `json:"certificateKeyVaultProperties,omitempty"`
	CertificateType               *CertificateType               `json:"certificateType,omitempty"`
	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 

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

type CertificateType 

type CertificateType string
const (
	CertificateTypeImagePullTrustedCA   CertificateType = "ImagePullTrustedCA"
	CertificateTypeServerSSLCertificate CertificateType = "ServerSSLCertificate"
)

func (*CertificateType) UnmarshalJSON 

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

type CertificatesClient 

type CertificatesClient struct {
	Client *resourcemanager.Client
}

func NewCertificatesClientWithBaseURI 

func NewCertificatesClientWithBaseURI(sdkApi sdkEnv.Api) (*CertificatesClient, error)

func (CertificatesClient) ConnectedEnvironmentsCertificatesCreateOrUpdate 

func (c CertificatesClient) ConnectedEnvironmentsCertificatesCreateOrUpdate(ctx context.Context, id ConnectedEnvironmentCertificateId, input Certificate) (result ConnectedEnvironmentsCertificatesCreateOrUpdateOperationResponse, err error)

ConnectedEnvironmentsCertificatesCreateOrUpdate ...

func (CertificatesClient) ConnectedEnvironmentsCertificatesDelete 

func (c CertificatesClient) ConnectedEnvironmentsCertificatesDelete(ctx context.Context, id ConnectedEnvironmentCertificateId) (result ConnectedEnvironmentsCertificatesDeleteOperationResponse, err error)

ConnectedEnvironmentsCertificatesDelete ...

func (CertificatesClient) ConnectedEnvironmentsCertificatesGet 

func (c CertificatesClient) ConnectedEnvironmentsCertificatesGet(ctx context.Context, id ConnectedEnvironmentCertificateId) (result ConnectedEnvironmentsCertificatesGetOperationResponse, err error)

ConnectedEnvironmentsCertificatesGet ...

func (CertificatesClient) ConnectedEnvironmentsCertificatesList 

func (c CertificatesClient) ConnectedEnvironmentsCertificatesList(ctx context.Context, id ConnectedEnvironmentId) (result ConnectedEnvironmentsCertificatesListOperationResponse, err error)

ConnectedEnvironmentsCertificatesList ...

func (CertificatesClient) ConnectedEnvironmentsCertificatesListComplete 

func (c CertificatesClient) ConnectedEnvironmentsCertificatesListComplete(ctx context.Context, id ConnectedEnvironmentId) (ConnectedEnvironmentsCertificatesListCompleteResult, error)

ConnectedEnvironmentsCertificatesListComplete retrieves all the results into a single object

func (CertificatesClient) ConnectedEnvironmentsCertificatesListCompleteMatchingPredicate 

func (c CertificatesClient) ConnectedEnvironmentsCertificatesListCompleteMatchingPredicate(ctx context.Context, id ConnectedEnvironmentId, predicate CertificateOperationPredicate) (result ConnectedEnvironmentsCertificatesListCompleteResult, err error)

ConnectedEnvironmentsCertificatesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CertificatesClient) ConnectedEnvironmentsCertificatesUpdate 

func (c CertificatesClient) ConnectedEnvironmentsCertificatesUpdate(ctx context.Context, id ConnectedEnvironmentCertificateId, input CertificatePatch) (result ConnectedEnvironmentsCertificatesUpdateOperationResponse, err error)

ConnectedEnvironmentsCertificatesUpdate ...

func (CertificatesClient) CreateOrUpdate 

func (c CertificatesClient) CreateOrUpdate(ctx context.Context, id CertificateId, input Certificate) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (CertificatesClient) Delete 

func (c CertificatesClient) Delete(ctx context.Context, id CertificateId) (result DeleteOperationResponse, err error)

Delete ...

func (CertificatesClient) Get 

func (c CertificatesClient) Get(ctx context.Context, id CertificateId) (result GetOperationResponse, err error)

Get ...

func (CertificatesClient) List 

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

List ...

func (CertificatesClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (CertificatesClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CertificatesClient) Update 

func (c CertificatesClient) Update(ctx context.Context, id CertificateId, input CertificatePatch) (result UpdateOperationResponse, err error)

Update ...

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 (id *ConnectedEnvironmentCertificateId) FromParseResult(input resourceids.ParseResult) error

func (ConnectedEnvironmentCertificateId) ID 

func (id ConnectedEnvironmentCertificateId) ID() string

ID returns the formatted Connected Environment Certificate ID

func (ConnectedEnvironmentCertificateId) Segments 

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

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

func (ConnectedEnvironmentCertificateId) String 

func (id ConnectedEnvironmentCertificateId) String() 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 

func (id ConnectedEnvironmentId) ID() string

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 ConnectedEnvironmentsCertificatesCreateOrUpdateOperationResponse 

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

type ConnectedEnvironmentsCertificatesDeleteOperationResponse 

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

type ConnectedEnvironmentsCertificatesGetOperationResponse 

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

type ConnectedEnvironmentsCertificatesListCompleteResult 

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

type ConnectedEnvironmentsCertificatesListCustomPager 

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

type ConnectedEnvironmentsCertificatesListOperationResponse 

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

type ConnectedEnvironmentsCertificatesUpdateOperationResponse 

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

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

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

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        *Certificate
}

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.