cacertificates

package
v0.20240320.1000025 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2023-12-15-preview/cacertificates Documentation

The cacertificates SDK allows for interaction with the Azure Resource Manager Service eventgrid (API Version 2023-12-15-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/eventgrid/2023-12-15-preview/cacertificates"

Client Initialization

client := cacertificates.NewCaCertificatesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CaCertificatesClient.CreateOrUpdate

ctx := context.TODO()
id := cacertificates.NewCaCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "caCertificateValue")

payload := cacertificates.CaCertificate{
	// ...
}


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

Example Usage: CaCertificatesClient.Delete

ctx := context.TODO()
id := cacertificates.NewCaCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "caCertificateValue")

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

Example Usage: CaCertificatesClient.Get

ctx := context.TODO()
id := cacertificates.NewCaCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "caCertificateValue")

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: CaCertificatesClient.ListByNamespace

ctx := context.TODO()
id := cacertificates.NewNamespaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCaCertificateProvisioningState

func PossibleValuesForCaCertificateProvisioningState() []string

func ValidateCaCertificateID

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

ValidateCaCertificateID checks that 'input' can be parsed as a Ca Certificate ID

func ValidateNamespaceID

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

Types

type CaCertificate

type CaCertificate struct {
	Id         *string                  `json:"id,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *CaCertificateProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData   `json:"systemData,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type CaCertificateId

type CaCertificateId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
	CaCertificateName string
}

CaCertificateId is a struct representing the Resource ID for a Ca Certificate

func NewCaCertificateID

func NewCaCertificateID(subscriptionId string, resourceGroupName string, namespaceName string, caCertificateName string) CaCertificateId

NewCaCertificateID returns a new CaCertificateId struct

func ParseCaCertificateID

func ParseCaCertificateID(input string) (*CaCertificateId, error)

ParseCaCertificateID parses 'input' into a CaCertificateId

func ParseCaCertificateIDInsensitively

func ParseCaCertificateIDInsensitively(input string) (*CaCertificateId, error)

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

func (*CaCertificateId) FromParseResult

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

func (CaCertificateId) ID

func (id CaCertificateId) ID() string

ID returns the formatted Ca Certificate ID

func (CaCertificateId) Segments

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

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

func (CaCertificateId) String

func (id CaCertificateId) String() string

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

type CaCertificateOperationPredicate

type CaCertificateOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (CaCertificateOperationPredicate) Matches

type CaCertificateProperties

type CaCertificateProperties struct {
	Description        *string                         `json:"description,omitempty"`
	EncodedCertificate *string                         `json:"encodedCertificate,omitempty"`
	ExpiryTimeInUtc    *string                         `json:"expiryTimeInUtc,omitempty"`
	IssueTimeInUtc     *string                         `json:"issueTimeInUtc,omitempty"`
	ProvisioningState  *CaCertificateProvisioningState `json:"provisioningState,omitempty"`
}

func (*CaCertificateProperties) GetExpiryTimeInUtcAsTime

func (o *CaCertificateProperties) GetExpiryTimeInUtcAsTime() (*time.Time, error)

func (*CaCertificateProperties) GetIssueTimeInUtcAsTime

func (o *CaCertificateProperties) GetIssueTimeInUtcAsTime() (*time.Time, error)

func (*CaCertificateProperties) SetExpiryTimeInUtcAsTime

func (o *CaCertificateProperties) SetExpiryTimeInUtcAsTime(input time.Time)

func (*CaCertificateProperties) SetIssueTimeInUtcAsTime

func (o *CaCertificateProperties) SetIssueTimeInUtcAsTime(input time.Time)

type CaCertificateProvisioningState

type CaCertificateProvisioningState string
const (
	CaCertificateProvisioningStateCanceled  CaCertificateProvisioningState = "Canceled"
	CaCertificateProvisioningStateCreating  CaCertificateProvisioningState = "Creating"
	CaCertificateProvisioningStateDeleted   CaCertificateProvisioningState = "Deleted"
	CaCertificateProvisioningStateDeleting  CaCertificateProvisioningState = "Deleting"
	CaCertificateProvisioningStateFailed    CaCertificateProvisioningState = "Failed"
	CaCertificateProvisioningStateSucceeded CaCertificateProvisioningState = "Succeeded"
	CaCertificateProvisioningStateUpdating  CaCertificateProvisioningState = "Updating"
)

func (*CaCertificateProvisioningState) UnmarshalJSON

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

type CaCertificatesClient

type CaCertificatesClient struct {
	Client *resourcemanager.Client
}

func NewCaCertificatesClientWithBaseURI

func NewCaCertificatesClientWithBaseURI(sdkApi sdkEnv.Api) (*CaCertificatesClient, error)

func (CaCertificatesClient) CreateOrUpdate

CreateOrUpdate ...

func (CaCertificatesClient) CreateOrUpdateThenPoll

func (c CaCertificatesClient) CreateOrUpdateThenPoll(ctx context.Context, id CaCertificateId, input CaCertificate) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (CaCertificatesClient) Delete

Delete ...

func (CaCertificatesClient) DeleteThenPoll

func (c CaCertificatesClient) DeleteThenPoll(ctx context.Context, id CaCertificateId) error

DeleteThenPoll performs Delete then polls until it's completed

func (CaCertificatesClient) Get

Get ...

func (CaCertificatesClient) ListByNamespace

ListByNamespace ...

func (CaCertificatesClient) ListByNamespaceComplete

ListByNamespaceComplete retrieves all the results into a single object

func (CaCertificatesClient) ListByNamespaceCompleteMatchingPredicate

func (c CaCertificatesClient) ListByNamespaceCompleteMatchingPredicate(ctx context.Context, id NamespaceId, options ListByNamespaceOperationOptions, predicate CaCertificateOperationPredicate) (result ListByNamespaceCompleteResult, err error)

ListByNamespaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListByNamespaceCompleteResult

type ListByNamespaceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CaCertificate
}

type ListByNamespaceOperationOptions

type ListByNamespaceOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByNamespaceOperationOptions

func DefaultListByNamespaceOperationOptions() ListByNamespaceOperationOptions

func (ListByNamespaceOperationOptions) ToHeaders

func (ListByNamespaceOperationOptions) ToOData

func (ListByNamespaceOperationOptions) ToQuery

type ListByNamespaceOperationResponse

type ListByNamespaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]CaCertificate
}

type NamespaceId

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (*NamespaceId) FromParseResult

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

func (NamespaceId) ID

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Namespace ID

func (NamespaceId) String

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

Jump to

Keyboard shortcuts

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