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: 0

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 ActionType

type ActionType string

ActionType enumerates the values for action type.

const (
	// Allow ...
	Allow ActionType = "Allow"
	// Block ...
	Block ActionType = "Block"
	// Log ...
	Log ActionType = "Log"
	// Redirect ...
	Redirect ActionType = "Redirect"
)

func PossibleActionTypeValues

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns an array of possible values for the ActionType 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: 'InProgress', 'Succeeded', 'Failed'
	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 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: 'Enabled', 'Disabled'
	EnabledState BackendEnabledState `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 BackendEnabledState

type BackendEnabledState string

BackendEnabledState enumerates the values for backend enabled state.

const (
	// Disabled ...
	Disabled BackendEnabledState = "Disabled"
	// Enabled ...
	Enabled BackendEnabledState = "Enabled"
)

func PossibleBackendEnabledStateValues

func PossibleBackendEnabledStateValues() []BackendEnabledState

PossibleBackendEnabledStateValues returns an array of possible values for the BackendEnabledState const type.

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 BackendPoolsSettings

type BackendPoolsSettings struct {
	// EnforceCertificateNameCheck - Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. Possible values include: 'EnforceCertificateNameCheckEnabledStateEnabled', 'EnforceCertificateNameCheckEnabledStateDisabled'
	EnforceCertificateNameCheck EnforceCertificateNameCheckEnabledState `json:"enforceCertificateNameCheck,omitempty"`
}

BackendPoolsSettings settings that apply to all backend pools.

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 BasicRouteConfiguration

type BasicRouteConfiguration interface {
	AsForwardingConfiguration() (*ForwardingConfiguration, bool)
	AsRedirectConfiguration() (*RedirectConfiguration, bool)
	AsRouteConfiguration() (*RouteConfiguration, bool)
}

BasicRouteConfiguration base class for all types of Route.

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 (
	// CustomHTTPSProvisioningStateDisabled ...
	CustomHTTPSProvisioningStateDisabled CustomHTTPSProvisioningState = "Disabled"
	// CustomHTTPSProvisioningStateDisabling ...
	CustomHTTPSProvisioningStateDisabling CustomHTTPSProvisioningState = "Disabling"
	// CustomHTTPSProvisioningStateEnabled ...
	CustomHTTPSProvisioningStateEnabled CustomHTTPSProvisioningState = "Enabled"
	// CustomHTTPSProvisioningStateEnabling ...
	CustomHTTPSProvisioningStateEnabling CustomHTTPSProvisioningState = "Enabling"
	// CustomHTTPSProvisioningStateFailed ...
	CustomHTTPSProvisioningStateFailed 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 - Describes the name of the rule.
	Name *string `json:"name,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"`
	// EnabledState - Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Possible values include: 'CustomRuleEnabledStateDisabled', 'CustomRuleEnabledStateEnabled'
	EnabledState CustomRuleEnabledState `json:"enabledState,omitempty"`
	// RuleType - Describes type of rule. Possible values include: 'MatchRule', 'RateLimitRule'
	RuleType RuleType `json:"ruleType,omitempty"`
	// RateLimitDurationInMinutes - Time window for resetting the rate limit count. Default is 1 minute.
	RateLimitDurationInMinutes *int32 `json:"rateLimitDurationInMinutes,omitempty"`
	// RateLimitThreshold - Number of allowed requests per client within the time window.
	RateLimitThreshold *int32 `json:"rateLimitThreshold,omitempty"`
	// MatchConditions - List of match conditions.
	MatchConditions *[]MatchCondition `json:"matchConditions,omitempty"`
	// Action - Describes what action to be applied when rule matches. Possible values include: 'Allow', 'Block', 'Log', 'Redirect'
	Action ActionType `json:"action,omitempty"`
}

CustomRule defines contents of a web application rule

type CustomRuleEnabledState

type CustomRuleEnabledState string

CustomRuleEnabledState enumerates the values for custom rule enabled state.

const (
	// CustomRuleEnabledStateDisabled ...
	CustomRuleEnabledStateDisabled CustomRuleEnabledState = "Disabled"
	// CustomRuleEnabledStateEnabled ...
	CustomRuleEnabledStateEnabled CustomRuleEnabledState = "Enabled"
)

func PossibleCustomRuleEnabledStateValues

func PossibleCustomRuleEnabledStateValues() []CustomRuleEnabledState

PossibleCustomRuleEnabledStateValues returns an array of possible values for the CustomRuleEnabledState const type.

type CustomRuleList

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

CustomRuleList 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 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 EnforceCertificateNameCheckEnabledState

type EnforceCertificateNameCheckEnabledState string

EnforceCertificateNameCheckEnabledState enumerates the values for enforce certificate name check enabled state.

const (
	// EnforceCertificateNameCheckEnabledStateDisabled ...
	EnforceCertificateNameCheckEnabledStateDisabled EnforceCertificateNameCheckEnabledState = "Disabled"
	// EnforceCertificateNameCheckEnabledStateEnabled ...
	EnforceCertificateNameCheckEnabledStateEnabled EnforceCertificateNameCheckEnabledState = "Enabled"
)

func PossibleEnforceCertificateNameCheckEnabledStateValues

func PossibleEnforceCertificateNameCheckEnabledStateValues() []EnforceCertificateNameCheckEnabledState

PossibleEnforceCertificateNameCheckEnabledStateValues returns an array of possible values for the EnforceCertificateNameCheckEnabledState const type.

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 ForwardingConfiguration

type ForwardingConfiguration struct {
	// 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"`
	// OdataType - Possible values include: 'OdataTypeRouteConfiguration', 'OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorForwardingConfiguration', 'OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorRedirectConfiguration'
	OdataType OdataType `json:"@odata.type,omitempty"`
}

