afdcustomdomains

package
v0.20241017.1093842 Latest Latest
Warning

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

 Go to latest Published: Oct 17, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/cdn/2024-09-01/afdcustomdomains Documentation

The afdcustomdomains SDK allows for interaction with Azure Resource Manager cdn (API Version 2024-09-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/cdn/2024-09-01/afdcustomdomains"

Client Initialization

client := afdcustomdomains.NewAFDCustomDomainsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AFDCustomDomainsClient.Create

ctx := context.TODO()
id := afdcustomdomains.NewCustomDomainID("12345678-1234-9876-4563-123456789012", "example-resource-group", "profileName", "customDomainName")

payload := afdcustomdomains.AFDDomain{
	// ...
}


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

Example Usage: AFDCustomDomainsClient.Delete

ctx := context.TODO()
id := afdcustomdomains.NewCustomDomainID("12345678-1234-9876-4563-123456789012", "example-resource-group", "profileName", "customDomainName")

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

Example Usage: AFDCustomDomainsClient.Get

ctx := context.TODO()
id := afdcustomdomains.NewCustomDomainID("12345678-1234-9876-4563-123456789012", "example-resource-group", "profileName", "customDomainName")

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: AFDCustomDomainsClient.ListByProfile

ctx := context.TODO()
id := afdcustomdomains.NewProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "profileName")

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

Example Usage: AFDCustomDomainsClient.RefreshValidationToken

ctx := context.TODO()
id := afdcustomdomains.NewCustomDomainID("12345678-1234-9876-4563-123456789012", "example-resource-group", "profileName", "customDomainName")

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

Example Usage: AFDCustomDomainsClient.Update

ctx := context.TODO()
id := afdcustomdomains.NewCustomDomainID("12345678-1234-9876-4563-123456789012", "example-resource-group", "profileName", "customDomainName")

payload := afdcustomdomains.AFDDomainUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAfdCertificateType 

func PossibleValuesForAfdCertificateType() []string

func PossibleValuesForAfdMinimumTlsVersion 

func PossibleValuesForAfdMinimumTlsVersion() []string

func PossibleValuesForAfdProvisioningState 

func PossibleValuesForAfdProvisioningState() []string

func PossibleValuesForDeploymentStatus 

func PossibleValuesForDeploymentStatus() []string

func PossibleValuesForDomainValidationState 

func PossibleValuesForDomainValidationState() []string

func ValidateCustomDomainID 

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

ValidateCustomDomainID checks that 'input' can be parsed as a Custom Domain ID

func ValidateProfileID 

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

ValidateProfileID checks that 'input' can be parsed as a Profile ID

Types

type AFDCustomDomainsClient 

type AFDCustomDomainsClient struct {
	Client *resourcemanager.Client
}

func NewAFDCustomDomainsClientWithBaseURI 

func NewAFDCustomDomainsClientWithBaseURI(sdkApi sdkEnv.Api) (*AFDCustomDomainsClient, error)

func (AFDCustomDomainsClient) Create 

func (c AFDCustomDomainsClient) Create(ctx context.Context, id CustomDomainId, input AFDDomain) (result CreateOperationResponse, err error)

Create ...

func (AFDCustomDomainsClient) CreateThenPoll 

func (c AFDCustomDomainsClient) CreateThenPoll(ctx context.Context, id CustomDomainId, input AFDDomain) error

CreateThenPoll performs Create then polls until it's completed

func (AFDCustomDomainsClient) Delete 

func (c AFDCustomDomainsClient) Delete(ctx context.Context, id CustomDomainId) (result DeleteOperationResponse, err error)

Delete ...

func (AFDCustomDomainsClient) DeleteThenPoll 

func (c AFDCustomDomainsClient) DeleteThenPoll(ctx context.Context, id CustomDomainId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AFDCustomDomainsClient) Get 

func (c AFDCustomDomainsClient) Get(ctx context.Context, id CustomDomainId) (result GetOperationResponse, err error)

Get ...

func (AFDCustomDomainsClient) ListByProfile 

func (c AFDCustomDomainsClient) ListByProfile(ctx context.Context, id ProfileId) (result ListByProfileOperationResponse, err error)

ListByProfile ...

func (AFDCustomDomainsClient) ListByProfileComplete 

func (c AFDCustomDomainsClient) ListByProfileComplete(ctx context.Context, id ProfileId) (ListByProfileCompleteResult, error)

