frontdoor

package
v42.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: May 7, 2020 License: Apache-2.0 Imports: 9 Imported by: 219

Documentation

Overview

Package frontdoor implements the Azure ARM Frontdoor service API version .

FrontDoor Client

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Frontdoor
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type Action 

type Action string

Action enumerates the values for action. 

const (
	// Allow ...
	Allow Action = "Allow"
	// Block ...
	Block Action = "Block"
	// Log ...
	Log Action = "Log"
)

func PossibleActionValues 

func PossibleActionValues() []Action

PossibleActionValues returns an array of possible values for the Action const type.

type Availability 

type Availability string

Availability enumerates the values for availability. 

const (
	// Available ...
	Available Availability = "Available"
	// Unavailable ...
	Unavailable Availability = "Unavailable"
)

func PossibleAvailabilityValues 

func PossibleAvailabilityValues() []Availability

PossibleAvailabilityValues returns an array of possible values for the Availability const type.

type AzureAsyncOperationResult 

type AzureAsyncOperationResult struct {
	// Status - Status of the Azure async operation. Possible values are: 'InProgress', 'Succeeded', and 'Failed'. Possible values include: 'NetworkOperationStatusInProgress', 'NetworkOperationStatusSucceeded', 'NetworkOperationStatusFailed'
	Status NetworkOperationStatus `json:"status,omitempty"`
	Error  *Error                 `json:"error,omitempty"`
}

AzureAsyncOperationResult the response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

type AzureManagedOverrideRuleGroup 

type AzureManagedOverrideRuleGroup struct {
	// RuleGroupOverride - Describes override rule group. Possible values include: 'SQLInjection', 'XSS'
	RuleGroupOverride RuleGroupOverride `json:"ruleGroupOverride,omitempty"`
	// Action - Type of Actions. Possible values include: 'Allow', 'Block', 'Log'
	Action Action `json:"action,omitempty"`
}

AzureManagedOverrideRuleGroup defines contents of a web application rule

type AzureManagedRuleSet 

type AzureManagedRuleSet struct {
	// RuleGroupOverrides - List of azure managed provider override configuration (optional)
	RuleGroupOverrides *[]AzureManagedOverrideRuleGroup `json:"ruleGroupOverrides,omitempty"`
	// Priority - Describes priority of the rule
	Priority *int32 `json:"priority,omitempty"`
	// Version - defines version of the rule set
	Version *int32 `json:"version,omitempty"`
	// RuleSetType - Possible values include: 'RuleSetTypeUnknown', 'RuleSetTypeAzureManagedRuleSet'
	RuleSetType RuleSetType `json:"ruleSetType,omitempty"`
}

AzureManagedRuleSet describes azure managed provider.

func (AzureManagedRuleSet) AsAzureManagedRuleSet 

func (amrs AzureManagedRuleSet) AsAzureManagedRuleSet() (*AzureManagedRuleSet, bool)

AsAzureManagedRuleSet is the BasicManagedRuleSet implementation for AzureManagedRuleSet.

func (AzureManagedRuleSet) AsBasicManagedRuleSet 

func (amrs AzureManagedRuleSet) AsBasicManagedRuleSet() (BasicManagedRuleSet, bool)

AsBasicManagedRuleSet is the BasicManagedRuleSet implementation for AzureManagedRuleSet.

func (AzureManagedRuleSet) AsManagedRuleSet 

func (amrs AzureManagedRuleSet) AsManagedRuleSet() (*ManagedRuleSet, bool)

AsManagedRuleSet is the BasicManagedRuleSet implementation for AzureManagedRuleSet.

func (AzureManagedRuleSet) MarshalJSON 

func (amrs AzureManagedRuleSet) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureManagedRuleSet.

type Backend 

type Backend struct {
	// Address - Location of the backend (IP address or FQDN)
	Address *string `json:"address,omitempty"`
	// HTTPPort - The HTTP TCP port number. Must be between 1 and 65535.
	HTTPPort *int32 `json:"httpPort,omitempty"`
	// HTTPSPort - The HTTPS TCP port number. Must be between 1 and 65535.
	HTTPSPort *int32 `json:"httpsPort,omitempty"`
	// EnabledState - Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'EnabledStateEnumEnabled', 'EnabledStateEnumDisabled'
	EnabledState EnabledStateEnum `json:"enabledState,omitempty"`
	// Priority - Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.
	Priority *int32 `json:"priority,omitempty"`
	// Weight - Weight of this endpoint for load balancing purposes.
	Weight *int32 `json:"weight,omitempty"`
	// BackendHostHeader - The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.
	BackendHostHeader *string `json:"backendHostHeader,omitempty"`
}

Backend backend address of a frontDoor load balancer.

type BackendPool 

