customdomains

package
v0.20241023.1122425 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/cdn/2024-02-01/customdomains Documentation

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

Client Initialization

client := customdomains.NewCustomDomainsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CustomDomainsClient.Create

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

payload := customdomains.CustomDomainParameters{
	// ...
}


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

Example Usage: CustomDomainsClient.Delete

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

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

Example Usage: CustomDomainsClient.DisableCustomHTTPS

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

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

Example Usage: CustomDomainsClient.EnableCustomHTTPS

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

payload := customdomains.CustomDomainHTTPSParameters{
	// ...
}


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

Example Usage: CustomDomainsClient.Get

ctx := context.TODO()
id := customdomains.NewEndpointCustomDomainID("12345678-1234-9876-4563-123456789012", "example-resource-group", "profileName", "endpointName", "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: CustomDomainsClient.ListByEndpoint

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

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

func PossibleValuesForCertificateSource() []string

func PossibleValuesForCertificateSourceParametersType

func PossibleValuesForCertificateSourceParametersType() []string

func PossibleValuesForCertificateType

func PossibleValuesForCertificateType() []string

func PossibleValuesForCustomDomainResourceState

func PossibleValuesForCustomDomainResourceState() []string

func PossibleValuesForCustomHTTPSProvisioningState

func PossibleValuesForCustomHTTPSProvisioningState() []string

func PossibleValuesForCustomHTTPSProvisioningSubstate

func PossibleValuesForCustomHTTPSProvisioningSubstate() []string

func PossibleValuesForDeleteRule

func PossibleValuesForDeleteRule() []string

func PossibleValuesForMinimumTlsVersion

func PossibleValuesForMinimumTlsVersion() []string

func PossibleValuesForProtocolType

func PossibleValuesForProtocolType() []string

func PossibleValuesForUpdateRule

func PossibleValuesForUpdateRule() []string

func ValidateEndpointCustomDomainID

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

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

func ValidateEndpointID

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

ValidateEndpointID checks that 'input' can be parsed as a Endpoint ID

Types

type BaseCertificateSourceParametersImpl

type BaseCertificateSourceParametersImpl struct {
	TypeName CertificateSourceParametersType `json:"typeName"`
}

func (BaseCertificateSourceParametersImpl) CertificateSourceParameters

type BaseCustomDomainHTTPSParametersImpl

type BaseCustomDomainHTTPSParametersImpl struct {
	CertificateSource CertificateSource  `json:"certificateSource"`
	MinimumTlsVersion *MinimumTlsVersion `json:"minimumTlsVersion,omitempty"`
	ProtocolType      ProtocolType       `json:"protocolType"`
}

func (BaseCustomDomainHTTPSParametersImpl) CustomDomainHTTPSParameters

type CdnCertificateSourceParameters

type CdnCertificateSourceParameters struct {
	CertificateType CertificateType `json:"certificateType"`

	TypeName CertificateSourceParametersType `json:"typeName"`
}

func (CdnCertificateSourceParameters) CertificateSourceParameters

func (CdnCertificateSourceParameters) MarshalJSON

func (s CdnCertificateSourceParameters) MarshalJSON() ([]byte, error)

type CdnManagedHTTPSParameters

type CdnManagedHTTPSParameters struct {
	CertificateSourceParameters CdnCertificateSourceParameters `json:"certificateSourceParameters"`

	CertificateSource CertificateSource  `json:"certificateSource"`
	MinimumTlsVersion *MinimumTlsVersion `json:"minimumTlsVersion,omitempty"`
	ProtocolType      ProtocolType       `json:"protocolType"`
}

func (CdnManagedHTTPSParameters) CustomDomainHTTPSParameters

func (s CdnManagedHTTPSParameters) CustomDomainHTTPSParameters() BaseCustomDomainHTTPSParametersImpl

func (CdnManagedHTTPSParameters) MarshalJSON

func (s CdnManagedHTTPSParameters) MarshalJSON() ([]byte, error)

type CertificateSource

type CertificateSource string
const (
	CertificateSourceAzureKeyVault CertificateSource = "AzureKeyVault"
	CertificateSourceCdn           CertificateSource = "Cdn"
)

func (*CertificateSource) UnmarshalJSON

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

type CertificateSourceParameters

type CertificateSourceParameters interface {
	CertificateSourceParameters() BaseCertificateSourceParametersImpl
}

func UnmarshalCertificateSourceParametersImplementation

func UnmarshalCertificateSourceParametersImplementation(input []byte) (CertificateSourceParameters, error)

type CertificateSourceParametersType

type CertificateSourceParametersType string
const (
	CertificateSourceParametersTypeCdnCertificateSourceParameters      CertificateSourceParametersType = "CdnCertificateSourceParameters"
	CertificateSourceParametersTypeKeyVaultCertificateSourceParameters CertificateSourceParametersType = "KeyVaultCertificateSourceParameters"
)

func (*CertificateSourceParametersType) UnmarshalJSON

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

type CertificateType

type CertificateType string
const (
	CertificateTypeDedicated CertificateType = "Dedicated"
	CertificateTypeShared    CertificateType = "Shared"
)

func (*CertificateType) UnmarshalJSON

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

type CreateOperationResponse

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

type CustomDomain

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

type CustomDomainHTTPSParameters

type CustomDomainHTTPSParameters interface {
	CustomDomainHTTPSParameters() BaseCustomDomainHTTPSParametersImpl
}

func UnmarshalCustomDomainHTTPSParametersImplementation

func UnmarshalCustomDomainHTTPSParametersImplementation(input []byte) (CustomDomainHTTPSParameters, error)

type CustomDomainOperationPredicate

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

func (CustomDomainOperationPredicate) Matches

type CustomDomainParameters

type CustomDomainParameters struct {
	Properties *CustomDomainPropertiesParameters `json:"properties,omitempty"`
}

type CustomDomainProperties

type CustomDomainProperties struct {
	CustomHTTPSParameters           CustomDomainHTTPSParameters      `json:"customHttpsParameters"`
	CustomHTTPSProvisioningState    *CustomHTTPSProvisioningState    `json:"customHttpsProvisioningState,omitempty"`
	CustomHTTPSProvisioningSubstate *CustomHTTPSProvisioningSubstate `json:"customHttpsProvisioningSubstate,omitempty"`
	HostName                        string                           `json:"hostName"`
	ProvisioningState               *CustomHTTPSProvisioningState    `json:"provisioningState,omitempty"`
	ResourceState                   *CustomDomainResourceState       `json:"resourceState,omitempty"`
	ValidationData                  *string                          `json:"validationData,omitempty"`
}

func (*CustomDomainProperties) UnmarshalJSON

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

type CustomDomainPropertiesParameters

type CustomDomainPropertiesParameters struct {
	HostName string `json:"hostName"`
}

type CustomDomainResourceState

type CustomDomainResourceState string
const (
	CustomDomainResourceStateActive   CustomDomainResourceState = "Active"
	CustomDomainResourceStateCreating CustomDomainResourceState = "Creating"
	CustomDomainResourceStateDeleting CustomDomainResourceState = "Deleting"
)

func (*CustomDomainResourceState) UnmarshalJSON

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

type CustomDomainsClient

type CustomDomainsClient struct {
	Client *resourcemanager.Client
}

func NewCustomDomainsClientWithBaseURI

func NewCustomDomainsClientWithBaseURI(sdkApi sdkEnv.Api) (*CustomDomainsClient, error)

func (CustomDomainsClient) Create

Create ...

func (CustomDomainsClient) CreateThenPoll

CreateThenPoll performs Create then polls until it's completed

func (CustomDomainsClient) Delete

Delete ...

func (CustomDomainsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (CustomDomainsClient) DisableCustomHTTPS

DisableCustomHTTPS ...

func (CustomDomainsClient) DisableCustomHTTPSThenPoll

func (c CustomDomainsClient) DisableCustomHTTPSThenPoll(ctx context.Context, id EndpointCustomDomainId) error

DisableCustomHTTPSThenPoll performs DisableCustomHTTPS then polls until it's completed

func (CustomDomainsClient) EnableCustomHTTPS

EnableCustomHTTPS ...

func (CustomDomainsClient) EnableCustomHTTPSThenPoll

func (c CustomDomainsClient) EnableCustomHTTPSThenPoll(ctx context.Context, id EndpointCustomDomainId, input CustomDomainHTTPSParameters) error

EnableCustomHTTPSThenPoll performs EnableCustomHTTPS then polls until it's completed

func (CustomDomainsClient) Get

Get ...

func (CustomDomainsClient) ListByEndpoint

func (c CustomDomainsClient) ListByEndpoint(ctx context.Context, id EndpointId) (result ListByEndpointOperationResponse, err error)

ListByEndpoint ...

func (CustomDomainsClient) ListByEndpointComplete

func (c CustomDomainsClient) ListByEndpointComplete(ctx context.Context, id EndpointId) (ListByEndpointCompleteResult, error)

ListByEndpointComplete retrieves all the results into a single object

func (CustomDomainsClient) ListByEndpointCompleteMatchingPredicate

func (c CustomDomainsClient) ListByEndpointCompleteMatchingPredicate(ctx context.Context, id EndpointId, predicate CustomDomainOperationPredicate) (result ListByEndpointCompleteResult, err error)

ListByEndpointCompleteMatchingPredicate retrieves all the results and then applies the predicate

type CustomHTTPSProvisioningState

type CustomHTTPSProvisioningState string
const (
	CustomHTTPSProvisioningStateDisabled  CustomHTTPSProvisioningState = "Disabled"
	CustomHTTPSProvisioningStateDisabling CustomHTTPSProvisioningState = "Disabling"
	CustomHTTPSProvisioningStateEnabled   CustomHTTPSProvisioningState = "Enabled"
	CustomHTTPSProvisioningStateEnabling  CustomHTTPSProvisioningState = "Enabling"
	CustomHTTPSProvisioningStateFailed    CustomHTTPSProvisioningState = "Failed"
)

func (*CustomHTTPSProvisioningState) UnmarshalJSON

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

type CustomHTTPSProvisioningSubstate

type CustomHTTPSProvisioningSubstate string
const (
	CustomHTTPSProvisioningSubstateCertificateDeleted                            CustomHTTPSProvisioningSubstate = "CertificateDeleted"
	CustomHTTPSProvisioningSubstateCertificateDeployed                           CustomHTTPSProvisioningSubstate = "CertificateDeployed"
	CustomHTTPSProvisioningSubstateDeletingCertificate                           CustomHTTPSProvisioningSubstate = "DeletingCertificate"
	CustomHTTPSProvisioningSubstateDeployingCertificate                          CustomHTTPSProvisioningSubstate = "DeployingCertificate"
	CustomHTTPSProvisioningSubstateDomainControlValidationRequestApproved        CustomHTTPSProvisioningSubstate = "DomainControlValidationRequestApproved"
	CustomHTTPSProvisioningSubstateDomainControlValidationRequestRejected        CustomHTTPSProvisioningSubstate = "DomainControlValidationRequestRejected"
	CustomHTTPSProvisioningSubstateDomainControlValidationRequestTimedOut        CustomHTTPSProvisioningSubstate = "DomainControlValidationRequestTimedOut"
	CustomHTTPSProvisioningSubstateIssuingCertificate                            CustomHTTPSProvisioningSubstate = "IssuingCertificate"
	CustomHTTPSProvisioningSubstatePendingDomainControlValidationREquestApproval CustomHTTPSProvisioningSubstate = "PendingDomainControlValidationREquestApproval"
	CustomHTTPSProvisioningSubstateSubmittingDomainControlValidationRequest      CustomHTTPSProvisioningSubstate = "SubmittingDomainControlValidationRequest"
)

func (*CustomHTTPSProvisioningSubstate) UnmarshalJSON

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

type DeleteOperationResponse

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

type DeleteRule

type DeleteRule string
const (
	DeleteRuleNoAction DeleteRule = "NoAction"
)

func (*DeleteRule) UnmarshalJSON

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

type DisableCustomHTTPSOperationResponse

type DisableCustomHTTPSOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CustomDomain
}

type EnableCustomHTTPSOperationResponse

type EnableCustomHTTPSOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CustomDomain
}