ForwardingConfiguration describes Forwarding Route.

func (ForwardingConfiguration) AsBasicRouteConfiguration

func (fc ForwardingConfiguration) AsBasicRouteConfiguration() (BasicRouteConfiguration, bool)

AsBasicRouteConfiguration is the BasicRouteConfiguration implementation for ForwardingConfiguration.

func (ForwardingConfiguration) AsForwardingConfiguration

func (fc ForwardingConfiguration) AsForwardingConfiguration() (*ForwardingConfiguration, bool)

AsForwardingConfiguration is the BasicRouteConfiguration implementation for ForwardingConfiguration.

func (ForwardingConfiguration) AsRedirectConfiguration

func (fc ForwardingConfiguration) AsRedirectConfiguration() (*RedirectConfiguration, bool)

AsRedirectConfiguration is the BasicRouteConfiguration implementation for ForwardingConfiguration.

func (ForwardingConfiguration) AsRouteConfiguration

func (fc ForwardingConfiguration) AsRouteConfiguration() (*RouteConfiguration, bool)

AsRouteConfiguration is the BasicRouteConfiguration implementation for ForwardingConfiguration.

func (ForwardingConfiguration) MarshalJSON

func (fc ForwardingConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ForwardingConfiguration.

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 FrontendEndpointLink struct {
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
}

FrontendEndpointLink defines the Resource ID for a Frontend Endpoint.

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: 'CustomHTTPSProvisioningStateEnabling', 'CustomHTTPSProvisioningStateEnabled', 'CustomHTTPSProvisioningStateDisabling', 'CustomHTTPSProvisioningStateDisabled', 'CustomHTTPSProvisioningStateFailed'
	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

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

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

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

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

func (FrontendEndpointsListResultIterator) Response

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

func (FrontendEndpointsListResultIterator) Value

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

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

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

func (FrontendEndpointsListResultPage) Values

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 ManagedRuleDefinition

type ManagedRuleDefinition struct {
	// RuleID - READ-ONLY; Identifier for the managed rule.
	RuleID *string `json:"ruleId,omitempty"`
	// DefaultState - READ-ONLY; Describes the default state for the managed rule. Possible values include: 'ManagedRuleEnabledStateDisabled', 'ManagedRuleEnabledStateEnabled'
	DefaultState ManagedRuleEnabledState `json:"defaultState,omitempty"`
	// DefaultAction - READ-ONLY; Describes the default action to be applied when the managed rule matches. Possible values include: 'Allow', 'Block', 'Log', 'Redirect'
	DefaultAction ActionType `json:"defaultAction,omitempty"`
	// Description - READ-ONLY; Describes the functionality of the managed rule.
	Description *string `json:"description,omitempty"`
}

ManagedRuleDefinition describes a managed rule definition.

type ManagedRuleEnabledState

type ManagedRuleEnabledState string

ManagedRuleEnabledState enumerates the values for managed rule enabled state.

const (
	// ManagedRuleEnabledStateDisabled ...
	ManagedRuleEnabledStateDisabled ManagedRuleEnabledState = "Disabled"
	// ManagedRuleEnabledStateEnabled ...
	ManagedRuleEnabledStateEnabled ManagedRuleEnabledState = "Enabled"
)

func PossibleManagedRuleEnabledStateValues

func PossibleManagedRuleEnabledStateValues() []ManagedRuleEnabledState

PossibleManagedRuleEnabledStateValues returns an array of possible values for the ManagedRuleEnabledState const type.

type ManagedRuleGroupDefinition

type ManagedRuleGroupDefinition struct {
	// RuleGroupName - READ-ONLY; Name of the managed rule group.
	RuleGroupName *string `json:"ruleGroupName,omitempty"`
	// Description - READ-ONLY; Description of the managed rule group.
	Description *string `json:"description,omitempty"`
	// Rules - READ-ONLY; List of rules within the managed rule group.
	Rules *[]ManagedRuleDefinition `json:"rules,omitempty"`
}

ManagedRuleGroupDefinition describes a managed rule group.

type ManagedRuleGroupOverride

type ManagedRuleGroupOverride struct {
	// RuleGroupName - Describes the managed rule group to override.
	RuleGroupName *string `json:"ruleGroupName,omitempty"`
	// Rules - List of rules that will be disabled. If none specified, all rules in the group will be disabled.
	Rules *[]ManagedRuleOverride `json:"rules,omitempty"`
}

ManagedRuleGroupOverride defines a managed rule group override setting.

type ManagedRuleOverride

type ManagedRuleOverride struct {
	// RuleID - Identifier for the managed rule.
	RuleID *string `json:"ruleId,omitempty"`
	// EnabledState - Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. Possible values include: 'ManagedRuleEnabledStateDisabled', 'ManagedRuleEnabledStateEnabled'
	EnabledState ManagedRuleEnabledState `json:"enabledState,omitempty"`
	// Action - Describes the override action to be applied when rule matches. Possible values include: 'Allow', 'Block', 'Log', 'Redirect'
	Action ActionType `json:"action,omitempty"`
}

ManagedRuleOverride defines a managed rule group override setting.

type ManagedRuleSet

type ManagedRuleSet struct {
	// RuleSetType - Defines the rule set type to use.
	RuleSetType *string `json:"ruleSetType,omitempty"`
	// RuleSetVersion - Defines the version of the rule set to use.
	RuleSetVersion *string `json:"ruleSetVersion,omitempty"`
	// RuleGroupOverrides - Defines the rule group overrides to apply to the rule set.
	RuleGroupOverrides *[]ManagedRuleGroupOverride `json:"ruleGroupOverrides,omitempty"`
}

ManagedRuleSet defines a managed rule set.

type ManagedRuleSetDefinition

type ManagedRuleSetDefinition struct {
	// ManagedRuleSetDefinitionProperties - Properties for a managed rule set definition.
	*ManagedRuleSetDefinitionProperties `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"`
}

ManagedRuleSetDefinition describes the a managed rule set definition.

func (ManagedRuleSetDefinition) MarshalJSON

func (mrsd ManagedRuleSetDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagedRuleSetDefinition.

func (*ManagedRuleSetDefinition) UnmarshalJSON

func (mrsd *ManagedRuleSetDefinition) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ManagedRuleSetDefinition struct.

type ManagedRuleSetDefinitionList

type ManagedRuleSetDefinitionList struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of managed rule set definitions.
	Value *[]ManagedRuleSetDefinition `json:"value,omitempty"`
	// NextLink - URL to retrieve next set of managed rule set definitions.
	NextLink *string `json:"nextLink,omitempty"`
}

ManagedRuleSetDefinitionList list of managed rule set definitions available for use in a policy.

func (ManagedRuleSetDefinitionList) IsEmpty

func (mrsdl ManagedRuleSetDefinitionList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ManagedRuleSetDefinitionListIterator

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

ManagedRuleSetDefinitionListIterator provides access to a complete listing of ManagedRuleSetDefinition values.

func NewManagedRuleSetDefinitionListIterator

func NewManagedRuleSetDefinitionListIterator(page ManagedRuleSetDefinitionListPage) ManagedRuleSetDefinitionListIterator

Creates a new instance of the ManagedRuleSetDefinitionListIterator type.

func (*ManagedRuleSetDefinitionListIterator) Next

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 (*ManagedRuleSetDefinitionListIterator) NextWithContext

func (iter *ManagedRuleSetDefinitionListIterator) 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 (ManagedRuleSetDefinitionListIterator) NotDone

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

func (ManagedRuleSetDefinitionListIterator) Response

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

func (ManagedRuleSetDefinitionListIterator) Value

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

type ManagedRuleSetDefinitionListPage

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

ManagedRuleSetDefinitionListPage contains a page of ManagedRuleSetDefinition values.

func NewManagedRuleSetDefinitionListPage

Creates a new instance of the ManagedRuleSetDefinitionListPage type.

func (*ManagedRuleSetDefinitionListPage) Next

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 (*ManagedRuleSetDefinitionListPage) NextWithContext

func (page *ManagedRuleSetDefinitionListPage) 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 (ManagedRuleSetDefinitionListPage) NotDone

func (page ManagedRuleSetDefinitionListPage) NotDone() bool

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

func (ManagedRuleSetDefinitionListPage) Response

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

func (ManagedRuleSetDefinitionListPage) Values

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

type ManagedRuleSetDefinitionProperties

type ManagedRuleSetDefinitionProperties struct {
	// ProvisioningState - READ-ONLY; Provisioning state of the managed rule set.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// RuleSetID - READ-ONLY; Id of the managed rule set.
	RuleSetID *string `json:"ruleSetId,omitempty"`
	// RuleSetType - READ-ONLY; Type of the managed rule set.
	RuleSetType *string `json:"ruleSetType,omitempty"`
	// RuleSetVersion - READ-ONLY; Version of the managed rule set type.
	RuleSetVersion *string `json:"ruleSetVersion,omitempty"`
	// RuleGroups - READ-ONLY; Rule groups of the managed rule set.
	RuleGroups *[]ManagedRuleGroupDefinition `json:"ruleGroups,omitempty"`
}

ManagedRuleSetDefinitionProperties properties for a managed rule set definition.

type ManagedRuleSetList

type ManagedRuleSetList struct {
	// ManagedRuleSets - List of rule sets.
	ManagedRuleSets *[]ManagedRuleSet `json:"managedRuleSets,omitempty"`
}

ManagedRuleSetList defines the list of managed rule sets for the policy.

type ManagedRuleSetsClient

type ManagedRuleSetsClient struct {
	BaseClient
}

ManagedRuleSetsClient is the frontDoor Client

func NewManagedRuleSetsClient

func NewManagedRuleSetsClient(subscriptionID string) ManagedRuleSetsClient

NewManagedRuleSetsClient creates an instance of the ManagedRuleSetsClient client.

func NewManagedRuleSetsClientWithBaseURI

func NewManagedRuleSetsClientWithBaseURI(baseURI string, subscriptionID string) ManagedRuleSetsClient

NewManagedRuleSetsClientWithBaseURI creates an instance of the ManagedRuleSetsClient 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 (ManagedRuleSetsClient) List

List lists all available managed rule sets.

func (ManagedRuleSetsClient) ListComplete

func (client ManagedRuleSetsClient) ListComplete(ctx context.Context) (result ManagedRuleSetDefinitionListIterator, err error)

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

func (ManagedRuleSetsClient) ListPreparer

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

ListPreparer prepares the List request.

func (ManagedRuleSetsClient) ListResponder

func (client ManagedRuleSetsClient) ListResponder(resp *http.Response) (result ManagedRuleSetDefinitionList, err error)

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

func (ManagedRuleSetsClient) ListSender

func (client ManagedRuleSetsClient) 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 MatchCondition

type MatchCondition struct {
	// MatchVariable - Request variable to compare with. Possible values include: 'RemoteAddr', 'RequestMethod', 'QueryString', 'PostArgs', 'RequestURI', 'RequestHeader', 'RequestBody', 'Cookies', 'SocketAddr'
	MatchVariable MatchVariable `json:"matchVariable,omitempty"`
	// Selector - Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null.
	Selector *string `json:"selector,omitempty"`
	// Operator - Comparison type to use for matching with the variable value. Possible values include: 'Any', 'IPMatch', 'GeoMatch', 'Equal', 'Contains', 'LessThan', 'GreaterThan', 'LessThanOrEqual', 'GreaterThanOrEqual', 'BeginsWith', 'EndsWith', 'RegEx'
	Operator Operator `json:"operator,omitempty"`
	// NegateCondition - Describes if the result of this condition should be negated.
	NegateCondition *bool `json:"negateCondition,omitempty"`
	// MatchValue - List of possible match values.
	MatchValue *[]string `json:"matchValue,omitempty"`
	// Transforms - List of transforms.
	Transforms *[]TransformType `json:"transforms,omitempty"`
}

MatchCondition define a match condition.

type MatchVariable

type MatchVariable string

MatchVariable enumerates the values for match variable.

const (
	// Cookies ...
	Cookies MatchVariable = "Cookies"
	// PostArgs ...
	PostArgs MatchVariable = "PostArgs"
	// QueryString ...
	QueryString MatchVariable = "QueryString"
	// RemoteAddr ...
	RemoteAddr MatchVariable = "RemoteAddr"
	// RequestBody ...
	RequestBody MatchVariable = "RequestBody"
	// RequestHeader ...
	RequestHeader MatchVariable = "RequestHeader"
	// RequestMethod ...
	RequestMethod MatchVariable = "RequestMethod"
	// RequestURI ...
	RequestURI MatchVariable = "RequestUri"
	// SocketAddr ...
	SocketAddr MatchVariable = "SocketAddr"
)

func PossibleMatchVariableValues

func PossibleMatchVariableValues() []MatchVariable

PossibleMatchVariableValues returns an array of possible values for the MatchVariable const type.

type NetworkOperationStatus

type NetworkOperationStatus string

NetworkOperationStatus enumerates the values for network operation status.

const (
	// Failed ...
	Failed NetworkOperationStatus = "Failed"
	// InProgress ...
	InProgress NetworkOperationStatus = "InProgress"
	// Succeeded ...
	Succeeded NetworkOperationStatus = "Succeeded"
)

func PossibleNetworkOperationStatusValues

func PossibleNetworkOperationStatusValues() []NetworkOperationStatus

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

type OdataType

type OdataType string

OdataType enumerates the values for odata type.

const (
	// OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorForwardingConfiguration ...
	OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorForwardingConfiguration OdataType = "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration"
	// OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorRedirectConfiguration ...
	OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorRedirectConfiguration OdataType = "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration"
	// OdataTypeRouteConfiguration ...
	OdataTypeRouteConfiguration OdataType = "RouteConfiguration"
)

func PossibleOdataTypeValues

func PossibleOdataTypeValues() []OdataType

PossibleOdataTypeValues returns an array of possible values for the OdataType 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"
	// RegEx ...
	RegEx Operator = "RegEx"
)

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 WebApplicationFirewallPolicy) (result PoliciesCreateOrUpdateFuture, err error)