type BackendPool struct {
	// BackendPoolProperties - Properties of the Front Door Backend Pool
	*BackendPoolProperties `json:"properties,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
}

BackendPool a backend pool is a collection of backends that can be routed to.

func (BackendPool) MarshalJSON 

func (bp BackendPool) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BackendPool.

func (*BackendPool) UnmarshalJSON 

func (bp *BackendPool) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BackendPool struct.

type BackendPoolListResult 

type BackendPoolListResult struct {
	// Value - READ-ONLY; List of Backend Pools within a Front Door.
	Value *[]BackendPool `json:"value,omitempty"`
	// NextLink - URL to get the next set of BackendPool objects if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

BackendPoolListResult result of the request to list Backend Pools. It contains a list of Backend Pools objects and a URL link to get the next set of results.

type BackendPoolProperties 

type BackendPoolProperties struct {
	// ResourceState - Resource status. Possible values include: 'ResourceStateCreating', 'ResourceStateEnabling', 'ResourceStateEnabled', 'ResourceStateDisabling', 'ResourceStateDisabled', 'ResourceStateDeleting'
	ResourceState ResourceState `json:"resourceState,omitempty"`
	// Backends - The set of backends for this pool
	Backends *[]Backend `json:"backends,omitempty"`
	// LoadBalancingSettings - Load balancing settings for a backend pool
	LoadBalancingSettings *SubResource `json:"loadBalancingSettings,omitempty"`
	// HealthProbeSettings - L7 health probe settings for a backend pool
	HealthProbeSettings *SubResource `json:"healthProbeSettings,omitempty"`
}

BackendPoolProperties the JSON object that contains the properties required to create a routing rule.

type BackendPoolUpdateParameters 

type BackendPoolUpdateParameters struct {
	// Backends - The set of backends for this pool
	Backends *[]Backend `json:"backends,omitempty"`
	// LoadBalancingSettings - Load balancing settings for a backend pool
	LoadBalancingSettings *SubResource `json:"loadBalancingSettings,omitempty"`
	// HealthProbeSettings - L7 health probe settings for a backend pool
	HealthProbeSettings *SubResource `json:"healthProbeSettings,omitempty"`
}

BackendPoolUpdateParameters a collection of backends that can be routed to.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Frontdoor.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (BaseClient) CheckFrontDoorNameAvailability 

func (client BaseClient) CheckFrontDoorNameAvailability(ctx context.Context, checkFrontDoorNameAvailabilityInput CheckNameAvailabilityInput) (result CheckNameAvailabilityOutput, err error)

CheckFrontDoorNameAvailability check the availability of a Front Door resource name. Parameters: checkFrontDoorNameAvailabilityInput - input to check.

func (BaseClient) CheckFrontDoorNameAvailabilityPreparer 

func (client BaseClient) CheckFrontDoorNameAvailabilityPreparer(ctx context.Context, checkFrontDoorNameAvailabilityInput CheckNameAvailabilityInput) (*http.Request, error)

CheckFrontDoorNameAvailabilityPreparer prepares the CheckFrontDoorNameAvailability request.

func (BaseClient) CheckFrontDoorNameAvailabilityResponder 

func (client BaseClient) CheckFrontDoorNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityOutput, err error)

CheckFrontDoorNameAvailabilityResponder handles the response to the CheckFrontDoorNameAvailability request. The method always closes the http.Response Body.

func (BaseClient) CheckFrontDoorNameAvailabilitySender 

func (client BaseClient) CheckFrontDoorNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckFrontDoorNameAvailabilitySender sends the CheckFrontDoorNameAvailability request. The method will close the http.Response Body if it receives an error.

func (BaseClient) CheckFrontDoorNameAvailabilityWithSubscription 

func (client BaseClient) CheckFrontDoorNameAvailabilityWithSubscription(ctx context.Context, checkFrontDoorNameAvailabilityInput CheckNameAvailabilityInput) (result CheckNameAvailabilityOutput, err error)

CheckFrontDoorNameAvailabilityWithSubscription check the availability of a Front Door subdomain. Parameters: checkFrontDoorNameAvailabilityInput - input to check.

func (BaseClient) CheckFrontDoorNameAvailabilityWithSubscriptionPreparer 

func (client BaseClient) CheckFrontDoorNameAvailabilityWithSubscriptionPreparer(ctx context.Context, checkFrontDoorNameAvailabilityInput CheckNameAvailabilityInput) (*http.Request, error)

CheckFrontDoorNameAvailabilityWithSubscriptionPreparer prepares the CheckFrontDoorNameAvailabilityWithSubscription request.

func (BaseClient) CheckFrontDoorNameAvailabilityWithSubscriptionResponder 

func (client BaseClient) CheckFrontDoorNameAvailabilityWithSubscriptionResponder(resp *http.Response) (result CheckNameAvailabilityOutput, err error)

CheckFrontDoorNameAvailabilityWithSubscriptionResponder handles the response to the CheckFrontDoorNameAvailabilityWithSubscription request. The method always closes the http.Response Body.

func (BaseClient) CheckFrontDoorNameAvailabilityWithSubscriptionSender 

func (client BaseClient) CheckFrontDoorNameAvailabilityWithSubscriptionSender(req *http.Request) (*http.Response, error)

CheckFrontDoorNameAvailabilityWithSubscriptionSender sends the CheckFrontDoorNameAvailabilityWithSubscription request. The method will close the http.Response Body if it receives an error.

type BasicManagedRuleSet 

type BasicManagedRuleSet interface {
	AsAzureManagedRuleSet() (*AzureManagedRuleSet, bool)
	AsManagedRuleSet() (*ManagedRuleSet, bool)
}

BasicManagedRuleSet base class for all types of ManagedRuleSet.

type CacheConfiguration 

type CacheConfiguration struct {
	// QueryParameterStripDirective - Treatment of URL query terms when forming the cache key. Possible values include: 'StripNone', 'StripAll'
	QueryParameterStripDirective Query `json:"queryParameterStripDirective,omitempty"`
	// DynamicCompression - Whether to use dynamic compression for cached content. Possible values include: 'DynamicCompressionEnabledEnabled', 'DynamicCompressionEnabledDisabled'
	DynamicCompression DynamicCompressionEnabled `json:"dynamicCompression,omitempty"`
}

CacheConfiguration caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.

type CertificateSource 

type CertificateSource string

CertificateSource enumerates the values for certificate source. 

const (
	// CertificateSourceAzureKeyVault ...
	CertificateSourceAzureKeyVault CertificateSource = "AzureKeyVault"
	// CertificateSourceFrontDoor ...
	CertificateSourceFrontDoor CertificateSource = "FrontDoor"
)

func PossibleCertificateSourceValues 

func PossibleCertificateSourceValues() []CertificateSource

PossibleCertificateSourceValues returns an array of possible values for the CertificateSource const type.

type CertificateSourceParameters 

type CertificateSourceParameters struct {
	// CertificateType - Defines the type of the certificate used for secure connections to a frontendEndpoint. Possible values include: 'Dedicated'
	CertificateType CertificateType `json:"certificateType,omitempty"`
}

CertificateSourceParameters parameters required for enabling SSL with Front Door-managed certificates

type CertificateType 

type CertificateType string

CertificateType enumerates the values for certificate type. 

const (
	// Dedicated ...
	Dedicated CertificateType = "Dedicated"
)

func PossibleCertificateTypeValues 

func PossibleCertificateTypeValues() []CertificateType

PossibleCertificateTypeValues returns an array of possible values for the CertificateType const type.

type CheckNameAvailabilityInput 

type CheckNameAvailabilityInput struct {
	// Name - The resource name to validate.
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource whose name is to be validated. Possible values include: 'MicrosoftNetworkfrontDoors', 'MicrosoftNetworkfrontDoorsfrontendEndpoints'
	Type ResourceType `json:"type,omitempty"`
}

CheckNameAvailabilityInput input of CheckNameAvailability API.

type CheckNameAvailabilityOutput 

type CheckNameAvailabilityOutput struct {
	autorest.Response `json:"-"`
	// NameAvailability - READ-ONLY; Indicates whether the name is available. Possible values include: 'Available', 'Unavailable'
	NameAvailability Availability `json:"nameAvailability,omitempty"`
	// Reason - READ-ONLY; The reason why the name is not available.
	Reason *string `json:"reason,omitempty"`
	// Message - READ-ONLY; The detailed error message describing why the name is not available.
	Message *string `json:"message,omitempty"`
}

CheckNameAvailabilityOutput output of check name availability API.

type CustomHTTPSConfiguration 

type CustomHTTPSConfiguration struct {
	// CertificateSource - Defines the source of the SSL certificate. Possible values include: 'CertificateSourceAzureKeyVault', 'CertificateSourceFrontDoor'
	CertificateSource CertificateSource `json:"certificateSource,omitempty"`
	// ProtocolType - Defines the TLS extension protocol that is used for secure delivery. Possible values include: 'ServerNameIndication'
	ProtocolType TLSProtocolType `json:"protocolType,omitempty"`
	// KeyVaultCertificateSourceParameters - KeyVault certificate source parameters (if certificateSource=AzureKeyVault)
	*KeyVaultCertificateSourceParameters `json:"keyVaultCertificateSourceParameters,omitempty"`
	// CertificateSourceParameters - Parameters required for enabling SSL with Front Door-managed certificates (if certificateSource=FrontDoor)
	*CertificateSourceParameters `json:"frontDoorCertificateSourceParameters,omitempty"`
}

CustomHTTPSConfiguration https settings for a domain

func (CustomHTTPSConfiguration) MarshalJSON 

func (chc CustomHTTPSConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CustomHTTPSConfiguration.

func (*CustomHTTPSConfiguration) UnmarshalJSON 

func (chc *CustomHTTPSConfiguration) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CustomHTTPSConfiguration struct.

type CustomHTTPSProvisioningState 

type CustomHTTPSProvisioningState string

CustomHTTPSProvisioningState enumerates the values for custom https provisioning state. 

const (
	// Disabled ...
	Disabled CustomHTTPSProvisioningState = "Disabled"
	// Disabling ...
	Disabling CustomHTTPSProvisioningState = "Disabling"
	// Enabled ...
	Enabled CustomHTTPSProvisioningState = "Enabled"
	// Enabling ...
	Enabling CustomHTTPSProvisioningState = "Enabling"
	// Failed ...
	Failed CustomHTTPSProvisioningState = "Failed"
)

func PossibleCustomHTTPSProvisioningStateValues 

func PossibleCustomHTTPSProvisioningStateValues() []CustomHTTPSProvisioningState

PossibleCustomHTTPSProvisioningStateValues returns an array of possible values for the CustomHTTPSProvisioningState const type.

type CustomHTTPSProvisioningSubstate 

type CustomHTTPSProvisioningSubstate string

CustomHTTPSProvisioningSubstate enumerates the values for custom https provisioning substate. 

const (
	// CertificateDeleted ...
	CertificateDeleted CustomHTTPSProvisioningSubstate = "CertificateDeleted"
	// CertificateDeployed ...
	CertificateDeployed CustomHTTPSProvisioningSubstate = "CertificateDeployed"
	// DeletingCertificate ...
	DeletingCertificate CustomHTTPSProvisioningSubstate = "DeletingCertificate"
	// DeployingCertificate ...
	DeployingCertificate CustomHTTPSProvisioningSubstate = "DeployingCertificate"
	// DomainControlValidationRequestApproved ...
	DomainControlValidationRequestApproved CustomHTTPSProvisioningSubstate = "DomainControlValidationRequestApproved"
	// DomainControlValidationRequestRejected ...
	DomainControlValidationRequestRejected CustomHTTPSProvisioningSubstate = "DomainControlValidationRequestRejected"
	// DomainControlValidationRequestTimedOut ...
	DomainControlValidationRequestTimedOut CustomHTTPSProvisioningSubstate = "DomainControlValidationRequestTimedOut"
	// IssuingCertificate ...
	IssuingCertificate CustomHTTPSProvisioningSubstate = "IssuingCertificate"
	// PendingDomainControlValidationREquestApproval ...
	PendingDomainControlValidationREquestApproval CustomHTTPSProvisioningSubstate = "PendingDomainControlValidationREquestApproval"
	// SubmittingDomainControlValidationRequest ...
	SubmittingDomainControlValidationRequest CustomHTTPSProvisioningSubstate = "SubmittingDomainControlValidationRequest"
)

func PossibleCustomHTTPSProvisioningSubstateValues 

func PossibleCustomHTTPSProvisioningSubstateValues() []CustomHTTPSProvisioningSubstate

PossibleCustomHTTPSProvisioningSubstateValues returns an array of possible values for the CustomHTTPSProvisioningSubstate const type.

type CustomRule 

type CustomRule struct {
	// Name - Gets name of the resource that is unique within a policy. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`
	// Etag - READ-ONLY; Gets a unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`
	// Priority - Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value
	Priority *int32 `json:"priority,omitempty"`
	// RuleType - Describes type of rule. Possible values include: 'MatchRule', 'RateLimitRule'
	RuleType RuleType `json:"ruleType,omitempty"`
	// RateLimitDurationInMinutes - Defines rate limit duration. Default - 1 minute
	RateLimitDurationInMinutes *int32 `json:"rateLimitDurationInMinutes,omitempty"`
	// RateLimitThreshold - Defines rate limit threshold
	RateLimitThreshold *int32 `json:"rateLimitThreshold,omitempty"`
	// MatchConditions - List of match conditions
	MatchConditions *[]MatchCondition1 `json:"matchConditions,omitempty"`
	// Action - Type of Actions. Possible values include: 'Allow', 'Block', 'Log'
	Action Action `json:"action,omitempty"`
	// Transforms - List of transforms
	Transforms *[]Transform `json:"transforms,omitempty"`
}

CustomRule defines contents of a web application rule

type CustomRules 

type CustomRules struct {
	// Rules - List of rules
	Rules *[]CustomRule `json:"rules,omitempty"`
}

CustomRules defines contents of custom rules

type DynamicCompressionEnabled 

type DynamicCompressionEnabled string

DynamicCompressionEnabled enumerates the values for dynamic compression enabled. 

const (
	// DynamicCompressionEnabledDisabled ...
	DynamicCompressionEnabledDisabled DynamicCompressionEnabled = "Disabled"
	// DynamicCompressionEnabledEnabled ...
	DynamicCompressionEnabledEnabled DynamicCompressionEnabled = "Enabled"
)

func PossibleDynamicCompressionEnabledValues 

func PossibleDynamicCompressionEnabledValues() []DynamicCompressionEnabled

PossibleDynamicCompressionEnabledValues returns an array of possible values for the DynamicCompressionEnabled const type.

type EnabledState 

type EnabledState string

EnabledState enumerates the values for enabled state. 

const (
	// EnabledStateDisabled ...
	EnabledStateDisabled EnabledState = "Disabled"
	// EnabledStateEnabled ...
	EnabledStateEnabled EnabledState = "Enabled"
)

func PossibleEnabledStateValues 

func PossibleEnabledStateValues() []EnabledState

PossibleEnabledStateValues returns an array of possible values for the EnabledState const type.

type EnabledStateEnum 

type EnabledStateEnum string

EnabledStateEnum enumerates the values for enabled state enum. 

const (
	// EnabledStateEnumDisabled ...
	EnabledStateEnumDisabled EnabledStateEnum = "Disabled"
	// EnabledStateEnumEnabled ...
	EnabledStateEnumEnabled EnabledStateEnum = "Enabled"
)

func PossibleEnabledStateEnumValues 

func PossibleEnabledStateEnumValues() []EnabledStateEnum

PossibleEnabledStateEnumValues returns an array of possible values for the EnabledStateEnum const type.

type EndpointsClient 

type EndpointsClient struct {
	BaseClient
}

