nginxcertificate

package
v0.20240108.1165100 Latest Latest
Warning

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

 Go to latest Published: Jan 8, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/nginx/2023-04-01/nginxcertificate Documentation

The nginxcertificate SDK allows for interaction with the Azure Resource Manager Service nginx (API Version 2023-04-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/nginx/2023-04-01/nginxcertificate"

Client Initialization

client := nginxcertificate.NewNginxCertificateClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NginxCertificateClient.CertificatesCreateOrUpdate

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

payload := nginxcertificate.NginxCertificate{
	// ...
}


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

Example Usage: NginxCertificateClient.CertificatesDelete

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

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

Example Usage: NginxCertificateClient.CertificatesGet

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

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

Example Usage: NginxCertificateClient.CertificatesList

ctx := context.TODO()
id := nginxcertificate.NewNginxDeploymentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "nginxDeploymentValue")

// alternatively `client.CertificatesList(ctx, id)` can be used to do batched pagination
items, err := client.CertificatesListComplete(ctx, id)
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 PossibleValuesForProvisioningState 

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

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

ValidateNginxDeploymentID checks that 'input' can be parsed as a Nginx Deployment ID

Types

type CertificateId 

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

CertificateId is a struct representing the Resource ID for a Certificate

func NewCertificateID 

func NewCertificateID(subscriptionId string, resourceGroupName string, nginxDeploymentName 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 added in v0.20231127.1171502 

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 CertificatesCreateOrUpdateOperationResponse 

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

type CertificatesDeleteOperationResponse 

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

type CertificatesGetOperationResponse 

type CertificatesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NginxCertificate
}

type CertificatesListCompleteResult 

type CertificatesListCompleteResult struct {
	Items []NginxCertificate
}

type CertificatesListOperationResponse 

type CertificatesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]NginxCertificate
}

type NginxCertificate 

type NginxCertificate struct {
	Id         *string                     `json:"id,omitempty"`
	Location   *string                     `json:"location,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *NginxCertificateProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type NginxCertificateClient 

type NginxCertificateClient struct {
	Client *resourcemanager.Client
}

func NewNginxCertificateClientWithBaseURI 

func NewNginxCertificateClientWithBaseURI(sdkApi sdkEnv.Api) (*NginxCertificateClient, error)

func (NginxCertificateClient) CertificatesCreateOrUpdate 

func (c NginxCertificateClient) CertificatesCreateOrUpdate(ctx context.Context, id CertificateId, input NginxCertificate) (result CertificatesCreateOrUpdateOperationResponse, err error)

CertificatesCreateOrUpdate ...

func (NginxCertificateClient) CertificatesCreateOrUpdateThenPoll 

func (c NginxCertificateClient) CertificatesCreateOrUpdateThenPoll(ctx context.Context, id CertificateId, input NginxCertificate) error

CertificatesCreateOrUpdateThenPoll performs CertificatesCreateOrUpdate then polls until it's completed

func (NginxCertificateClient) CertificatesDelete 

func (c NginxCertificateClient) CertificatesDelete(ctx context.Context, id CertificateId) (result CertificatesDeleteOperationResponse, err error)

CertificatesDelete ...

func (NginxCertificateClient) CertificatesDeleteThenPoll 

func (c NginxCertificateClient) CertificatesDeleteThenPoll(ctx context.Context, id CertificateId) error

CertificatesDeleteThenPoll performs CertificatesDelete then polls until it's completed

func (NginxCertificateClient) CertificatesGet 

func (c NginxCertificateClient) CertificatesGet(ctx context.Context, id CertificateId) (result CertificatesGetOperationResponse, err error)

CertificatesGet ...

func (NginxCertificateClient) CertificatesList 

func (c NginxCertificateClient) CertificatesList(ctx context.Context, id NginxDeploymentId) (result CertificatesListOperationResponse, err error)

CertificatesList ...

func (NginxCertificateClient) CertificatesListComplete 

func (c NginxCertificateClient) CertificatesListComplete(ctx context.Context, id NginxDeploymentId) (CertificatesListCompleteResult, error)

CertificatesListComplete retrieves all the results into a single object

func (NginxCertificateClient) CertificatesListCompleteMatchingPredicate 

func (c NginxCertificateClient) CertificatesListCompleteMatchingPredicate(ctx context.Context, id NginxDeploymentId, predicate NginxCertificateOperationPredicate) (result CertificatesListCompleteResult, err error)

CertificatesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type NginxCertificateOperationPredicate 

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

func (NginxCertificateOperationPredicate) Matches 

func (p NginxCertificateOperationPredicate) Matches(input NginxCertificate) bool

type NginxCertificateProperties 

type NginxCertificateProperties struct {
	CertificateVirtualPath *string            `json:"certificateVirtualPath,omitempty"`
	KeyVaultSecretId       *string            `json:"keyVaultSecretId,omitempty"`
	KeyVirtualPath         *string            `json:"keyVirtualPath,omitempty"`
	ProvisioningState      *ProvisioningState `json:"provisioningState,omitempty"`
}

type NginxDeploymentId 

type NginxDeploymentId struct {
	SubscriptionId      string
	ResourceGroupName   string
	NginxDeploymentName string
}

NginxDeploymentId is a struct representing the Resource ID for a Nginx Deployment

func NewNginxDeploymentID 

func NewNginxDeploymentID(subscriptionId string, resourceGroupName string, nginxDeploymentName string) NginxDeploymentId

NewNginxDeploymentID returns a new NginxDeploymentId struct

func ParseNginxDeploymentID 

func ParseNginxDeploymentID(input string) (*NginxDeploymentId, error)

ParseNginxDeploymentID parses 'input' into a NginxDeploymentId

func ParseNginxDeploymentIDInsensitively 

func ParseNginxDeploymentIDInsensitively(input string) (*NginxDeploymentId, error)

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

func (*NginxDeploymentId) FromParseResult added in v0.20231127.1171502 

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

func (NginxDeploymentId) ID 

func (id NginxDeploymentId) ID() string

ID returns the formatted Nginx Deployment ID

func (NginxDeploymentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Nginx Deployment ID

func (NginxDeploymentId) String 

func (id NginxDeploymentId) String() string

String returns a human-readable description of this Nginx Deployment ID

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

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.