CreateOrUpdate create or update policy with specified rule set name within a resource group. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. policyName - the name of the Web Application Firewall Policy. parameters - policy to be created.

func (PoliciesClient) CreateOrUpdatePreparer

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PoliciesClient) CreateOrUpdateResponder

func (client PoliciesClient) CreateOrUpdateResponder(resp *http.Response) (result WebApplicationFirewallPolicy, 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) (future PoliciesCreateOrUpdateFuture, err 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 - name of the Resource group within the Azure subscription. policyName - the name of the Web Application Firewall Policy.

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 WebApplicationFirewallPolicy, err error)

Get retrieve protection policy with specified name within a resource group. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. policyName - the name of the Web Application Firewall Policy.

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 WebApplicationFirewallPolicy, 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 WebApplicationFirewallPolicyListPage, err error)

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

func (PoliciesClient) ListComplete

func (client PoliciesClient) ListComplete(ctx context.Context, resourceGroupName string) (result WebApplicationFirewallPolicyListIterator, 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 WebApplicationFirewallPolicyList, 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 PoliciesCreateOrUpdateFuture

type PoliciesCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*PoliciesCreateOrUpdateFuture) Result

Result returns the result of the asynchronous operation. If the operation has not completed it will return 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 PolicyEnabledState

type PolicyEnabledState string