EndpointsClient is the frontDoor Client

func NewEndpointsClient 

func NewEndpointsClient(subscriptionID string) EndpointsClient

NewEndpointsClient creates an instance of the EndpointsClient client.

func NewEndpointsClientWithBaseURI 

func NewEndpointsClientWithBaseURI(baseURI string, subscriptionID string) EndpointsClient

NewEndpointsClientWithBaseURI creates an instance of the EndpointsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (EndpointsClient) PurgeContent 

func (client EndpointsClient) PurgeContent(ctx context.Context, resourceGroupName string, frontDoorName string, contentFilePaths PurgeParameters) (result EndpointsPurgeContentFuture, err error)

PurgeContent removes a content from Front Door. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. frontDoorName - name of the Front Door which is globally unique. contentFilePaths - the path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.

func (EndpointsClient) PurgeContentPreparer 

func (client EndpointsClient) PurgeContentPreparer(ctx context.Context, resourceGroupName string, frontDoorName string, contentFilePaths PurgeParameters) (*http.Request, error)

PurgeContentPreparer prepares the PurgeContent request.

func (EndpointsClient) PurgeContentResponder 

func (client EndpointsClient) PurgeContentResponder(resp *http.Response) (result autorest.Response, err error)

PurgeContentResponder handles the response to the PurgeContent request. The method always closes the http.Response Body.

func (EndpointsClient) PurgeContentSender 

func (client EndpointsClient) PurgeContentSender(req *http.Request) (future EndpointsPurgeContentFuture, err error)

PurgeContentSender sends the PurgeContent request. The method will close the http.Response Body if it receives an error.

type EndpointsPurgeContentFuture 

type EndpointsPurgeContentFuture struct {
	azure.Future
}

EndpointsPurgeContentFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*EndpointsPurgeContentFuture) Result 