type EndpointCustomDomainId

type EndpointCustomDomainId struct {
	SubscriptionId    string
	ResourceGroupName string
	ProfileName       string
	EndpointName      string
	CustomDomainName  string
}

EndpointCustomDomainId is a struct representing the Resource ID for a Endpoint Custom Domain

func NewEndpointCustomDomainID

func NewEndpointCustomDomainID(subscriptionId string, resourceGroupName string, profileName string, endpointName string, customDomainName string) EndpointCustomDomainId

NewEndpointCustomDomainID returns a new EndpointCustomDomainId struct

func ParseEndpointCustomDomainID

func ParseEndpointCustomDomainID(input string) (*EndpointCustomDomainId, error)

ParseEndpointCustomDomainID parses 'input' into a EndpointCustomDomainId

func ParseEndpointCustomDomainIDInsensitively

func ParseEndpointCustomDomainIDInsensitively(input string) (*EndpointCustomDomainId, error)

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

func (*EndpointCustomDomainId) FromParseResult

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

func (EndpointCustomDomainId) ID

ID returns the formatted Endpoint Custom Domain ID

func (EndpointCustomDomainId) Segments

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

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

func (EndpointCustomDomainId) String

func (id EndpointCustomDomainId) String() string

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

type EndpointId

type EndpointId struct {
	SubscriptionId    string
	ResourceGroupName string
	ProfileName       string
	EndpointName      string
}