PolicyEnabledState enumerates the values for policy enabled state.

const (
	// PolicyEnabledStateDisabled ...
	PolicyEnabledStateDisabled PolicyEnabledState = "Disabled"
	// PolicyEnabledStateEnabled ...
	PolicyEnabledStateEnabled PolicyEnabledState = "Enabled"
)

func PossiblePolicyEnabledStateValues

func PossiblePolicyEnabledStateValues() []PolicyEnabledState

PossiblePolicyEnabledStateValues returns an array of possible values for the PolicyEnabledState const type.

type PolicyMode

type PolicyMode string

PolicyMode enumerates the values for policy mode.

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

func PossiblePolicyModeValues

func PossiblePolicyModeValues() []PolicyMode

PossiblePolicyModeValues returns an array of possible values for the PolicyMode const type.

type PolicyResourceState

type PolicyResourceState string

PolicyResourceState enumerates the values for policy resource state.

const (
	// PolicyResourceStateCreating ...
	PolicyResourceStateCreating PolicyResourceState = "Creating"
	// PolicyResourceStateDeleting ...
	PolicyResourceStateDeleting PolicyResourceState = "Deleting"
	// PolicyResourceStateDisabled ...
	PolicyResourceStateDisabled PolicyResourceState = "Disabled"
	// PolicyResourceStateDisabling ...
	PolicyResourceStateDisabling PolicyResourceState = "Disabling"
	// PolicyResourceStateEnabled ...
	PolicyResourceStateEnabled PolicyResourceState = "Enabled"
	// PolicyResourceStateEnabling ...
	PolicyResourceStateEnabling PolicyResourceState = "Enabling"
)