func (future *EndpointsPurgeContentFuture) Result(client EndpointsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type Error 

type Error struct {
	Code       *string         `json:"code,omitempty"`
	Message    *string         `json:"message,omitempty"`
	Target     *string         `json:"target,omitempty"`
	Details    *[]ErrorDetails `json:"details,omitempty"`
	InnerError *string         `json:"innerError,omitempty"`
}

Error ...

type ErrorDetails 

type ErrorDetails struct {
	Code    *string `json:"code,omitempty"`
	Target  *string `json:"target,omitempty"`
	Message *string `json:"message,omitempty"`
}

ErrorDetails ...

type ErrorResponse 

type ErrorResponse struct {
	// Code - READ-ONLY; Error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorResponse error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.

type ForwardingProtocol 

type ForwardingProtocol string

ForwardingProtocol enumerates the values for forwarding protocol. 

const (
	// HTTPOnly ...
	HTTPOnly ForwardingProtocol = "HttpOnly"
	// HTTPSOnly ...
	HTTPSOnly ForwardingProtocol = "HttpsOnly"
	// MatchRequest ...
	MatchRequest ForwardingProtocol = "MatchRequest"
)

func PossibleForwardingProtocolValues 

func PossibleForwardingProtocolValues() []ForwardingProtocol

PossibleForwardingProtocolValues returns an array of possible values for the ForwardingProtocol const type.

type FrontDoor 

type FrontDoor struct {
	autorest.Response `json:"-"`
	// Properties - Properties of the Front Door Load Balancer
	*Properties `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

FrontDoor front Door represents a collection of backend endpoints to route traffic to along with rules that specify how traffic is sent there.

func (FrontDoor) MarshalJSON 

func (fd FrontDoor) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FrontDoor.

func (*FrontDoor) UnmarshalJSON 

func (fd *FrontDoor) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for FrontDoor struct.

type FrontDoorsClient 

type FrontDoorsClient struct {
	BaseClient
}

FrontDoorsClient is the frontDoor Client

func NewFrontDoorsClient 

func NewFrontDoorsClient(subscriptionID string) FrontDoorsClient

NewFrontDoorsClient creates an instance of the FrontDoorsClient client.

func NewFrontDoorsClientWithBaseURI 

func NewFrontDoorsClientWithBaseURI(baseURI string, subscriptionID string) FrontDoorsClient

NewFrontDoorsClientWithBaseURI creates an instance of the FrontDoorsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (FrontDoorsClient) CreateOrUpdate 

func (client FrontDoorsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, frontDoorName string, frontDoorParameters FrontDoor) (result FrontDoorsCreateOrUpdateFutureType, err error)

CreateOrUpdate creates a new Front Door with a Front Door name under the specified subscription and resource group. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. frontDoorName - name of the Front Door which is globally unique. frontDoorParameters - front Door properties needed to create a new Front Door.

func (FrontDoorsClient) CreateOrUpdatePreparer 

func (client FrontDoorsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, frontDoorName string, frontDoorParameters FrontDoor) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (FrontDoorsClient) CreateOrUpdateResponder 

func (client FrontDoorsClient) CreateOrUpdateResponder(resp *http.Response) (result FrontDoor, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (FrontDoorsClient) CreateOrUpdateSender 

func (client FrontDoorsClient) CreateOrUpdateSender(req *http.Request) (future FrontDoorsCreateOrUpdateFutureType, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (FrontDoorsClient) Delete 

func (client FrontDoorsClient) Delete(ctx context.Context, resourceGroupName string, frontDoorName string) (result FrontDoorsDeleteFutureType, err error)

Delete deletes an existing Front Door with the specified parameters. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. frontDoorName - name of the Front Door which is globally unique.

func (FrontDoorsClient) DeletePreparer 

func (client FrontDoorsClient) DeletePreparer(ctx context.Context, resourceGroupName string, frontDoorName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (FrontDoorsClient) DeleteResponder 

func (client FrontDoorsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (FrontDoorsClient) DeleteSender 

func (client FrontDoorsClient) DeleteSender(req *http.Request) (future FrontDoorsDeleteFutureType, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (FrontDoorsClient) Get 

func (client FrontDoorsClient) Get(ctx context.Context, resourceGroupName string, frontDoorName string) (result FrontDoor, err error)

Get gets a Front Door with the specified Front Door name under the specified subscription and resource group. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. frontDoorName - name of the Front Door which is globally unique.

func (FrontDoorsClient) GetPreparer 

func (client FrontDoorsClient) GetPreparer(ctx context.Context, resourceGroupName string, frontDoorName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (FrontDoorsClient) GetResponder 

func (client FrontDoorsClient) GetResponder(resp *http.Response) (result FrontDoor, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (FrontDoorsClient) GetSender 

func (client FrontDoorsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (FrontDoorsClient) List 

func (client FrontDoorsClient) List(ctx context.Context) (result ListResultPage, err error)

List lists all of the Front Doors within an Azure subscription.

func (FrontDoorsClient) ListByResourceGroup 

func (client FrontDoorsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ListResultPage, err error)

ListByResourceGroup lists all of the Front Doors within a resource group under a subscription. Parameters: resourceGroupName - name of the Resource group within the Azure subscription.

func (FrontDoorsClient) ListByResourceGroupComplete 

func (client FrontDoorsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (FrontDoorsClient) ListByResourceGroupPreparer 

func (client FrontDoorsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (FrontDoorsClient) ListByResourceGroupResponder 

func (client FrontDoorsClient) ListByResourceGroupResponder(resp *http.Response) (result ListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (FrontDoorsClient) ListByResourceGroupSender 

func (client FrontDoorsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (FrontDoorsClient) ListComplete 

func (client FrontDoorsClient) ListComplete(ctx context.Context) (result ListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (FrontDoorsClient) ListPreparer 

func (client FrontDoorsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (FrontDoorsClient) ListResponder 

func (client FrontDoorsClient) ListResponder(resp *http.Response) (result ListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (FrontDoorsClient) ListSender 

func (client FrontDoorsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (FrontDoorsClient) ValidateCustomDomain 

func (client FrontDoorsClient) ValidateCustomDomain(ctx context.Context, resourceGroupName string, frontDoorName string, customDomainProperties ValidateCustomDomainInput) (result ValidateCustomDomainOutput, err error)

ValidateCustomDomain validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. frontDoorName - name of the Front Door which is globally unique. customDomainProperties - custom domain to be validated.

func (FrontDoorsClient) ValidateCustomDomainPreparer 

func (client FrontDoorsClient) ValidateCustomDomainPreparer(ctx context.Context, resourceGroupName string, frontDoorName string, customDomainProperties ValidateCustomDomainInput) (*http.Request, error)

ValidateCustomDomainPreparer prepares the ValidateCustomDomain request.

func (FrontDoorsClient) ValidateCustomDomainResponder 

func (client FrontDoorsClient) ValidateCustomDomainResponder(resp *http.Response) (result ValidateCustomDomainOutput, err error)

ValidateCustomDomainResponder handles the response to the ValidateCustomDomain request. The method always closes the http.Response Body.

func (FrontDoorsClient) ValidateCustomDomainSender 

func (client FrontDoorsClient) ValidateCustomDomainSender(req *http.Request) (*http.Response, error)

ValidateCustomDomainSender sends the ValidateCustomDomain request. The method will close the http.Response Body if it receives an error.

type FrontDoorsCreateOrUpdateFutureType 

type FrontDoorsCreateOrUpdateFutureType struct {
	azure.Future
}

FrontDoorsCreateOrUpdateFutureType an abstraction for monitoring and retrieving the results of a long-running operation.

func (*FrontDoorsCreateOrUpdateFutureType) Result 

func (future *FrontDoorsCreateOrUpdateFutureType) Result(client FrontDoorsClient) (fd FrontDoor, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type FrontDoorsDeleteFutureType 

type FrontDoorsDeleteFutureType struct {
	azure.Future
}

FrontDoorsDeleteFutureType an abstraction for monitoring and retrieving the results of a long-running operation.

func (*FrontDoorsDeleteFutureType) Result 

func (future *FrontDoorsDeleteFutureType) Result(client FrontDoorsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type FrontendEndpoint 

type FrontendEndpoint struct {
	autorest.Response `json:"-"`
	// FrontendEndpointProperties - Properties of the Frontend endpoint
	*FrontendEndpointProperties `json:"properties,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
}

FrontendEndpoint a frontend endpoint used for routing.

func (FrontendEndpoint) MarshalJSON 

func (fe FrontendEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FrontendEndpoint.

func (*FrontendEndpoint) UnmarshalJSON 

func (fe *FrontendEndpoint) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for FrontendEndpoint struct.

type FrontendEndpointProperties 

type FrontendEndpointProperties struct {
	// ResourceState - Resource status. Possible values include: 'ResourceStateCreating', 'ResourceStateEnabling', 'ResourceStateEnabled', 'ResourceStateDisabling', 'ResourceStateDisabled', 'ResourceStateDeleting'
	ResourceState ResourceState `json:"resourceState,omitempty"`
	// CustomHTTPSProvisioningState - READ-ONLY; Provisioning status of Custom Https of the frontendEndpoint. Possible values include: 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Failed'
	CustomHTTPSProvisioningState CustomHTTPSProvisioningState `json:"customHttpsProvisioningState,omitempty"`
	// CustomHTTPSProvisioningSubstate - READ-ONLY; Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. Possible values include: 'SubmittingDomainControlValidationRequest', 'PendingDomainControlValidationREquestApproval', 'DomainControlValidationRequestApproved', 'DomainControlValidationRequestRejected', 'DomainControlValidationRequestTimedOut', 'IssuingCertificate', 'DeployingCertificate', 'CertificateDeployed', 'DeletingCertificate', 'CertificateDeleted'
	CustomHTTPSProvisioningSubstate CustomHTTPSProvisioningSubstate `json:"customHttpsProvisioningSubstate,omitempty"`
	// CustomHTTPSConfiguration - READ-ONLY; The configuration specifying how to enable HTTPS
	CustomHTTPSConfiguration *CustomHTTPSConfiguration `json:"customHttpsConfiguration,omitempty"`
	// HostName - The host name of the frontendEndpoint. Must be a domain name.
	HostName *string `json:"hostName,omitempty"`
	// SessionAffinityEnabledState - Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'. Possible values include: 'SessionAffinityEnabledStateEnabled', 'SessionAffinityEnabledStateDisabled'
	SessionAffinityEnabledState SessionAffinityEnabledState `json:"sessionAffinityEnabledState,omitempty"`
	// SessionAffinityTTLSeconds - UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.
	SessionAffinityTTLSeconds *int32 `json:"sessionAffinityTtlSeconds,omitempty"`
	// WebApplicationFirewallPolicyLink - Defines the Web Application Firewall policy for each host (if applicable)
	WebApplicationFirewallPolicyLink *FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink `json:"webApplicationFirewallPolicyLink,omitempty"`
}

FrontendEndpointProperties the JSON object that contains the properties required to create a frontend endpoint.

type FrontendEndpointUpdateParameters 

type FrontendEndpointUpdateParameters struct {
	// HostName - The host name of the frontendEndpoint. Must be a domain name.
	HostName *string `json:"hostName,omitempty"`
	// SessionAffinityEnabledState - Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'. Possible values include: 'SessionAffinityEnabledStateEnabled', 'SessionAffinityEnabledStateDisabled'
	SessionAffinityEnabledState SessionAffinityEnabledState `json:"sessionAffinityEnabledState,omitempty"`
	// SessionAffinityTTLSeconds - UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.
	SessionAffinityTTLSeconds *int32 `json:"sessionAffinityTtlSeconds,omitempty"`
	// WebApplicationFirewallPolicyLink - Defines the Web Application Firewall policy for each host (if applicable)
	WebApplicationFirewallPolicyLink *FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink `json:"webApplicationFirewallPolicyLink,omitempty"`
}

FrontendEndpointUpdateParameters frontend endpoint used in routing rule 

type FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink struct {
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
}

FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink defines the Web Application Firewall policy for each host (if applicable)

type FrontendEndpointsClient 

type FrontendEndpointsClient struct {
	BaseClient
}

FrontendEndpointsClient is the frontDoor Client

func NewFrontendEndpointsClient 

func NewFrontendEndpointsClient(subscriptionID string) FrontendEndpointsClient

NewFrontendEndpointsClient creates an instance of the FrontendEndpointsClient client.

func NewFrontendEndpointsClientWithBaseURI 

func NewFrontendEndpointsClientWithBaseURI(baseURI string, subscriptionID string) FrontendEndpointsClient

NewFrontendEndpointsClientWithBaseURI creates an instance of the FrontendEndpointsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (FrontendEndpointsClient) DisableHTTPS 

func (client FrontendEndpointsClient) DisableHTTPS(ctx context.Context, resourceGroupName string, frontDoorName string, frontendEndpointName string) (result FrontendEndpointsDisableHTTPSFuture, err error)

DisableHTTPS disables a frontendEndpoint for HTTPS traffic Parameters: resourceGroupName - name of the Resource group within the Azure subscription. frontDoorName - name of the Front Door which is globally unique. frontendEndpointName - name of the Frontend endpoint which is unique within the Front Door.

func (FrontendEndpointsClient) DisableHTTPSPreparer 

func (client FrontendEndpointsClient) DisableHTTPSPreparer(ctx context.Context, resourceGroupName string, frontDoorName string, frontendEndpointName string) (*http.Request, error)

DisableHTTPSPreparer prepares the DisableHTTPS request.

func (FrontendEndpointsClient) DisableHTTPSResponder 

func (client FrontendEndpointsClient) DisableHTTPSResponder(resp *http.Response) (result autorest.Response, err error)

DisableHTTPSResponder handles the response to the DisableHTTPS request. The method always closes the http.Response Body.

func (FrontendEndpointsClient) DisableHTTPSSender 

func (client FrontendEndpointsClient) DisableHTTPSSender(req *http.Request) (future FrontendEndpointsDisableHTTPSFuture, err error)

DisableHTTPSSender sends the DisableHTTPS request. The method will close the http.Response Body if it receives an error.

func (FrontendEndpointsClient) EnableHTTPS 

func (client FrontendEndpointsClient) EnableHTTPS(ctx context.Context, resourceGroupName string, frontDoorName string, frontendEndpointName string, customHTTPSConfiguration CustomHTTPSConfiguration) (result FrontendEndpointsEnableHTTPSFuture, err error)

EnableHTTPS enables a frontendEndpoint for HTTPS traffic Parameters: resourceGroupName - name of the Resource group within the Azure subscription. frontDoorName - name of the Front Door which is globally unique. frontendEndpointName - name of the Frontend endpoint which is unique within the Front Door. customHTTPSConfiguration - the configuration specifying how to enable HTTPS

func (FrontendEndpointsClient) EnableHTTPSPreparer 

func (client FrontendEndpointsClient) EnableHTTPSPreparer(ctx context.Context, resourceGroupName string, frontDoorName string, frontendEndpointName string, customHTTPSConfiguration CustomHTTPSConfiguration) (*http.Request, error)

EnableHTTPSPreparer prepares the EnableHTTPS request.

func (FrontendEndpointsClient) EnableHTTPSResponder 

func (client FrontendEndpointsClient) EnableHTTPSResponder(resp *http.Response) (result autorest.Response, err error)

EnableHTTPSResponder handles the response to the EnableHTTPS request. The method always closes the http.Response Body.

func (FrontendEndpointsClient) EnableHTTPSSender 

func (client FrontendEndpointsClient) EnableHTTPSSender(req *http.Request) (future FrontendEndpointsEnableHTTPSFuture, err error)

EnableHTTPSSender sends the EnableHTTPS request. The method will close the http.Response Body if it receives an error.

func (FrontendEndpointsClient) Get 

func (client FrontendEndpointsClient) Get(ctx context.Context, resourceGroupName string, frontDoorName string, frontendEndpointName string) (result FrontendEndpoint, err error)

Get gets a Frontend endpoint with the specified name within the specified Front Door. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. frontDoorName - name of the Front Door which is globally unique. frontendEndpointName - name of the Frontend endpoint which is unique within the Front Door.

func (FrontendEndpointsClient) GetPreparer 

func (client FrontendEndpointsClient) GetPreparer(ctx context.Context, resourceGroupName string, frontDoorName string, frontendEndpointName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (FrontendEndpointsClient) GetResponder 

func (client FrontendEndpointsClient) GetResponder(resp *http.Response) (result FrontendEndpoint, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (FrontendEndpointsClient) GetSender 

func (client FrontendEndpointsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (FrontendEndpointsClient) ListByFrontDoor 

func (client FrontendEndpointsClient) ListByFrontDoor(ctx context.Context, resourceGroupName string, frontDoorName string) (result FrontendEndpointsListResultPage, err error)

ListByFrontDoor lists all of the frontend endpoints within a Front Door. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. frontDoorName - name of the Front Door which is globally unique.

func (FrontendEndpointsClient) ListByFrontDoorComplete 

func (client FrontendEndpointsClient) ListByFrontDoorComplete(ctx context.Context, resourceGroupName string, frontDoorName string) (result FrontendEndpointsListResultIterator, err error)

ListByFrontDoorComplete enumerates all values, automatically crossing page boundaries as required.

func (FrontendEndpointsClient) ListByFrontDoorPreparer 

func (client FrontendEndpointsClient) ListByFrontDoorPreparer(ctx context.Context, resourceGroupName string, frontDoorName string) (*http.Request, error)

ListByFrontDoorPreparer prepares the ListByFrontDoor request.

func (FrontendEndpointsClient) ListByFrontDoorResponder 

func (client FrontendEndpointsClient) ListByFrontDoorResponder(resp *http.Response) (result FrontendEndpointsListResult, err error)

ListByFrontDoorResponder handles the response to the ListByFrontDoor request. The method always closes the http.Response Body.

func (FrontendEndpointsClient) ListByFrontDoorSender 

func (client FrontendEndpointsClient) ListByFrontDoorSender(req *http.Request) (*http.Response, error)

ListByFrontDoorSender sends the ListByFrontDoor request. The method will close the http.Response Body if it receives an error.

type FrontendEndpointsDisableHTTPSFuture 

type FrontendEndpointsDisableHTTPSFuture struct {
	azure.Future
}

FrontendEndpointsDisableHTTPSFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*FrontendEndpointsDisableHTTPSFuture) Result 

func (future *FrontendEndpointsDisableHTTPSFuture) Result(client FrontendEndpointsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type FrontendEndpointsEnableHTTPSFuture 

type FrontendEndpointsEnableHTTPSFuture struct {
	azure.Future
}

FrontendEndpointsEnableHTTPSFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*FrontendEndpointsEnableHTTPSFuture) Result 

func (future *FrontendEndpointsEnableHTTPSFuture) Result(client FrontendEndpointsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type FrontendEndpointsListResult 

type FrontendEndpointsListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of Frontend endpoints within a Front Door.
	Value *[]FrontendEndpoint `json:"value,omitempty"`
	// NextLink - URL to get the next set of frontend endpoints if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

FrontendEndpointsListResult result of the request to list frontend endpoints. It contains a list of Frontend endpoint objects and a URL link to get the next set of results.

func (FrontendEndpointsListResult) IsEmpty 

func (felr FrontendEndpointsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type FrontendEndpointsListResultIterator 

type FrontendEndpointsListResultIterator struct {
	// contains filtered or unexported fields
}

FrontendEndpointsListResultIterator provides access to a complete listing of FrontendEndpoint values.

func NewFrontendEndpointsListResultIterator 

func NewFrontendEndpointsListResultIterator(page FrontendEndpointsListResultPage) FrontendEndpointsListResultIterator

Creates a new instance of the FrontendEndpointsListResultIterator type.

func (*FrontendEndpointsListResultIterator) Next 

func (iter *FrontendEndpointsListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*FrontendEndpointsListResultIterator) NextWithContext 

func (iter *FrontendEndpointsListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (FrontendEndpointsListResultIterator) NotDone 

func (iter FrontendEndpointsListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (FrontendEndpointsListResultIterator) Response 

func (iter FrontendEndpointsListResultIterator) Response() FrontendEndpointsListResult

Response returns the raw server response from the last page request.

func (FrontendEndpointsListResultIterator) Value 

func (iter FrontendEndpointsListResultIterator) Value() FrontendEndpoint

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type FrontendEndpointsListResultPage 

type FrontendEndpointsListResultPage struct {
	// contains filtered or unexported fields
}

FrontendEndpointsListResultPage contains a page of FrontendEndpoint values.

func NewFrontendEndpointsListResultPage 

func NewFrontendEndpointsListResultPage(getNextPage func(context.Context, FrontendEndpointsListResult) (FrontendEndpointsListResult, error)) FrontendEndpointsListResultPage

Creates a new instance of the FrontendEndpointsListResultPage type.

func (*FrontendEndpointsListResultPage) Next 

func (page *FrontendEndpointsListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*FrontendEndpointsListResultPage) NextWithContext 

func (page *FrontendEndpointsListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (FrontendEndpointsListResultPage) NotDone 

func (page FrontendEndpointsListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (FrontendEndpointsListResultPage) Response 

func (page FrontendEndpointsListResultPage) Response() FrontendEndpointsListResult

Response returns the raw server response from the last page request.

func (FrontendEndpointsListResultPage) Values 

func (page FrontendEndpointsListResultPage) Values() []FrontendEndpoint

Values returns the slice of values for the current page or nil if there are no values.

type HealthProbeSettingsListResult 

type HealthProbeSettingsListResult struct {
	// Value - READ-ONLY; List of HealthProbeSettings within a Front Door.
	Value *[]HealthProbeSettingsModel `json:"value,omitempty"`
	// NextLink - URL to get the next set of HealthProbeSettings objects if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

HealthProbeSettingsListResult result of the request to list HealthProbeSettings. It contains a list of HealthProbeSettings objects and a URL link to get the next set of results.

type HealthProbeSettingsModel 

type HealthProbeSettingsModel struct {
	// HealthProbeSettingsProperties - Properties of the health probe settings
	*HealthProbeSettingsProperties `json:"properties,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
}

HealthProbeSettingsModel load balancing settings for a backend pool

func (HealthProbeSettingsModel) MarshalJSON 

func (hpsm HealthProbeSettingsModel) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HealthProbeSettingsModel.

func (*HealthProbeSettingsModel) UnmarshalJSON 

func (hpsm *HealthProbeSettingsModel) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for HealthProbeSettingsModel struct.

type HealthProbeSettingsProperties 

type HealthProbeSettingsProperties struct {
	// ResourceState - Resource status. Possible values include: 'ResourceStateCreating', 'ResourceStateEnabling', 'ResourceStateEnabled', 'ResourceStateDisabling', 'ResourceStateDisabled', 'ResourceStateDeleting'
	ResourceState ResourceState `json:"resourceState,omitempty"`
	// Path - The path to use for the health probe. Default is /
	Path *string `json:"path,omitempty"`
	// Protocol - Protocol scheme to use for this probe. Possible values include: 'HTTP', 'HTTPS'
	Protocol Protocol `json:"protocol,omitempty"`
	// IntervalInSeconds - The number of seconds between health probes.
	IntervalInSeconds *int32 `json:"intervalInSeconds,omitempty"`
}

HealthProbeSettingsProperties the JSON object that contains the properties required to create a health probe settings.

type HealthProbeSettingsUpdateParameters 

type HealthProbeSettingsUpdateParameters struct {
	// Path - The path to use for the health probe. Default is /
	Path *string `json:"path,omitempty"`
	// Protocol - Protocol scheme to use for this probe. Possible values include: 'HTTP', 'HTTPS'
	Protocol Protocol `json:"protocol,omitempty"`
	// IntervalInSeconds - The number of seconds between health probes.
	IntervalInSeconds *int32 `json:"intervalInSeconds,omitempty"`
}

HealthProbeSettingsUpdateParameters l7 health probe settings for a backend pool

type KeyVaultCertificateSourceParameters 

type KeyVaultCertificateSourceParameters struct {
	// Vault - The Key Vault containing the SSL certificate
	Vault *KeyVaultCertificateSourceParametersVault `json:"vault,omitempty"`
	// SecretName - The name of the Key Vault secret representing the full certificate PFX
	SecretName *string `json:"secretName,omitempty"`
	// SecretVersion - The version of the Key Vault secret representing the full certificate PFX
	SecretVersion *string `json:"secretVersion,omitempty"`
}

KeyVaultCertificateSourceParameters parameters required for bring-your-own-certification via Key Vault

type KeyVaultCertificateSourceParametersVault 

type KeyVaultCertificateSourceParametersVault struct {
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
}

KeyVaultCertificateSourceParametersVault the Key Vault containing the SSL certificate

type ListResult 

type ListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of Front Doors within a resource group.
	Value *[]FrontDoor `json:"value,omitempty"`
	// NextLink - URL to get the next set of Front Door objects if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

ListResult result of the request to list Front Doors. It contains a list of Front Door objects and a URL link to get the next set of results.

func (ListResult) IsEmpty 

func (lr ListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ListResultIterator 

type ListResultIterator struct {
	// contains filtered or unexported fields
}

ListResultIterator provides access to a complete listing of FrontDoor values.

func NewListResultIterator 

func NewListResultIterator(page ListResultPage) ListResultIterator

Creates a new instance of the ListResultIterator type.

func (*ListResultIterator) Next 

func (iter *ListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListResultIterator) NextWithContext 

func (iter *ListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ListResultIterator) NotDone 

func (iter ListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ListResultIterator) Response 

func (iter ListResultIterator) Response() ListResult

Response returns the raw server response from the last page request.

func (ListResultIterator) Value 

func (iter ListResultIterator) Value() FrontDoor

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ListResultPage 

type ListResultPage struct {
	// contains filtered or unexported fields
}

ListResultPage contains a page of FrontDoor values.

func NewListResultPage 

func NewListResultPage(getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage

Creates a new instance of the ListResultPage type.

func (*ListResultPage) Next 

func (page *ListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ListResultPage) NextWithContext 

func (page *ListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ListResultPage) NotDone 

func (page ListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ListResultPage) Response 

func (page ListResultPage) Response() ListResult

Response returns the raw server response from the last page request.

func (ListResultPage) Values 

func (page ListResultPage) Values() []FrontDoor

Values returns the slice of values for the current page or nil if there are no values.

type LoadBalancingSettingsListResult 

type LoadBalancingSettingsListResult struct {
	// Value - READ-ONLY; List of Backend Pools within a Front Door.
	Value *[]LoadBalancingSettingsModel `json:"value,omitempty"`
	// NextLink - URL to get the next set of LoadBalancingSettings objects if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

LoadBalancingSettingsListResult result of the request to list load balancing settings. It contains a list of load balancing settings objects and a URL link to get the next set of results.

type LoadBalancingSettingsModel 

type LoadBalancingSettingsModel struct {
	// LoadBalancingSettingsProperties - Properties of the load balancing settings
	*LoadBalancingSettingsProperties `json:"properties,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
}

LoadBalancingSettingsModel load balancing settings for a backend pool

func (LoadBalancingSettingsModel) MarshalJSON 

func (lbsm LoadBalancingSettingsModel) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LoadBalancingSettingsModel.

func (*LoadBalancingSettingsModel) UnmarshalJSON 

func (lbsm *LoadBalancingSettingsModel) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for LoadBalancingSettingsModel struct.

type LoadBalancingSettingsProperties 

type LoadBalancingSettingsProperties struct {
	// ResourceState - Resource status. Possible values include: 'ResourceStateCreating', 'ResourceStateEnabling', 'ResourceStateEnabled', 'ResourceStateDisabling', 'ResourceStateDisabled', 'ResourceStateDeleting'
	ResourceState ResourceState `json:"resourceState,omitempty"`
	// SampleSize - The number of samples to consider for load balancing decisions
	SampleSize *int32 `json:"sampleSize,omitempty"`
	// SuccessfulSamplesRequired - The number of samples within the sample period that must succeed
	SuccessfulSamplesRequired *int32 `json:"successfulSamplesRequired,omitempty"`
	// AdditionalLatencyMilliseconds - The additional latency in milliseconds for probes to fall into the lowest latency bucket
	AdditionalLatencyMilliseconds *int32 `json:"additionalLatencyMilliseconds,omitempty"`
}

LoadBalancingSettingsProperties the JSON object that contains the properties required to create load balancing settings

type LoadBalancingSettingsUpdateParameters 

type LoadBalancingSettingsUpdateParameters struct {
	// SampleSize - The number of samples to consider for load balancing decisions
	SampleSize *int32 `json:"sampleSize,omitempty"`
	// SuccessfulSamplesRequired - The number of samples within the sample period that must succeed
	SuccessfulSamplesRequired *int32 `json:"successfulSamplesRequired,omitempty"`
	// AdditionalLatencyMilliseconds - The additional latency in milliseconds for probes to fall into the lowest latency bucket
	AdditionalLatencyMilliseconds *int32 `json:"additionalLatencyMilliseconds,omitempty"`
}

LoadBalancingSettingsUpdateParameters round-Robin load balancing settings for a backend pool

type ManagedRuleSet 

type ManagedRuleSet struct {
	// Priority - Describes priority of the rule
	Priority *int32 `json:"priority,omitempty"`
	// Version - defines version of the rule set
	Version *int32 `json:"version,omitempty"`
	// RuleSetType - Possible values include: 'RuleSetTypeUnknown', 'RuleSetTypeAzureManagedRuleSet'
	RuleSetType RuleSetType `json:"ruleSetType,omitempty"`
}

ManagedRuleSet base class for all types of ManagedRuleSet.

func (ManagedRuleSet) AsAzureManagedRuleSet 

func (mrs ManagedRuleSet) AsAzureManagedRuleSet() (*AzureManagedRuleSet, bool)

AsAzureManagedRuleSet is the BasicManagedRuleSet implementation for ManagedRuleSet.

func (ManagedRuleSet) AsBasicManagedRuleSet 

func (mrs ManagedRuleSet) AsBasicManagedRuleSet() (BasicManagedRuleSet, bool)

AsBasicManagedRuleSet is the BasicManagedRuleSet implementation for ManagedRuleSet.

func (ManagedRuleSet) AsManagedRuleSet 

func (mrs ManagedRuleSet) AsManagedRuleSet() (*ManagedRuleSet, bool)

AsManagedRuleSet is the BasicManagedRuleSet implementation for ManagedRuleSet.

func (ManagedRuleSet) MarshalJSON 

func (mrs ManagedRuleSet) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagedRuleSet.

type ManagedRuleSets 

type ManagedRuleSets struct {
	// RuleSets - List of rules
	RuleSets *[]BasicManagedRuleSet `json:"ruleSets,omitempty"`
}

ManagedRuleSets defines ManagedRuleSets - array of managedRuleSet

func (*ManagedRuleSets) UnmarshalJSON 

func (mrs *ManagedRuleSets) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ManagedRuleSets struct.

type MatchCondition 

type MatchCondition string

MatchCondition enumerates the values for match condition. 

const (
	// PostArgs ...
	PostArgs MatchCondition = "PostArgs"
	// QueryString ...
	QueryString MatchCondition = "QueryString"
	// RemoteAddr ...
	RemoteAddr MatchCondition = "RemoteAddr"
	// RequestBody ...
	RequestBody MatchCondition = "RequestBody"
	// RequestHeader ...
	RequestHeader MatchCondition = "RequestHeader"
	// RequestMethod ...
	RequestMethod MatchCondition = "RequestMethod"
	// RequestURI ...
	RequestURI MatchCondition = "RequestUri"
)

func PossibleMatchConditionValues 

func PossibleMatchConditionValues() []MatchCondition

PossibleMatchConditionValues returns an array of possible values for the MatchCondition const type.

type MatchCondition1 

type MatchCondition1 struct {
	// MatchVariable - Match Variable. Possible values include: 'RemoteAddr', 'RequestMethod', 'QueryString', 'PostArgs', 'RequestURI', 'RequestHeader', 'RequestBody'
	MatchVariable MatchCondition `json:"matchVariable,omitempty"`
	// Selector - Name of selector in RequestHeader or RequestBody to be matched
	Selector *string `json:"selector,omitempty"`
	// Operator - Describes operator to be matched. Possible values include: 'Any', 'IPMatch', 'GeoMatch', 'Equal', 'Contains', 'LessThan', 'GreaterThan', 'LessThanOrEqual', 'GreaterThanOrEqual', 'BeginsWith', 'EndsWith'
	Operator Operator `json:"operator,omitempty"`
	// NegateCondition - Describes if this is negate condition or not
	NegateCondition *bool `json:"negateCondition,omitempty"`
	// MatchValue - Match value
	MatchValue *[]string `json:"matchValue,omitempty"`
}

MatchCondition1 define match conditions

type Mode 

type Mode string

Mode enumerates the values for mode. 

const (
	// Detection ...
	Detection Mode = "Detection"
	// Prevention ...
	Prevention Mode = "Prevention"
)

func PossibleModeValues 

func PossibleModeValues() []Mode

PossibleModeValues returns an array of possible values for the Mode const type.

type NetworkOperationStatus 

type NetworkOperationStatus string

NetworkOperationStatus enumerates the values for network operation status. 

const (
	// NetworkOperationStatusFailed ...
	NetworkOperationStatusFailed NetworkOperationStatus = "Failed"
	// NetworkOperationStatusInProgress ...
	NetworkOperationStatusInProgress NetworkOperationStatus = "InProgress"
	// NetworkOperationStatusSucceeded ...
	NetworkOperationStatusSucceeded NetworkOperationStatus = "Succeeded"
)

func PossibleNetworkOperationStatusValues 

func PossibleNetworkOperationStatusValues() []NetworkOperationStatus

PossibleNetworkOperationStatusValues returns an array of possible values for the NetworkOperationStatus const type.

type Operator 

type Operator string

Operator enumerates the values for operator. 

const (
	// Any ...
	Any Operator = "Any"
	// BeginsWith ...
	BeginsWith Operator = "BeginsWith"
	// Contains ...
	Contains Operator = "Contains"
	// EndsWith ...
	EndsWith Operator = "EndsWith"
	// Equal ...
	Equal Operator = "Equal"
	// GeoMatch ...
	GeoMatch Operator = "GeoMatch"
	// GreaterThan ...
	GreaterThan Operator = "GreaterThan"
	// GreaterThanOrEqual ...
	GreaterThanOrEqual Operator = "GreaterThanOrEqual"
	// IPMatch ...
	IPMatch Operator = "IPMatch"
	// LessThan ...
	LessThan Operator = "LessThan"
	// LessThanOrEqual ...
	LessThanOrEqual Operator = "LessThanOrEqual"
)

func PossibleOperatorValues 

func PossibleOperatorValues() []Operator

PossibleOperatorValues returns an array of possible values for the Operator const type.

type PoliciesClient 

type PoliciesClient struct {
	BaseClient
}

PoliciesClient is the frontDoor Client

func NewPoliciesClient 

func NewPoliciesClient(subscriptionID string) PoliciesClient

NewPoliciesClient creates an instance of the PoliciesClient client.

func NewPoliciesClientWithBaseURI 

func NewPoliciesClientWithBaseURI(baseURI string, subscriptionID string) PoliciesClient

NewPoliciesClientWithBaseURI creates an instance of the PoliciesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (PoliciesClient) CreateOrUpdate 

func (client PoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, policyName string, parameters WebApplicationFirewallPolicy1) (result WebApplicationFirewallPolicy1, err error)

CreateOrUpdate creates or update policy with specified rule set name within a resource group. Parameters: resourceGroupName - the name of the resource group. policyName - the name of the resource group. parameters - policy to be created.

func (PoliciesClient) CreateOrUpdatePreparer 

func (client PoliciesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, policyName string, parameters WebApplicationFirewallPolicy1) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PoliciesClient) CreateOrUpdateResponder 

func (client PoliciesClient) CreateOrUpdateResponder(resp *http.Response) (result WebApplicationFirewallPolicy1, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (PoliciesClient) CreateOrUpdateSender 

func (client PoliciesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (PoliciesClient) Delete 

func (client PoliciesClient) Delete(ctx context.Context, resourceGroupName string, policyName string) (result PoliciesDeleteFuture, err error)

Delete deletes Policy Parameters: resourceGroupName - the name of the resource group. policyName - the name of the resource group.

func (PoliciesClient) DeletePreparer 

func (client PoliciesClient) DeletePreparer(ctx context.Context, resourceGroupName string, policyName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PoliciesClient) DeleteResponder 

func (client PoliciesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (PoliciesClient) DeleteSender 

func (client PoliciesClient) DeleteSender(req *http.Request) (future PoliciesDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (PoliciesClient) Get 

func (client PoliciesClient) Get(ctx context.Context, resourceGroupName string, policyName string) (result WebApplicationFirewallPolicy1, err error)

Get retrieve protection policy with specified name within a resource group. Parameters: resourceGroupName - the name of the resource group. policyName - the name of the resource group.

func (PoliciesClient) GetPreparer 

func (client PoliciesClient) GetPreparer(ctx context.Context, resourceGroupName string, policyName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PoliciesClient) GetResponder 

func (client PoliciesClient) GetResponder(resp *http.Response) (result WebApplicationFirewallPolicy1, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PoliciesClient) GetSender 

func (client PoliciesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (PoliciesClient) List 

func (client PoliciesClient) List(ctx context.Context, resourceGroupName string) (result WebApplicationFirewallPolicyListResultPage, err error)

List lists all of the protection policies within a resource group. Parameters: resourceGroupName - the name of the resource group.

func (PoliciesClient) ListComplete 

func (client PoliciesClient) ListComplete(ctx context.Context, resourceGroupName string) (result WebApplicationFirewallPolicyListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (PoliciesClient) ListPreparer 

func (client PoliciesClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (PoliciesClient) ListResponder 

func (client PoliciesClient) ListResponder(resp *http.Response) (result WebApplicationFirewallPolicyListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (PoliciesClient) ListSender 

func (client PoliciesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type PoliciesDeleteFuture 

type PoliciesDeleteFuture struct {
	azure.Future
}

PoliciesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PoliciesDeleteFuture) Result 

func (future *PoliciesDeleteFuture) Result(client PoliciesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PolicySettings 

type PolicySettings struct {
	// EnabledState - describes if the policy is in enabled state or disabled state. Possible values include: 'EnabledStateDisabled', 'EnabledStateEnabled'
	EnabledState EnabledState `json:"enabledState,omitempty"`
	// Mode - Describes if it is in detection mode  or prevention mode at policy level. Possible values include: 'Prevention', 'Detection'
	Mode Mode `json:"mode,omitempty"`
}

PolicySettings defines contents of a web application firewall global configuration

type Properties 

type Properties struct {
	// ResourceState - Resource status of the Front Door. Possible values include: 'ResourceStateCreating', 'ResourceStateEnabling', 'ResourceStateEnabled', 'ResourceStateDisabling', 'ResourceStateDisabled', 'ResourceStateDeleting'
	ResourceState ResourceState `json:"resourceState,omitempty"`
	// ProvisioningState - READ-ONLY; Provisioning state of the Front Door.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// Cname - READ-ONLY; The host that each frontendEndpoint must CNAME to.
	Cname *string `json:"cname,omitempty"`
	// FriendlyName - A friendly name for the frontDoor
	FriendlyName *string `json:"friendlyName,omitempty"`
	// RoutingRules - Routing rules associated with this Front Door.
	RoutingRules *[]RoutingRule `json:"routingRules,omitempty"`
	// LoadBalancingSettings - Load balancing settings associated with this Front Door instance.
	LoadBalancingSettings *[]LoadBalancingSettingsModel `json:"loadBalancingSettings,omitempty"`
	// HealthProbeSettings - Health probe settings associated with this Front Door instance.
	HealthProbeSettings *[]HealthProbeSettingsModel `json:"healthProbeSettings,omitempty"`
	// BackendPools - Backend pools available to routing rules.
	BackendPools *[]BackendPool `json:"backendPools,omitempty"`
	// FrontendEndpoints - Frontend endpoints available to routing rules.
	FrontendEndpoints *[]FrontendEndpoint `json:"frontendEndpoints,omitempty"`
	// EnabledState - Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'EnabledStateEnumEnabled', 'EnabledStateEnumDisabled'
	EnabledState EnabledStateEnum `json:"enabledState,omitempty"`
}

Properties the JSON object that contains the properties required to create an endpoint.

type Protocol 

type Protocol string

Protocol enumerates the values for protocol. 

const (
	// HTTP ...
	HTTP Protocol = "Http"
	// HTTPS ...
	HTTPS Protocol = "Https"
)

func PossibleProtocolValues 

func PossibleProtocolValues() []Protocol

PossibleProtocolValues returns an array of possible values for the Protocol const type.

type PurgeParameters 

type PurgeParameters struct {
	// ContentPaths - The path to the content to be purged. Can describe a file path or a wild card directory.
	ContentPaths *[]string `json:"contentPaths,omitempty"`
}

PurgeParameters parameters required for content purge.

type Query 

type Query string

Query enumerates the values for query. 

const (
	// StripAll ...
	StripAll Query = "StripAll"
	// StripNone ...
	StripNone Query = "StripNone"
)

func PossibleQueryValues 

func PossibleQueryValues() []Query

PossibleQueryValues returns an array of possible values for the Query const type.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

Resource common resource representation.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ResourceState 

type ResourceState string

ResourceState enumerates the values for resource state. 

const (
	// ResourceStateCreating ...
	ResourceStateCreating ResourceState = "Creating"
	// ResourceStateDeleting ...
	ResourceStateDeleting ResourceState = "Deleting"
	// ResourceStateDisabled ...
	ResourceStateDisabled ResourceState = "Disabled"
	// ResourceStateDisabling ...
	ResourceStateDisabling ResourceState = "Disabling"
	// ResourceStateEnabled ...
	ResourceStateEnabled ResourceState = "Enabled"
	// ResourceStateEnabling ...
	ResourceStateEnabling ResourceState = "Enabling"
)

func PossibleResourceStateValues 

func PossibleResourceStateValues() []ResourceState

PossibleResourceStateValues returns an array of possible values for the ResourceState const type.

type ResourceType 

type ResourceType string

ResourceType enumerates the values for resource type. 

const (
	// MicrosoftNetworkfrontDoors ...
	MicrosoftNetworkfrontDoors ResourceType = "Microsoft.Network/frontDoors"
	// MicrosoftNetworkfrontDoorsfrontendEndpoints ...
	MicrosoftNetworkfrontDoorsfrontendEndpoints ResourceType = "Microsoft.Network/frontDoors/frontendEndpoints"
)

func PossibleResourceTypeValues 

func PossibleResourceTypeValues() []ResourceType

PossibleResourceTypeValues returns an array of possible values for the ResourceType const type.

type RoutingRule 

type RoutingRule struct {
	// RoutingRuleProperties - Properties of the Front Door Routing Rule
	*RoutingRuleProperties `json:"properties,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
}

RoutingRule a routing rule represents a specification for traffic to treat and where to send it, along with health probe information.

func (RoutingRule) MarshalJSON 

func (rr RoutingRule) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RoutingRule.

func (*RoutingRule) UnmarshalJSON 

func (rr *RoutingRule) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RoutingRule struct.

type RoutingRuleListResult 

type RoutingRuleListResult struct {
	// Value - READ-ONLY; List of Routing Rules within a Front Door.
	Value *[]RoutingRule `json:"value,omitempty"`
	// NextLink - URL to get the next set of RoutingRule objects if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

RoutingRuleListResult result of the request to list Routing Rules. It contains a list of Routing Rule objects and a URL link to get the next set of results.

type RoutingRuleProperties 

type RoutingRuleProperties struct {
	// ResourceState - Resource status. Possible values include: 'ResourceStateCreating', 'ResourceStateEnabling', 'ResourceStateEnabled', 'ResourceStateDisabling', 'ResourceStateDisabled', 'ResourceStateDeleting'
	ResourceState ResourceState `json:"resourceState,omitempty"`
	// FrontendEndpoints - Frontend endpoints associated with this rule
	FrontendEndpoints *[]SubResource `json:"frontendEndpoints,omitempty"`
	// AcceptedProtocols - Protocol schemes to match for this rule
	AcceptedProtocols *[]Protocol `json:"acceptedProtocols,omitempty"`
	// PatternsToMatch - The route patterns of the rule.
	PatternsToMatch *[]string `json:"patternsToMatch,omitempty"`
	// CustomForwardingPath - A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
	CustomForwardingPath *string `json:"customForwardingPath,omitempty"`
	// ForwardingProtocol - Protocol this rule will use when forwarding traffic to backends. Possible values include: 'HTTPOnly', 'HTTPSOnly', 'MatchRequest'
	ForwardingProtocol ForwardingProtocol `json:"forwardingProtocol,omitempty"`
	// CacheConfiguration - The caching configuration associated with this rule.
	CacheConfiguration *CacheConfiguration `json:"cacheConfiguration,omitempty"`
	// BackendPool - A reference to the BackendPool which this rule routes to.
	BackendPool *SubResource `json:"backendPool,omitempty"`
	// EnabledState - Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'EnabledStateEnumEnabled', 'EnabledStateEnumDisabled'
	EnabledState EnabledStateEnum `json:"enabledState,omitempty"`
}

RoutingRuleProperties the JSON object that contains the properties required to create a routing rule.

type RoutingRuleUpdateParameters 

type RoutingRuleUpdateParameters struct {
	// FrontendEndpoints - Frontend endpoints associated with this rule
	FrontendEndpoints *[]SubResource `json:"frontendEndpoints,omitempty"`
	// AcceptedProtocols - Protocol schemes to match for this rule
	AcceptedProtocols *[]Protocol `json:"acceptedProtocols,omitempty"`
	// PatternsToMatch - The route patterns of the rule.
	PatternsToMatch *[]string `json:"patternsToMatch,omitempty"`
	// CustomForwardingPath - A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
	CustomForwardingPath *string `json:"customForwardingPath,omitempty"`
	// ForwardingProtocol - Protocol this rule will use when forwarding traffic to backends. Possible values include: 'HTTPOnly', 'HTTPSOnly', 'MatchRequest'
	ForwardingProtocol ForwardingProtocol `json:"forwardingProtocol,omitempty"`
	// CacheConfiguration - The caching configuration associated with this rule.
	CacheConfiguration *CacheConfiguration `json:"cacheConfiguration,omitempty"`
	// BackendPool - A reference to the BackendPool which this rule routes to.
	BackendPool *SubResource `json:"backendPool,omitempty"`
	// EnabledState - Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'EnabledStateEnumEnabled', 'EnabledStateEnumDisabled'
	EnabledState EnabledStateEnum `json:"enabledState,omitempty"`
}

RoutingRuleUpdateParameters routing rules to apply to an endpoint

type RuleGroupOverride 

type RuleGroupOverride string

RuleGroupOverride enumerates the values for rule group override. 

const (
	// SQLInjection ...
	SQLInjection RuleGroupOverride = "SqlInjection"
	// XSS ...
	XSS RuleGroupOverride = "XSS"
)

func PossibleRuleGroupOverrideValues 

func PossibleRuleGroupOverrideValues() []RuleGroupOverride

PossibleRuleGroupOverrideValues returns an array of possible values for the RuleGroupOverride const type.

type RuleSetType 

type RuleSetType string

RuleSetType enumerates the values for rule set type. 

const (
	// RuleSetTypeAzureManagedRuleSet ...
	RuleSetTypeAzureManagedRuleSet RuleSetType = "AzureManagedRuleSet"
	// RuleSetTypeUnknown ...
	RuleSetTypeUnknown RuleSetType = "Unknown"
)

func PossibleRuleSetTypeValues 

func PossibleRuleSetTypeValues() []RuleSetType

PossibleRuleSetTypeValues returns an array of possible values for the RuleSetType const type.

type RuleType 

type RuleType string

RuleType enumerates the values for rule type. 

const (
	// MatchRule ...
	MatchRule RuleType = "MatchRule"
	// RateLimitRule ...
	RateLimitRule RuleType = "RateLimitRule"
)

func PossibleRuleTypeValues 

func PossibleRuleTypeValues() []RuleType

PossibleRuleTypeValues returns an array of possible values for the RuleType const type.

type SessionAffinityEnabledState 

type SessionAffinityEnabledState string

SessionAffinityEnabledState enumerates the values for session affinity enabled state. 

const (
	// SessionAffinityEnabledStateDisabled ...
	SessionAffinityEnabledStateDisabled SessionAffinityEnabledState = "Disabled"
	// SessionAffinityEnabledStateEnabled ...
	SessionAffinityEnabledStateEnabled SessionAffinityEnabledState = "Enabled"
)

func PossibleSessionAffinityEnabledStateValues 

func PossibleSessionAffinityEnabledStateValues() []SessionAffinityEnabledState

PossibleSessionAffinityEnabledStateValues returns an array of possible values for the SessionAffinityEnabledState const type.

type SubResource 

type SubResource struct {
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
}

SubResource reference to another subresource.

type TLSProtocolType 

type TLSProtocolType string

TLSProtocolType enumerates the values for tls protocol type. 

const (
	// ServerNameIndication ...
	ServerNameIndication TLSProtocolType = "ServerNameIndication"
)

func PossibleTLSProtocolTypeValues 

func PossibleTLSProtocolTypeValues() []TLSProtocolType

PossibleTLSProtocolTypeValues returns an array of possible values for the TLSProtocolType const type.

type TagsObject 

type TagsObject struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

TagsObject tags object for patch operations.

func (TagsObject) MarshalJSON 

func (toVar TagsObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagsObject.

type Transform 

type Transform string

Transform enumerates the values for transform. 

const (
	// HTMLEntityDecode ...
	HTMLEntityDecode Transform = "HtmlEntityDecode"
	// Lowercase ...
	Lowercase Transform = "Lowercase"
	// RemoveNulls ...
	RemoveNulls Transform = "RemoveNulls"
	// Trim ...
	Trim Transform = "Trim"
	// Uppercase ...
	Uppercase Transform = "Uppercase"
	// URLDecode ...
	URLDecode Transform = "UrlDecode"
	// URLEncode ...
	URLEncode Transform = "UrlEncode"
)

func PossibleTransformValues 

func PossibleTransformValues() []Transform

PossibleTransformValues returns an array of possible values for the Transform const type.

type UpdateParameters 

type UpdateParameters struct {
	// FriendlyName - A friendly name for the frontDoor
	FriendlyName *string `json:"friendlyName,omitempty"`
	// RoutingRules - Routing rules associated with this Front Door.
	RoutingRules *[]RoutingRule `json:"routingRules,omitempty"`
	// LoadBalancingSettings - Load balancing settings associated with this Front Door instance.
	LoadBalancingSettings *[]LoadBalancingSettingsModel `json:"loadBalancingSettings,omitempty"`
	// HealthProbeSettings - Health probe settings associated with this Front Door instance.
	HealthProbeSettings *[]HealthProbeSettingsModel `json:"healthProbeSettings,omitempty"`
	// BackendPools - Backend pools available to routing rules.
	BackendPools *[]BackendPool `json:"backendPools,omitempty"`
	// FrontendEndpoints - Frontend endpoints available to routing rules.
	FrontendEndpoints *[]FrontendEndpoint `json:"frontendEndpoints,omitempty"`
	// EnabledState - Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'EnabledStateEnumEnabled', 'EnabledStateEnumDisabled'
	EnabledState EnabledStateEnum `json:"enabledState,omitempty"`
}

UpdateParameters the properties needed to update a Front Door

type ValidateCustomDomainInput 

type ValidateCustomDomainInput struct {
	// HostName - The host name of the custom domain. Must be a domain name.
	HostName *string `json:"hostName,omitempty"`
}

ValidateCustomDomainInput input of the custom domain to be validated for DNS mapping.

type ValidateCustomDomainOutput 

type ValidateCustomDomainOutput struct {
	autorest.Response `json:"-"`
	// CustomDomainValidated - READ-ONLY; Indicates whether the custom domain is valid or not.
	CustomDomainValidated *bool `json:"customDomainValidated,omitempty"`
	// Reason - READ-ONLY; The reason why the custom domain is not valid.
	Reason *string `json:"reason,omitempty"`
	// Message - READ-ONLY; Error message describing why the custom domain is not valid.
	Message *string `json:"message,omitempty"`
}

ValidateCustomDomainOutput output of custom domain validation.

type WebApplicationFirewallPolicy 

type WebApplicationFirewallPolicy string

WebApplicationFirewallPolicy enumerates the values for web application firewall policy. 

const (
	// WebApplicationFirewallPolicyCreating ...
	WebApplicationFirewallPolicyCreating WebApplicationFirewallPolicy = "Creating"
	// WebApplicationFirewallPolicyDeleting ...
	WebApplicationFirewallPolicyDeleting WebApplicationFirewallPolicy = "Deleting"
	// WebApplicationFirewallPolicyDisabled ...
	WebApplicationFirewallPolicyDisabled WebApplicationFirewallPolicy = "Disabled"
	// WebApplicationFirewallPolicyDisabling ...
	WebApplicationFirewallPolicyDisabling WebApplicationFirewallPolicy = "Disabling"
	// WebApplicationFirewallPolicyEnabled ...
	WebApplicationFirewallPolicyEnabled WebApplicationFirewallPolicy = "Enabled"
	// WebApplicationFirewallPolicyEnabling ...
	WebApplicationFirewallPolicyEnabling WebApplicationFirewallPolicy = "Enabling"
)

func PossibleWebApplicationFirewallPolicyValues 

func PossibleWebApplicationFirewallPolicyValues() []WebApplicationFirewallPolicy

PossibleWebApplicationFirewallPolicyValues returns an array of possible values for the WebApplicationFirewallPolicy const type.

type WebApplicationFirewallPolicy1 

type WebApplicationFirewallPolicy1 struct {
	autorest.Response `json:"-"`
	// WebApplicationFirewallPolicyPropertiesFormat - Properties of the web application firewall policy.
	*WebApplicationFirewallPolicyPropertiesFormat `json:"properties,omitempty"`
	// Etag - Gets a unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

WebApplicationFirewallPolicy1 defines web application firewall policy.

func (WebApplicationFirewallPolicy1) MarshalJSON 

func (wafp1 WebApplicationFirewallPolicy1) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WebApplicationFirewallPolicy1.

func (*WebApplicationFirewallPolicy1) UnmarshalJSON 

func (wafp1 *WebApplicationFirewallPolicy1) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for WebApplicationFirewallPolicy1 struct.

type WebApplicationFirewallPolicyListResult 

type WebApplicationFirewallPolicyListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of WebApplicationFirewallPolicies within a resource group.
	Value *[]WebApplicationFirewallPolicy1 `json:"value,omitempty"`
	// NextLink - URL to get the next set of WebApplicationFirewallPolicy objects if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

WebApplicationFirewallPolicyListResult result of the request to list WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.

func (WebApplicationFirewallPolicyListResult) IsEmpty 

func (wafplr WebApplicationFirewallPolicyListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type WebApplicationFirewallPolicyListResultIterator 

type WebApplicationFirewallPolicyListResultIterator struct {
	// contains filtered or unexported fields
}

WebApplicationFirewallPolicyListResultIterator provides access to a complete listing of WebApplicationFirewallPolicy1 values.

func NewWebApplicationFirewallPolicyListResultIterator 

func NewWebApplicationFirewallPolicyListResultIterator(page WebApplicationFirewallPolicyListResultPage) WebApplicationFirewallPolicyListResultIterator

Creates a new instance of the WebApplicationFirewallPolicyListResultIterator type.

func (*WebApplicationFirewallPolicyListResultIterator) Next 

func (iter *WebApplicationFirewallPolicyListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*WebApplicationFirewallPolicyListResultIterator) NextWithContext 

func (iter *WebApplicationFirewallPolicyListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (WebApplicationFirewallPolicyListResultIterator) NotDone 

func (iter WebApplicationFirewallPolicyListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (WebApplicationFirewallPolicyListResultIterator) Response 

func (iter WebApplicationFirewallPolicyListResultIterator) Response() WebApplicationFirewallPolicyListResult

Response returns the raw server response from the last page request.

func (WebApplicationFirewallPolicyListResultIterator) Value 

func (iter WebApplicationFirewallPolicyListResultIterator) Value() WebApplicationFirewallPolicy1

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type WebApplicationFirewallPolicyListResultPage 

type WebApplicationFirewallPolicyListResultPage struct {
	// contains filtered or unexported fields
}

WebApplicationFirewallPolicyListResultPage contains a page of WebApplicationFirewallPolicy1 values.

func NewWebApplicationFirewallPolicyListResultPage 

func NewWebApplicationFirewallPolicyListResultPage(getNextPage func(context.Context, WebApplicationFirewallPolicyListResult) (WebApplicationFirewallPolicyListResult, error)) WebApplicationFirewallPolicyListResultPage

Creates a new instance of the WebApplicationFirewallPolicyListResultPage type.

func (*WebApplicationFirewallPolicyListResultPage) Next 

func (page *WebApplicationFirewallPolicyListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*WebApplicationFirewallPolicyListResultPage) NextWithContext 

func (page *WebApplicationFirewallPolicyListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (WebApplicationFirewallPolicyListResultPage) NotDone 

func (page WebApplicationFirewallPolicyListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (WebApplicationFirewallPolicyListResultPage) Response 

func (page WebApplicationFirewallPolicyListResultPage) Response() WebApplicationFirewallPolicyListResult

Response returns the raw server response from the last page request.

func (WebApplicationFirewallPolicyListResultPage) Values 

func (page WebApplicationFirewallPolicyListResultPage) Values() []WebApplicationFirewallPolicy1

Values returns the slice of values for the current page or nil if there are no values.

type WebApplicationFirewallPolicyPropertiesFormat 

type WebApplicationFirewallPolicyPropertiesFormat struct {
	// PolicySettings - Describes  policySettings for policy
	PolicySettings *PolicySettings `json:"policySettings,omitempty"`
	// CustomRules - Describes custom rules inside the policy
	CustomRules *CustomRules `json:"customRules,omitempty"`
	// ManagedRules - Describes managed rules inside the policy
	ManagedRules *ManagedRuleSets `json:"managedRules,omitempty"`
	// ProvisioningState - READ-ONLY; Provisioning state of the WebApplicationFirewallPolicy.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// ResourceState - READ-ONLY; Possible values include: 'WebApplicationFirewallPolicyCreating', 'WebApplicationFirewallPolicyEnabling', 'WebApplicationFirewallPolicyEnabled', 'WebApplicationFirewallPolicyDisabling', 'WebApplicationFirewallPolicyDisabled', 'WebApplicationFirewallPolicyDeleting'
	ResourceState WebApplicationFirewallPolicy `json:"resourceState,omitempty"`
}

WebApplicationFirewallPolicyPropertiesFormat defines web application firewall policy properties

Source Files

View all Source files

Directories

Path Synopsis

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.