EndpointId is a struct representing the Resource ID for a Endpoint

func NewEndpointID

func NewEndpointID(subscriptionId string, resourceGroupName string, profileName string, endpointName string) EndpointId

NewEndpointID returns a new EndpointId struct

func ParseEndpointID

func ParseEndpointID(input string) (*EndpointId, error)

ParseEndpointID parses 'input' into a EndpointId

func ParseEndpointIDInsensitively

func ParseEndpointIDInsensitively(input string) (*EndpointId, error)

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

func (*EndpointId) FromParseResult

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

func (EndpointId) ID

func (id EndpointId) ID() string

ID returns the formatted Endpoint ID

func (EndpointId) Segments

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

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

func (EndpointId) String

func (id EndpointId) String() string

String returns a human-readable description of this Endpoint ID

type GetOperationResponse

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

type KeyVaultCertificateSourceParameters

type KeyVaultCertificateSourceParameters struct {
	DeleteRule        DeleteRule `json:"deleteRule"`
	ResourceGroupName string     `json:"resourceGroupName"`
	SecretName        string     `json:"secretName"`
	SecretVersion     *string    `json:"secretVersion,omitempty"`
	SubscriptionId    string     `json:"subscriptionId"`
	UpdateRule        UpdateRule `json:"updateRule"`
	VaultName         string     `json:"vaultName"`

	TypeName CertificateSourceParametersType `json:"typeName"`
}

