afdprofiles

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: 14 Imported by: 1

README

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

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

Client Initialization

client := afdprofiles.NewAFDProfilesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AFDProfilesClient.CheckEndpointNameAvailability

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

payload := afdprofiles.CheckEndpointNameAvailabilityInput{
	// ...
}


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

Example Usage: AFDProfilesClient.CheckHostNameAvailability

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

payload := afdprofiles.CheckHostNameAvailabilityInput{
	// ...
}


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

Example Usage: AFDProfilesClient.ListResourceUsage

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

// 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: AFDProfilesClient.Upgrade

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

payload := afdprofiles.ProfileUpgradeParameters{
	// ...
}


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

Example Usage: AFDProfilesClient.ValidateSecret

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

payload := afdprofiles.ValidateSecretInput{
	// ...
}


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

func PossibleValuesForAutoGeneratedDomainNameLabelScope() []string

func PossibleValuesForProfileProvisioningState 

func PossibleValuesForProfileProvisioningState() []string

func PossibleValuesForProfileResourceState 

func PossibleValuesForProfileResourceState() []string

func PossibleValuesForProfileScrubbingState 

func PossibleValuesForProfileScrubbingState() []string

func PossibleValuesForResourceType 

func PossibleValuesForResourceType() []string

func PossibleValuesForScrubbingRuleEntryMatchOperator 

func PossibleValuesForScrubbingRuleEntryMatchOperator() []string

func PossibleValuesForScrubbingRuleEntryMatchVariable 

func PossibleValuesForScrubbingRuleEntryMatchVariable() []string

func PossibleValuesForScrubbingRuleEntryState 

func PossibleValuesForScrubbingRuleEntryState() []string

func PossibleValuesForSecretType 

func PossibleValuesForSecretType() []string

func PossibleValuesForSkuName 

func PossibleValuesForSkuName() []string

func PossibleValuesForStatus 

func PossibleValuesForStatus() []string

func PossibleValuesForUsageUnit 

func PossibleValuesForUsageUnit() []string

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 AFDProfilesClient 

type AFDProfilesClient struct {
	Client *resourcemanager.Client
}

func NewAFDProfilesClientWithBaseURI 

func NewAFDProfilesClientWithBaseURI(sdkApi sdkEnv.Api) (*AFDProfilesClient, error)

func (AFDProfilesClient) CheckEndpointNameAvailability 

func (c AFDProfilesClient) CheckEndpointNameAvailability(ctx context.Context, id ProfileId, input CheckEndpointNameAvailabilityInput) (result CheckEndpointNameAvailabilityOperationResponse, err error)

CheckEndpointNameAvailability ...

func (AFDProfilesClient) CheckHostNameAvailability 

func (c AFDProfilesClient) CheckHostNameAvailability(ctx context.Context, id ProfileId, input CheckHostNameAvailabilityInput) (result CheckHostNameAvailabilityOperationResponse, err error)

CheckHostNameAvailability ...

func (AFDProfilesClient) ListResourceUsage 

func (c AFDProfilesClient) ListResourceUsage(ctx context.Context, id ProfileId) (result ListResourceUsageOperationResponse, err error)

ListResourceUsage ...

func (AFDProfilesClient) ListResourceUsageComplete 

func (c AFDProfilesClient) ListResourceUsageComplete(ctx context.Context, id ProfileId) (ListResourceUsageCompleteResult, error)

ListResourceUsageComplete retrieves all the results into a single object

func (AFDProfilesClient) ListResourceUsageCompleteMatchingPredicate 

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

ListResourceUsageCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AFDProfilesClient) Upgrade 

func (c AFDProfilesClient) Upgrade(ctx context.Context, id ProfileId, input ProfileUpgradeParameters) (result UpgradeOperationResponse, err error)

Upgrade ...

func (AFDProfilesClient) UpgradeThenPoll 

func (c AFDProfilesClient) UpgradeThenPoll(ctx context.Context, id ProfileId, input ProfileUpgradeParameters) error

UpgradeThenPoll performs Upgrade then polls until it's completed

func (AFDProfilesClient) ValidateSecret 

func (c AFDProfilesClient) ValidateSecret(ctx context.Context, id ProfileId, input ValidateSecretInput) (result ValidateSecretOperationResponse, err error)

ValidateSecret ...

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 CheckEndpointNameAvailabilityInput 

type CheckEndpointNameAvailabilityInput struct {
	AutoGeneratedDomainNameLabelScope *AutoGeneratedDomainNameLabelScope `json:"autoGeneratedDomainNameLabelScope,omitempty"`
	Name                              string                             `json:"name"`
	Type                              ResourceType                       `json:"type"`
}