func PossiblePolicyResourceStateValues

func PossiblePolicyResourceStateValues() []PolicyResourceState

PossiblePolicyResourceStateValues returns an array of possible values for the PolicyResourceState const type.

type PolicySettings

type PolicySettings struct {
	// EnabledState - Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. Possible values include: 'PolicyEnabledStateDisabled', 'PolicyEnabledStateEnabled'
	EnabledState PolicyEnabledState `json:"enabledState,omitempty"`
	// Mode - Describes if it is in detection mode or prevention mode at policy level. Possible values include: 'Prevention', 'Detection'
	Mode PolicyMode `json:"mode,omitempty"`
	// RedirectURL - If action type is redirect, this field represents redirect URL for the client.
	RedirectURL *string `json:"redirectUrl,omitempty"`
	// CustomBlockResponseStatusCode - If the action type is block, customer can override the response status code.
	CustomBlockResponseStatusCode *int32 `json:"customBlockResponseStatusCode,omitempty"`
	// CustomBlockResponseBody - If the action type is block, customer can override the response body. The body must be specified in base64 encoding.
	CustomBlockResponseBody *string `json:"customBlockResponseBody,omitempty"`
}

PolicySettings defines top-level WebApplicationFirewallPolicy configuration settings.

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"`
	// BackendPoolsSettings - Settings for all backendPools
	BackendPoolsSettings *BackendPoolsSettings `json:"backendPoolsSettings,omitempty"`
	// EnabledState - Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'EnabledStateEnabled', 'EnabledStateDisabled'
	EnabledState EnabledState `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 RedirectConfiguration

type RedirectConfiguration struct {
	// RedirectType - The redirect type the rule will use when redirecting traffic. Possible values include: 'Moved', 'Found', 'TemporaryRedirect', 'PermanentRedirect'
	RedirectType RedirectType `json:"redirectType,omitempty"`
	// RedirectProtocol - The protocol of the destination to where the traffic is redirected. Possible values include: 'RedirectProtocolHTTPOnly', 'RedirectProtocolHTTPSOnly', 'RedirectProtocolMatchRequest'
	RedirectProtocol RedirectProtocol `json:"redirectProtocol,omitempty"`
	// CustomHost - Host to redirect. Leave empty to use the incoming host as the destination host.
	CustomHost *string `json:"customHost,omitempty"`
	// CustomPath - The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
	CustomPath *string `json:"customPath,omitempty"`
	// CustomFragment - Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
	CustomFragment *string `json:"customFragment,omitempty"`
	// CustomQueryString - The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in <key>=<value> format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.
	CustomQueryString *string `json:"customQueryString,omitempty"`
	// OdataType - Possible values include: 'OdataTypeRouteConfiguration', 'OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorForwardingConfiguration', 'OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorRedirectConfiguration'
	OdataType OdataType `json:"@odata.type,omitempty"`
}

RedirectConfiguration describes Redirect Route.

func (RedirectConfiguration) AsBasicRouteConfiguration

func (rc RedirectConfiguration) AsBasicRouteConfiguration() (BasicRouteConfiguration, bool)

AsBasicRouteConfiguration is the BasicRouteConfiguration implementation for RedirectConfiguration.

func (RedirectConfiguration) AsForwardingConfiguration

func (rc RedirectConfiguration) AsForwardingConfiguration() (*ForwardingConfiguration, bool)

AsForwardingConfiguration is the BasicRouteConfiguration implementation for RedirectConfiguration.

func (RedirectConfiguration) AsRedirectConfiguration

func (rc RedirectConfiguration) AsRedirectConfiguration() (*RedirectConfiguration, bool)

AsRedirectConfiguration is the BasicRouteConfiguration implementation for RedirectConfiguration.

func (RedirectConfiguration) AsRouteConfiguration

func (rc RedirectConfiguration) AsRouteConfiguration() (*RouteConfiguration, bool)

AsRouteConfiguration is the BasicRouteConfiguration implementation for RedirectConfiguration.

func (RedirectConfiguration) MarshalJSON

func (rc RedirectConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RedirectConfiguration.

type RedirectProtocol

type RedirectProtocol string

RedirectProtocol enumerates the values for redirect protocol.

const (
	// RedirectProtocolHTTPOnly ...
	RedirectProtocolHTTPOnly RedirectProtocol = "HttpOnly"
	// RedirectProtocolHTTPSOnly ...
	RedirectProtocolHTTPSOnly RedirectProtocol = "HttpsOnly"
	// RedirectProtocolMatchRequest ...
	RedirectProtocolMatchRequest RedirectProtocol = "MatchRequest"
)

func PossibleRedirectProtocolValues

func PossibleRedirectProtocolValues() []RedirectProtocol

PossibleRedirectProtocolValues returns an array of possible values for the RedirectProtocol const type.

type RedirectType

type RedirectType string

RedirectType enumerates the values for redirect type.

const (
	// Found ...
	Found RedirectType = "Found"
	// Moved ...
	Moved RedirectType = "Moved"
	// PermanentRedirect ...
	PermanentRedirect RedirectType = "PermanentRedirect"
	// TemporaryRedirect ...
	TemporaryRedirect RedirectType = "TemporaryRedirect"
)

func PossibleRedirectTypeValues

func PossibleRedirectTypeValues() []RedirectType

PossibleRedirectTypeValues returns an array of possible values for the RedirectType 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 RouteConfiguration

type RouteConfiguration struct {
	// OdataType - Possible values include: 'OdataTypeRouteConfiguration', 'OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorForwardingConfiguration', 'OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorRedirectConfiguration'
	OdataType OdataType `json:"@odata.type,omitempty"`
}

RouteConfiguration base class for all types of Route.

func (RouteConfiguration) AsBasicRouteConfiguration

func (rc RouteConfiguration) AsBasicRouteConfiguration() (BasicRouteConfiguration, bool)

AsBasicRouteConfiguration is the BasicRouteConfiguration implementation for RouteConfiguration.

func (RouteConfiguration) AsForwardingConfiguration

func (rc RouteConfiguration) AsForwardingConfiguration() (*ForwardingConfiguration, bool)

AsForwardingConfiguration is the BasicRouteConfiguration implementation for RouteConfiguration.

func (RouteConfiguration) AsRedirectConfiguration

func (rc RouteConfiguration) AsRedirectConfiguration() (*RedirectConfiguration, bool)

AsRedirectConfiguration is the BasicRouteConfiguration implementation for RouteConfiguration.

func (RouteConfiguration) AsRouteConfiguration

func (rc RouteConfiguration) AsRouteConfiguration() (*RouteConfiguration, bool)

AsRouteConfiguration is the BasicRouteConfiguration implementation for RouteConfiguration.

func (RouteConfiguration) MarshalJSON

func (rc RouteConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RouteConfiguration.

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 RoutingRuleEnabledState

type RoutingRuleEnabledState string

RoutingRuleEnabledState enumerates the values for routing rule enabled state.

const (
	// RoutingRuleEnabledStateDisabled ...
	RoutingRuleEnabledStateDisabled RoutingRuleEnabledState = "Disabled"
	// RoutingRuleEnabledStateEnabled ...
	RoutingRuleEnabledStateEnabled RoutingRuleEnabledState = "Enabled"
)

func PossibleRoutingRuleEnabledStateValues

func PossibleRoutingRuleEnabledStateValues() []RoutingRuleEnabledState

PossibleRoutingRuleEnabledStateValues returns an array of possible values for the RoutingRuleEnabledState const type.

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"`
	// EnabledState - Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'RoutingRuleEnabledStateEnabled', 'RoutingRuleEnabledStateDisabled'
	EnabledState RoutingRuleEnabledState `json:"enabledState,omitempty"`
	// RouteConfiguration - A reference to the routing configuration.
	RouteConfiguration BasicRouteConfiguration `json:"routeConfiguration,omitempty"`
}

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

