afdendpoints

package
v0.20241126.2320 Latest Latest
Warning

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

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

README

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

The afdendpoints 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/afdendpoints"

Client Initialization

client := afdendpoints.NewAFDEndpointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AFDEndpointsClient.Create

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

payload := afdendpoints.AFDEndpoint{
	// ...
}


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

Example Usage: AFDEndpointsClient.Delete

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

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

Example Usage: AFDEndpointsClient.Get

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

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

ctx := context.TODO()
id := afdendpoints.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: AFDEndpointsClient.ListResourceUsage

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

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

Example Usage: AFDEndpointsClient.PurgeContent

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

payload := afdendpoints.AfdPurgeParameters{
	// ...
}


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

Example Usage: AFDEndpointsClient.Update

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

payload := afdendpoints.AFDEndpointUpdateParameters{
	// ...
}


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

Example Usage: AFDEndpointsClient.ValidateCustomDomain

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

payload := afdendpoints.ValidateCustomDomainInput{
	// ...
}


read, err := client.ValidateCustomDomain(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 PossibleValuesForAfdProvisioningState 

func PossibleValuesForAfdProvisioningState() []string

func PossibleValuesForAutoGeneratedDomainNameLabelScope 

func PossibleValuesForAutoGeneratedDomainNameLabelScope() []string

func PossibleValuesForDeploymentStatus 

func PossibleValuesForDeploymentStatus() []string

func PossibleValuesForEnabledState 

func PossibleValuesForEnabledState() []string

func PossibleValuesForUsageUnit 

func PossibleValuesForUsageUnit() []string

func ValidateAfdEndpointID 

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

ValidateAfdEndpointID checks that 'input' can be parsed as a Afd Endpoint 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 AFDEndpoint 

type AFDEndpoint struct {
	Id         *string                `json:"id,omitempty"`
	Location   string                 `json:"location"`
	Name       *string                `json:"name,omitempty"`
	Properties *AFDEndpointProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type AFDEndpointOperationPredicate 

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

func (AFDEndpointOperationPredicate) Matches 

func (p AFDEndpointOperationPredicate) Matches(input AFDEndpoint) bool

type AFDEndpointProperties 

type AFDEndpointProperties struct {
	AutoGeneratedDomainNameLabelScope *AutoGeneratedDomainNameLabelScope `json:"autoGeneratedDomainNameLabelScope,omitempty"`
	DeploymentStatus                  *DeploymentStatus                  `json:"deploymentStatus,omitempty"`
	EnabledState                      *EnabledState                      `json:"enabledState,omitempty"`
	HostName                          *string                            `json:"hostName,omitempty"`
	ProfileName                       *string                            `json:"profileName,omitempty"`
	ProvisioningState                 *AfdProvisioningState              `json:"provisioningState,omitempty"`
}

type AFDEndpointPropertiesUpdateParameters 

type AFDEndpointPropertiesUpdateParameters struct {
	EnabledState *EnabledState `json:"enabledState,omitempty"`
	ProfileName  *string       `json:"profileName,omitempty"`
}

type AFDEndpointUpdateParameters 

type AFDEndpointUpdateParameters struct {
	Properties *AFDEndpointPropertiesUpdateParameters `json:"properties,omitempty"`
	Tags       *map[string]string                     `json:"tags,omitempty"`
}

type AFDEndpointsClient 

type AFDEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewAFDEndpointsClientWithBaseURI 

func NewAFDEndpointsClientWithBaseURI(sdkApi sdkEnv.Api) (*AFDEndpointsClient, error)

func (AFDEndpointsClient) Create 

func (c AFDEndpointsClient) Create(ctx context.Context, id AfdEndpointId, input AFDEndpoint) (result CreateOperationResponse, err error)

Create ...

func (AFDEndpointsClient) CreateThenPoll 

func (c AFDEndpointsClient) CreateThenPoll(ctx context.Context, id AfdEndpointId, input AFDEndpoint) error

CreateThenPoll performs Create then polls until it's completed

func (AFDEndpointsClient) Delete 

func (c AFDEndpointsClient) Delete(ctx context.Context, id AfdEndpointId) (result DeleteOperationResponse, err error)

Delete ...

func (AFDEndpointsClient) DeleteThenPoll 

func (c AFDEndpointsClient) DeleteThenPoll(ctx context.Context, id AfdEndpointId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AFDEndpointsClient) Get 

func (c AFDEndpointsClient) Get(ctx context.Context, id AfdEndpointId) (result GetOperationResponse, err error)

Get ...

func (AFDEndpointsClient) ListByProfile 

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

ListByProfile ...

func (AFDEndpointsClient) ListByProfileComplete 

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

ListByProfileComplete retrieves all the results into a single object

func (AFDEndpointsClient) ListByProfileCompleteMatchingPredicate 

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

ListByProfileCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AFDEndpointsClient) ListResourceUsage 

func (c AFDEndpointsClient) ListResourceUsage(ctx context.Context, id AfdEndpointId) (result ListResourceUsageOperationResponse, err error)

ListResourceUsage ...

func (AFDEndpointsClient) ListResourceUsageComplete 

func (c AFDEndpointsClient) ListResourceUsageComplete(ctx context.Context, id AfdEndpointId) (ListResourceUsageCompleteResult, error)

ListResourceUsageComplete retrieves all the results into a single object

func (AFDEndpointsClient) ListResourceUsageCompleteMatchingPredicate 

func (c AFDEndpointsClient) ListResourceUsageCompleteMatchingPredicate(ctx context.Context, id AfdEndpointId, predicate UsageOperationPredicate) (result ListResourceUsageCompleteResult, err error)

ListResourceUsageCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AFDEndpointsClient) PurgeContent 