type CheckEndpointNameAvailabilityOperationResponse 

type CheckEndpointNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckEndpointNameAvailabilityOutput
}

type CheckEndpointNameAvailabilityOutput 

type CheckEndpointNameAvailabilityOutput struct {
	AvailableHostname *string `json:"availableHostname,omitempty"`
	Message           *string `json:"message,omitempty"`
	NameAvailable     *bool   `json:"nameAvailable,omitempty"`
	Reason            *string `json:"reason,omitempty"`
}

type CheckHostNameAvailabilityInput 

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

type CheckHostNameAvailabilityOperationResponse 

type CheckHostNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckNameAvailabilityOutput
}

type CheckNameAvailabilityOutput 

type CheckNameAvailabilityOutput struct {
	Message       *string `json:"message,omitempty"`
	NameAvailable *bool   `json:"nameAvailable,omitempty"`
	Reason        *string `json:"reason,omitempty"`
}

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 Profile 

type Profile struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Kind       *string                            `json:"kind,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties *ProfileProperties                 `json:"properties,omitempty"`
	Sku        Sku                                `json:"sku"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type ProfileChangeSkuWafMapping 

type ProfileChangeSkuWafMapping struct {
	ChangeToWafPolicy  ResourceReference `json:"changeToWafPolicy"`
	SecurityPolicyName string            `json:"securityPolicyName"`
}

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 ProfileLogScrubbing 

type ProfileLogScrubbing struct {
	ScrubbingRules *[]ProfileScrubbingRules `json:"scrubbingRules,omitempty"`
	State          *ProfileScrubbingState   `json:"state,omitempty"`
}

type ProfileProperties 

type ProfileProperties struct {
	ExtendedProperties           *map[string]string        `json:"extendedProperties,omitempty"`
	FrontDoorId                  *string                   `json:"frontDoorId,omitempty"`
	LogScrubbing                 *ProfileLogScrubbing      `json:"logScrubbing,omitempty"`
	OriginResponseTimeoutSeconds *int64                    `json:"originResponseTimeoutSeconds,omitempty"`
	ProvisioningState            *ProfileProvisioningState `json:"provisioningState,omitempty"`
	ResourceState                *ProfileResourceState     `json:"resourceState,omitempty"`
}

type ProfileProvisioningState 

type ProfileProvisioningState string
const (
	ProfileProvisioningStateCreating  ProfileProvisioningState = "Creating"
	ProfileProvisioningStateDeleting  ProfileProvisioningState = "Deleting"
	ProfileProvisioningStateFailed    ProfileProvisioningState = "Failed"
	ProfileProvisioningStateSucceeded ProfileProvisioningState = "Succeeded"
	ProfileProvisioningStateUpdating  ProfileProvisioningState = "Updating"
)

func (*ProfileProvisioningState) UnmarshalJSON 

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

type ProfileResourceState 

type ProfileResourceState string
const (
	ProfileResourceStateAbortingMigration      ProfileResourceState = "AbortingMigration"
	ProfileResourceStateActive                 ProfileResourceState = "Active"
	ProfileResourceStateCommittingMigration    ProfileResourceState = "CommittingMigration"
	ProfileResourceStateCreating               ProfileResourceState = "Creating"
	ProfileResourceStateDeleting               ProfileResourceState = "Deleting"
	ProfileResourceStateDisabled               ProfileResourceState = "Disabled"
	ProfileResourceStateMigrated               ProfileResourceState = "Migrated"
	ProfileResourceStateMigrating              ProfileResourceState = "Migrating"
	ProfileResourceStatePendingMigrationCommit ProfileResourceState = "PendingMigrationCommit"
)

func (*ProfileResourceState) UnmarshalJSON 

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

type ProfileScrubbingRules 

type ProfileScrubbingRules struct {
	MatchVariable         ScrubbingRuleEntryMatchVariable `json:"matchVariable"`
	Selector              *string                         `json:"selector,omitempty"`
	SelectorMatchOperator ScrubbingRuleEntryMatchOperator `json:"selectorMatchOperator"`
	State                 *ScrubbingRuleEntryState        `json:"state,omitempty"`
}

type ProfileScrubbingState 

type ProfileScrubbingState string
const (
	ProfileScrubbingStateDisabled ProfileScrubbingState = "Disabled"
	ProfileScrubbingStateEnabled  ProfileScrubbingState = "Enabled"
)

func (*ProfileScrubbingState) UnmarshalJSON 

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

type ProfileUpgradeParameters 

type ProfileUpgradeParameters struct {
	WafMappingList []ProfileChangeSkuWafMapping `json:"wafMappingList"`
}

type ResourceReference 

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