func (*RoutingRuleProperties) UnmarshalJSON

func (rrp *RoutingRuleProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RoutingRuleProperties struct.

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"`
	// EnabledState - Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'RoutingRuleEnabledStateEnabled', 'RoutingRuleEnabledStateDisabled'
	EnabledState RoutingRuleEnabledState `json:"enabledState,omitempty"`
	// RouteConfiguration - A reference to the routing configuration.
	RouteConfiguration BasicRouteConfiguration `json:"routeConfiguration,omitempty"`
}

RoutingRuleUpdateParameters routing rules to apply to an endpoint

func (*RoutingRuleUpdateParameters) UnmarshalJSON

func (rrup *RoutingRuleUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RoutingRuleUpdateParameters struct.

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 TransformType

type TransformType string

TransformType enumerates the values for transform type.

const (
	// Lowercase ...
	Lowercase TransformType = "Lowercase"
	// RemoveNulls ...
	RemoveNulls TransformType = "RemoveNulls"
	// Trim ...
	Trim TransformType = "Trim"
	// Uppercase ...
	Uppercase TransformType = "Uppercase"
	// URLDecode ...
	URLDecode TransformType = "UrlDecode"
	// URLEncode ...
	URLEncode TransformType = "UrlEncode"
)

func PossibleTransformTypeValues

func PossibleTransformTypeValues() []TransformType

PossibleTransformTypeValues returns an array of possible values for the TransformType 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"`
	// BackendPoolsSettings - Settings for all backendPools
	BackendPoolsSettings *BackendPoolsSettings `json:"backendPoolsSettings,omitempty"`
	// EnabledState - Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'EnabledStateEnabled', 'EnabledStateDisabled'
	EnabledState EnabledState `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 struct {
	autorest.Response `json:"-"`
	// WebApplicationFirewallPolicyProperties - Properties of the web application firewall policy.
	*WebApplicationFirewallPolicyProperties `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"`
}