func (KeyVaultCertificateSourceParameters) CertificateSourceParameters

func (KeyVaultCertificateSourceParameters) MarshalJSON

func (s KeyVaultCertificateSourceParameters) MarshalJSON() ([]byte, error)

type ListByEndpointCompleteResult

type ListByEndpointCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CustomDomain
}

type ListByEndpointCustomPager

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

type ListByEndpointOperationResponse

type ListByEndpointOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]CustomDomain
}

type MinimumTlsVersion

type MinimumTlsVersion string
const (
	MinimumTlsVersionNone       MinimumTlsVersion = "None"
	MinimumTlsVersionTLSOneTwo  MinimumTlsVersion = "TLS12"
	MinimumTlsVersionTLSOneZero MinimumTlsVersion = "TLS10"
)

func (*MinimumTlsVersion) UnmarshalJSON

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

type ProtocolType

type ProtocolType string
const (
	ProtocolTypeIPBased              ProtocolType = "IPBased"
	ProtocolTypeServerNameIndication ProtocolType = "ServerNameIndication"
)

func (*ProtocolType) UnmarshalJSON

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

type RawCertificateSourceParametersImpl

type RawCertificateSourceParametersImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawCertificateSourceParametersImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawCertificateSourceParametersImpl) CertificateSourceParameters

type RawCustomDomainHTTPSParametersImpl

type RawCustomDomainHTTPSParametersImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawCustomDomainHTTPSParametersImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawCustomDomainHTTPSParametersImpl) CustomDomainHTTPSParameters

type UpdateRule

type UpdateRule string
const (
	UpdateRuleNoAction UpdateRule = "NoAction"
)

func (*UpdateRule) UnmarshalJSON

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

type UserManagedHTTPSParameters

type UserManagedHTTPSParameters struct {
	CertificateSourceParameters KeyVaultCertificateSourceParameters `json:"certificateSourceParameters"`

	CertificateSource CertificateSource  `json:"certificateSource"`
	MinimumTlsVersion *MinimumTlsVersion `json:"minimumTlsVersion,omitempty"`
	ProtocolType      ProtocolType       `json:"protocolType"`
}

func (UserManagedHTTPSParameters) CustomDomainHTTPSParameters

func (s UserManagedHTTPSParameters) CustomDomainHTTPSParameters() BaseCustomDomainHTTPSParametersImpl

func (UserManagedHTTPSParameters) MarshalJSON

func (s UserManagedHTTPSParameters) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

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