certificates

package
v0.20230104.1164521 Latest Latest
Warning

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

Go to latest
Published: Jan 4, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README

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

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

Client Initialization

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

Example Usage: CertificatesClient.CreateOrUpdate

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

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", "environmentValue", "certificateValue")

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", "environmentValue", "certificateValue")

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", "environmentValue")

// 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", "environmentValue", "certificateValue")

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 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 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 CertificatesClient

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

func NewCertificatesClientWithBaseURI

func NewCertificatesClientWithBaseURI(endpoint string) CertificatesClient

func (CertificatesClient) CreateOrUpdate

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

CreateOrUpdate ...

func (CertificatesClient) Delete

Delete ...

func (CertificatesClient) Get

Get ...

func (CertificatesClient) List

List ...

func (CertificatesClient) ListComplete

ListComplete retrieves all of the results into a single object

func (CertificatesClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (CertificatesClient) Update

Update ...

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []Certificate
}

type ListOperationResponse

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

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

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 UpdateOperationResponse

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

Jump to

Keyboard shortcuts

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