WebApplicationFirewallPolicy defines web application firewall policy.

func (WebApplicationFirewallPolicy) MarshalJSON

func (wafp WebApplicationFirewallPolicy) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WebApplicationFirewallPolicy.

func (*WebApplicationFirewallPolicy) UnmarshalJSON

func (wafp *WebApplicationFirewallPolicy) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for WebApplicationFirewallPolicy struct.

type WebApplicationFirewallPolicyList

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

WebApplicationFirewallPolicyList defines a list of WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.

func (WebApplicationFirewallPolicyList) IsEmpty

func (wafpl WebApplicationFirewallPolicyList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type WebApplicationFirewallPolicyListIterator

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

WebApplicationFirewallPolicyListIterator provides access to a complete listing of WebApplicationFirewallPolicy values.

func NewWebApplicationFirewallPolicyListIterator

func NewWebApplicationFirewallPolicyListIterator(page WebApplicationFirewallPolicyListPage) WebApplicationFirewallPolicyListIterator

Creates a new instance of the WebApplicationFirewallPolicyListIterator type.

func (*WebApplicationFirewallPolicyListIterator) Next

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 (*WebApplicationFirewallPolicyListIterator) NextWithContext

func (iter *WebApplicationFirewallPolicyListIterator) 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 (WebApplicationFirewallPolicyListIterator) NotDone

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

func (WebApplicationFirewallPolicyListIterator) Response

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

func (WebApplicationFirewallPolicyListIterator) Value

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

type WebApplicationFirewallPolicyListPage

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

WebApplicationFirewallPolicyListPage contains a page of WebApplicationFirewallPolicy values.

func NewWebApplicationFirewallPolicyListPage

Creates a new instance of the WebApplicationFirewallPolicyListPage type.

func (*WebApplicationFirewallPolicyListPage) Next

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 (*WebApplicationFirewallPolicyListPage) NextWithContext

func (page *WebApplicationFirewallPolicyListPage) 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 (WebApplicationFirewallPolicyListPage) NotDone

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

func (WebApplicationFirewallPolicyListPage) Response

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

func (WebApplicationFirewallPolicyListPage) Values

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

type WebApplicationFirewallPolicyProperties

type WebApplicationFirewallPolicyProperties struct {
	// PolicySettings - Describes settings for the policy.
	PolicySettings *PolicySettings `json:"policySettings,omitempty"`
	// CustomRules - Describes custom rules inside the policy.
	CustomRules *CustomRuleList `json:"customRules,omitempty"`
	// ManagedRules - Describes managed rules inside the policy.
	ManagedRules *ManagedRuleSetList `json:"managedRules,omitempty"`
	// FrontendEndpointLinks - READ-ONLY; Describes Frontend Endpoints associated with this Web Application Firewall policy.
	FrontendEndpointLinks *[]FrontendEndpointLink `json:"frontendEndpointLinks,omitempty"`
	// ProvisioningState - READ-ONLY; Provisioning state of the policy.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// ResourceState - READ-ONLY; Possible values include: 'PolicyResourceStateCreating', 'PolicyResourceStateEnabling', 'PolicyResourceStateEnabled', 'PolicyResourceStateDisabling', 'PolicyResourceStateDisabled', 'PolicyResourceStateDeleting'
	ResourceState PolicyResourceState `json:"resourceState,omitempty"`
}

WebApplicationFirewallPolicyProperties defines web application firewall policy properties.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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