certificate

package
v0.20230221.1105556 Latest Latest
Warning

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

Go to latest
Published: Feb 20, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2022-08-08/certificate Documentation

The certificate SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2022-08-08).

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/automation/2022-08-08/certificate"

Client Initialization

client := certificate.NewCertificateClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CertificateClient.CreateOrUpdate

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

payload := certificate.CertificateCreateOrUpdateParameters{
	// ...
}


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: CertificateClient.Delete

ctx := context.TODO()
id := certificate.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "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: CertificateClient.Get

ctx := context.TODO()
id := certificate.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "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: CertificateClient.ListByAutomationAccount

ctx := context.TODO()
id := certificate.NewAutomationAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue")

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

Example Usage: CertificateClient.Update

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

payload := certificate.CertificateUpdateParameters{
	// ...
}


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 ValidateAutomationAccountID

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

ValidateAutomationAccountID checks that 'input' can be parsed as a Automation Account ID

func ValidateCertificateID

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

ValidateCertificateID checks that 'input' can be parsed as a Certificate ID

Types

type AutomationAccountId

type AutomationAccountId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
}

AutomationAccountId is a struct representing the Resource ID for a Automation Account

func NewAutomationAccountID

func NewAutomationAccountID(subscriptionId string, resourceGroupName string, automationAccountName string) AutomationAccountId

NewAutomationAccountID returns a new AutomationAccountId struct

func ParseAutomationAccountID

func ParseAutomationAccountID(input string) (*AutomationAccountId, error)

ParseAutomationAccountID parses 'input' into a AutomationAccountId

func ParseAutomationAccountIDInsensitively

func ParseAutomationAccountIDInsensitively(input string) (*AutomationAccountId, error)

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

func (AutomationAccountId) ID

func (id AutomationAccountId) ID() string

ID returns the formatted Automation Account ID

func (AutomationAccountId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Automation Account ID

func (AutomationAccountId) String

func (id AutomationAccountId) String() string

String returns a human-readable description of this Automation Account ID

type Certificate

type Certificate struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *CertificateProperties `json:"properties,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type CertificateClient

type CertificateClient struct {
	Client *resourcemanager.Client
}

func NewCertificateClientWithBaseURI

func NewCertificateClientWithBaseURI(api environments.Api) (*CertificateClient, error)

func (CertificateClient) CreateOrUpdate

CreateOrUpdate ...

func (CertificateClient) Delete

Delete ...

func (CertificateClient) Get

Get ...

func (CertificateClient) ListByAutomationAccount

ListByAutomationAccount ...

func (CertificateClient) ListByAutomationAccountComplete

ListByAutomationAccountComplete retrieves all the results into a single object

func (CertificateClient) ListByAutomationAccountCompleteMatchingPredicate

func (c CertificateClient) ListByAutomationAccountCompleteMatchingPredicate(ctx context.Context, id AutomationAccountId, predicate CertificateOperationPredicate) (result ListByAutomationAccountCompleteResult, err error)

ListByAutomationAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CertificateClient) Update

Update ...

type CertificateCreateOrUpdateParameters

type CertificateCreateOrUpdateParameters struct {
	Name       string                              `json:"name"`
	Properties CertificateCreateOrUpdateProperties `json:"properties"`
}

type CertificateCreateOrUpdateProperties

type CertificateCreateOrUpdateProperties struct {
	Base64Value  string  `json:"base64Value"`
	Description  *string `json:"description,omitempty"`
	IsExportable *bool   `json:"isExportable,omitempty"`
	Thumbprint   *string `json:"thumbprint,omitempty"`
}

type CertificateId

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

CertificateId is a struct representing the Resource ID for a Certificate

func NewCertificateID

func NewCertificateID(subscriptionId string, resourceGroupName string, automationAccountName 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
	Name *string
	Type *string
}

func (CertificateOperationPredicate) Matches

type CertificateProperties

type CertificateProperties struct {
	CreationTime     *string `json:"creationTime,omitempty"`
	Description      *string `json:"description,omitempty"`
	ExpiryTime       *string `json:"expiryTime,omitempty"`
	IsExportable     *bool   `json:"isExportable,omitempty"`
	LastModifiedTime *string `json:"lastModifiedTime,omitempty"`
	Thumbprint       *string `json:"thumbprint,omitempty"`
}

func (*CertificateProperties) GetCreationTimeAsTime

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

func (*CertificateProperties) GetExpiryTimeAsTime

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

func (*CertificateProperties) GetLastModifiedTimeAsTime

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

func (*CertificateProperties) SetCreationTimeAsTime

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

func (*CertificateProperties) SetExpiryTimeAsTime

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

func (*CertificateProperties) SetLastModifiedTimeAsTime

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

type CertificateUpdateParameters

type CertificateUpdateParameters struct {
	Name       *string                      `json:"name,omitempty"`
	Properties *CertificateUpdateProperties `json:"properties,omitempty"`
}

type CertificateUpdateProperties

type CertificateUpdateProperties struct {
	Description *string `json:"description,omitempty"`
}

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 ListByAutomationAccountCompleteResult

type ListByAutomationAccountCompleteResult struct {
	Items []Certificate
}

type ListByAutomationAccountOperationResponse

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

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

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