ListByProfileComplete retrieves all the results into a single object

func (AFDCustomDomainsClient) ListByProfileCompleteMatchingPredicate 

func (c AFDCustomDomainsClient) ListByProfileCompleteMatchingPredicate(ctx context.Context, id ProfileId, predicate AFDDomainOperationPredicate) (result ListByProfileCompleteResult, err error)

ListByProfileCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AFDCustomDomainsClient) RefreshValidationToken 

func (c AFDCustomDomainsClient) RefreshValidationToken(ctx context.Context, id CustomDomainId) (result RefreshValidationTokenOperationResponse, err error)

RefreshValidationToken ...

func (AFDCustomDomainsClient) RefreshValidationTokenThenPoll 

func (c AFDCustomDomainsClient) RefreshValidationTokenThenPoll(ctx context.Context, id CustomDomainId) error

RefreshValidationTokenThenPoll performs RefreshValidationToken then polls until it's completed

func (AFDCustomDomainsClient) Update 

func (c AFDCustomDomainsClient) Update(ctx context.Context, id CustomDomainId, input AFDDomainUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

func (AFDCustomDomainsClient) UpdateThenPoll 

func (c AFDCustomDomainsClient) UpdateThenPoll(ctx context.Context, id CustomDomainId, input AFDDomainUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

type AFDDomain 

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

type AFDDomainHTTPSParameters 

type AFDDomainHTTPSParameters struct {
	CertificateType   AfdCertificateType    `json:"certificateType"`
	MinimumTlsVersion *AfdMinimumTlsVersion `json:"minimumTlsVersion,omitempty"`
	Secret            *ResourceReference    `json:"secret,omitempty"`
}

type AFDDomainOperationPredicate 

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

func (AFDDomainOperationPredicate) Matches 

func (p AFDDomainOperationPredicate) Matches(input AFDDomain) bool

type AFDDomainProperties 

type AFDDomainProperties struct {
	AzureDnsZone                       *ResourceReference          `json:"azureDnsZone,omitempty"`
	DeploymentStatus                   *DeploymentStatus           `json:"deploymentStatus,omitempty"`
	DomainValidationState              *DomainValidationState      `json:"domainValidationState,omitempty"`
	ExtendedProperties                 *map[string]string          `json:"extendedProperties,omitempty"`
	HostName                           string                      `json:"hostName"`
	PreValidatedCustomDomainResourceId *ResourceReference          `json:"preValidatedCustomDomainResourceId,omitempty"`
	ProfileName                        *string                     `json:"profileName,omitempty"`
	ProvisioningState                  *AfdProvisioningState       `json:"provisioningState,omitempty"`
	TlsSettings                        *AFDDomainHTTPSParameters   `json:"tlsSettings,omitempty"`
	ValidationProperties               *DomainValidationProperties `json:"validationProperties,omitempty"`
}

type AFDDomainUpdateParameters 

type AFDDomainUpdateParameters struct {
	Properties *AFDDomainUpdatePropertiesParameters `json:"properties,omitempty"`
}

type AFDDomainUpdatePropertiesParameters 

type AFDDomainUpdatePropertiesParameters struct {
	AzureDnsZone                       *ResourceReference        `json:"azureDnsZone,omitempty"`
	PreValidatedCustomDomainResourceId *ResourceReference        `json:"preValidatedCustomDomainResourceId,omitempty"`
	ProfileName                        *string                   `json:"profileName,omitempty"`
	TlsSettings                        *AFDDomainHTTPSParameters `json:"tlsSettings,omitempty"`
}

type AfdCertificateType 

type AfdCertificateType string
const (
	AfdCertificateTypeAzureFirstPartyManagedCertificate AfdCertificateType = "AzureFirstPartyManagedCertificate"
	AfdCertificateTypeCustomerCertificate               AfdCertificateType = "CustomerCertificate"
	AfdCertificateTypeManagedCertificate                AfdCertificateType = "ManagedCertificate"
)

func (*AfdCertificateType) UnmarshalJSON 

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

type AfdMinimumTlsVersion 

type AfdMinimumTlsVersion string
const (
	AfdMinimumTlsVersionTLSOneTwo  AfdMinimumTlsVersion = "TLS12"
	AfdMinimumTlsVersionTLSOneZero AfdMinimumTlsVersion = "TLS10"
)

func (*AfdMinimumTlsVersion) UnmarshalJSON 

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

type AfdProvisioningState 

type AfdProvisioningState string
const (
	AfdProvisioningStateCreating  AfdProvisioningState = "Creating"
	AfdProvisioningStateDeleting  AfdProvisioningState = "Deleting"
	AfdProvisioningStateFailed    AfdProvisioningState = "Failed"
	AfdProvisioningStateSucceeded AfdProvisioningState = "Succeeded"
	AfdProvisioningStateUpdating  AfdProvisioningState = "Updating"
)

func (*AfdProvisioningState) UnmarshalJSON 

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

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AFDDomain
}

type CustomDomainId 

type CustomDomainId struct {
	SubscriptionId    string
	ResourceGroupName string
	ProfileName       string
	CustomDomainName  string
}

CustomDomainId is a struct representing the Resource ID for a Custom Domain

func NewCustomDomainID 

func NewCustomDomainID(subscriptionId string, resourceGroupName string, profileName string, customDomainName string) CustomDomainId

NewCustomDomainID returns a new CustomDomainId struct

func ParseCustomDomainID 

func ParseCustomDomainID(input string) (*CustomDomainId, error)

ParseCustomDomainID parses 'input' into a CustomDomainId

func ParseCustomDomainIDInsensitively 

func ParseCustomDomainIDInsensitively(input string) (*CustomDomainId, error)

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

func (*CustomDomainId) FromParseResult 

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

func (CustomDomainId) ID 

func (id CustomDomainId) ID() string

ID returns the formatted Custom Domain ID

func (CustomDomainId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Custom Domain ID

func (CustomDomainId) String 

func (id CustomDomainId) String() string

String returns a human-readable description of this Custom Domain ID

type DeleteOperationResponse 

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

type DeploymentStatus 

type DeploymentStatus string
const (
	DeploymentStatusFailed     DeploymentStatus = "Failed"
	DeploymentStatusInProgress DeploymentStatus = "InProgress"
	DeploymentStatusNotStarted DeploymentStatus = "NotStarted"
	DeploymentStatusSucceeded  DeploymentStatus = "Succeeded"
)

func (*DeploymentStatus) UnmarshalJSON 

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

type DomainValidationProperties 

type DomainValidationProperties struct {
	ExpirationDate  *string `json:"expirationDate,omitempty"`
	ValidationToken *string `json:"validationToken,omitempty"`
}

type DomainValidationState 

type DomainValidationState string
const (
	DomainValidationStateApproved                  DomainValidationState = "Approved"
	DomainValidationStateInternalError             DomainValidationState = "InternalError"
	DomainValidationStatePending                   DomainValidationState = "Pending"
	DomainValidationStatePendingRevalidation       DomainValidationState = "PendingRevalidation"
	DomainValidationStateRefreshingValidationToken DomainValidationState = "RefreshingValidationToken"
	DomainValidationStateRejected                  DomainValidationState = "Rejected"
	DomainValidationStateSubmitting                DomainValidationState = "Submitting"
	DomainValidationStateTimedOut                  DomainValidationState = "TimedOut"
	DomainValidationStateUnknown                   DomainValidationState = "Unknown"
)

func (*DomainValidationState) UnmarshalJSON 

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

type GetOperationResponse 

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

type ListByProfileCompleteResult 

type ListByProfileCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AFDDomain
}

type ListByProfileCustomPager 

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

type ListByProfileOperationResponse 

type ListByProfileOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AFDDomain
}

type ProfileId 

type ProfileId struct {
	SubscriptionId    string
	ResourceGroupName string
	ProfileName       string
}

ProfileId is a struct representing the Resource ID for a Profile

func NewProfileID 

func NewProfileID(subscriptionId string, resourceGroupName string, profileName string) ProfileId

NewProfileID returns a new ProfileId struct

func ParseProfileID 

func ParseProfileID(input string) (*ProfileId, error)

ParseProfileID parses 'input' into a ProfileId

func ParseProfileIDInsensitively 

func ParseProfileIDInsensitively(input string) (*ProfileId, error)

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

func (*ProfileId) FromParseResult 

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

func (ProfileId) ID 

func (id ProfileId) ID() string

ID returns the formatted Profile ID

func (ProfileId) Segments 

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

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

func (ProfileId) String 

func (id ProfileId) String() string

String returns a human-readable description of this Profile ID

type RefreshValidationTokenOperationResponse 

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

type ResourceReference 

type ResourceReference struct {
	Id *string `json:"id,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AFDDomain
}

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.