func (c AFDEndpointsClient) PurgeContent(ctx context.Context, id AfdEndpointId, input AfdPurgeParameters) (result PurgeContentOperationResponse, err error)

PurgeContent ...

func (AFDEndpointsClient) PurgeContentThenPoll 

func (c AFDEndpointsClient) PurgeContentThenPoll(ctx context.Context, id AfdEndpointId, input AfdPurgeParameters) error

PurgeContentThenPoll performs PurgeContent then polls until it's completed

func (AFDEndpointsClient) Update 

func (c AFDEndpointsClient) Update(ctx context.Context, id AfdEndpointId, input AFDEndpointUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

func (AFDEndpointsClient) UpdateThenPoll 

func (c AFDEndpointsClient) UpdateThenPoll(ctx context.Context, id AfdEndpointId, input AFDEndpointUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

func (AFDEndpointsClient) ValidateCustomDomain 

func (c AFDEndpointsClient) ValidateCustomDomain(ctx context.Context, id AfdEndpointId, input ValidateCustomDomainInput) (result ValidateCustomDomainOperationResponse, err error)

ValidateCustomDomain ...

type AfdEndpointId 

type AfdEndpointId struct {
	SubscriptionId    string
	ResourceGroupName string
	ProfileName       string
	AfdEndpointName   string
}

AfdEndpointId is a struct representing the Resource ID for a Afd Endpoint

func NewAfdEndpointID 

func NewAfdEndpointID(subscriptionId string, resourceGroupName string, profileName string, afdEndpointName string) AfdEndpointId

NewAfdEndpointID returns a new AfdEndpointId struct

func ParseAfdEndpointID 

func ParseAfdEndpointID(input string) (*AfdEndpointId, error)

ParseAfdEndpointID parses 'input' into a AfdEndpointId

func ParseAfdEndpointIDInsensitively 

func ParseAfdEndpointIDInsensitively(input string) (*AfdEndpointId, error)

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

func (*AfdEndpointId) FromParseResult 

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

func (AfdEndpointId) ID 

func (id AfdEndpointId) ID() string

ID returns the formatted Afd Endpoint ID

func (AfdEndpointId) Segments 

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

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

func (AfdEndpointId) String 

func (id AfdEndpointId) String() string

String returns a human-readable description of this Afd Endpoint ID

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 AfdPurgeParameters 

type AfdPurgeParameters struct {
	ContentPaths []string  `json:"contentPaths"`
	Domains      *[]string `json:"domains,omitempty"`
}

type AutoGeneratedDomainNameLabelScope 

type AutoGeneratedDomainNameLabelScope string
const (
	AutoGeneratedDomainNameLabelScopeNoReuse            AutoGeneratedDomainNameLabelScope = "NoReuse"
	AutoGeneratedDomainNameLabelScopeResourceGroupReuse AutoGeneratedDomainNameLabelScope = "ResourceGroupReuse"
	AutoGeneratedDomainNameLabelScopeSubscriptionReuse  AutoGeneratedDomainNameLabelScope = "SubscriptionReuse"
	AutoGeneratedDomainNameLabelScopeTenantReuse        AutoGeneratedDomainNameLabelScope = "TenantReuse"
)

func (*AutoGeneratedDomainNameLabelScope) UnmarshalJSON 

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

type CreateOperationResponse 

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

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 EnabledState 

type EnabledState string
const (
	EnabledStateDisabled EnabledState = "Disabled"
	EnabledStateEnabled  EnabledState = "Enabled"
)

func (*EnabledState) UnmarshalJSON 

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

type GetOperationResponse 

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

type ListByProfileCompleteResult 

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

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        *[]AFDEndpoint
}

type ListResourceUsageCompleteResult 

type ListResourceUsageCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Usage
}

type ListResourceUsageCustomPager 

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

type ListResourceUsageOperationResponse 

type ListResourceUsageOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Usage
}

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 PurgeContentOperationResponse 

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

type UpdateOperationResponse 

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

type Usage 

type Usage struct {
	CurrentValue int64     `json:"currentValue"`
	Id           *string   `json:"id,omitempty"`
	Limit        int64     `json:"limit"`
	Name         UsageName `json:"name"`
	Unit         UsageUnit `json:"unit"`
}

type UsageName 

type UsageName struct {
	LocalizedValue *string `json:"localizedValue,omitempty"`
	Value          *string `json:"value,omitempty"`
}

type UsageOperationPredicate 

type UsageOperationPredicate struct {
	CurrentValue *int64
	Id           *string
	Limit        *int64
}

func (UsageOperationPredicate) Matches 

func (p UsageOperationPredicate) Matches(input Usage) bool

type UsageUnit 

type UsageUnit string
const (
	UsageUnitCount UsageUnit = "Count"
)

func (*UsageUnit) UnmarshalJSON 

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

type ValidateCustomDomainInput 

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

type ValidateCustomDomainOperationResponse 

type ValidateCustomDomainOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ValidateCustomDomainOutput
}

type ValidateCustomDomainOutput 

type ValidateCustomDomainOutput struct {
	CustomDomainValidated *bool   `json:"customDomainValidated,omitempty"`
	Message               *string `json:"message,omitempty"`
	Reason                *string `json:"reason,omitempty"`
}

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.