type ResourceType 

type ResourceType string
const (
	ResourceTypeMicrosoftPointCdnProfilesAfdEndpoints ResourceType = "Microsoft.Cdn/Profiles/AfdEndpoints"
	ResourceTypeMicrosoftPointCdnProfilesEndpoints    ResourceType = "Microsoft.Cdn/Profiles/Endpoints"
)

func (*ResourceType) UnmarshalJSON 

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

type ScrubbingRuleEntryMatchOperator 

type ScrubbingRuleEntryMatchOperator string
const (
	ScrubbingRuleEntryMatchOperatorEqualsAny ScrubbingRuleEntryMatchOperator = "EqualsAny"
)

func (*ScrubbingRuleEntryMatchOperator) UnmarshalJSON 

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

type ScrubbingRuleEntryMatchVariable 

type ScrubbingRuleEntryMatchVariable string
const (
	ScrubbingRuleEntryMatchVariableQueryStringArgNames ScrubbingRuleEntryMatchVariable = "QueryStringArgNames"
	ScrubbingRuleEntryMatchVariableRequestIPAddress    ScrubbingRuleEntryMatchVariable = "RequestIPAddress"
	ScrubbingRuleEntryMatchVariableRequestUri          ScrubbingRuleEntryMatchVariable = "RequestUri"
)

func (*ScrubbingRuleEntryMatchVariable) UnmarshalJSON 

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

type ScrubbingRuleEntryState 

type ScrubbingRuleEntryState string
const (
	ScrubbingRuleEntryStateDisabled ScrubbingRuleEntryState = "Disabled"
	ScrubbingRuleEntryStateEnabled  ScrubbingRuleEntryState = "Enabled"
)

func (*ScrubbingRuleEntryState) UnmarshalJSON 

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

type SecretType 

type SecretType string
const (
	SecretTypeAzureFirstPartyManagedCertificate SecretType = "AzureFirstPartyManagedCertificate"
	SecretTypeCustomerCertificate               SecretType = "CustomerCertificate"
	SecretTypeManagedCertificate                SecretType = "ManagedCertificate"
	SecretTypeURLSigningKey                     SecretType = "UrlSigningKey"
)

func (*SecretType) UnmarshalJSON 

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

type Sku 

type Sku struct {
	Name *SkuName `json:"name,omitempty"`
}

type SkuName 

type SkuName string
const (
	SkuNameCustomVerizon                             SkuName = "Custom_Verizon"
	SkuNamePremiumAzureFrontDoor                     SkuName = "Premium_AzureFrontDoor"
	SkuNamePremiumVerizon                            SkuName = "Premium_Verizon"
	SkuNameStandardAkamai                            SkuName = "Standard_Akamai"
	SkuNameStandardAvgBandWidthChinaCdn              SkuName = "Standard_AvgBandWidth_ChinaCdn"
	SkuNameStandardAzureFrontDoor                    SkuName = "Standard_AzureFrontDoor"
	SkuNameStandardChinaCdn                          SkuName = "Standard_ChinaCdn"
	SkuNameStandardMicrosoft                         SkuName = "Standard_Microsoft"
	SkuNameStandardNineFiveFiveBandWidthChinaCdn     SkuName = "Standard_955BandWidth_ChinaCdn"
	SkuNameStandardPlusAvgBandWidthChinaCdn          SkuName = "StandardPlus_AvgBandWidth_ChinaCdn"
	SkuNameStandardPlusChinaCdn                      SkuName = "StandardPlus_ChinaCdn"
	SkuNameStandardPlusNineFiveFiveBandWidthChinaCdn SkuName = "StandardPlus_955BandWidth_ChinaCdn"
	SkuNameStandardVerizon                           SkuName = "Standard_Verizon"
)

func (*SkuName) UnmarshalJSON 

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

type Status 

type Status string
const (
	StatusAccessDenied       Status = "AccessDenied"
	StatusCertificateExpired Status = "CertificateExpired"
	StatusInvalid            Status = "Invalid"
	StatusValid              Status = "Valid"
)

func (*Status) UnmarshalJSON 

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

type UpgradeOperationResponse 

type UpgradeOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Profile
}

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 ValidateSecretInput 

type ValidateSecretInput struct {
	SecretSource  ResourceReference `json:"secretSource"`
	SecretType    SecretType        `json:"secretType"`
	SecretVersion *string           `json:"secretVersion,omitempty"`
}

type ValidateSecretOperationResponse 

type ValidateSecretOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ValidateSecretOutput
}

type ValidateSecretOutput 

type ValidateSecretOutput struct {
	Message *string `json:"message,omitempty"`
	Status  *Status `json:"status,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.