const (
// DefaultBaseURI is the default URI used for the service Frontdoor
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
ActionType enumerates the values for action type.
type ActionType string
const (
// Allow ...
Allow ActionType = "Allow"
// Block ...
Block ActionType = "Block"
// Log ...
Log ActionType = "Log"
// Redirect ...
Redirect ActionType = "Redirect"
)
func PossibleActionTypeValues() []ActionType
PossibleActionTypeValues returns an array of possible values for the ActionType const type.
AggregationInterval enumerates the values for aggregation interval.
type AggregationInterval string
const (
// Daily ...
Daily AggregationInterval = "Daily"
// Hourly ...
Hourly AggregationInterval = "Hourly"
)
func PossibleAggregationIntervalValues() []AggregationInterval
PossibleAggregationIntervalValues returns an array of possible values for the AggregationInterval const type.
Availability enumerates the values for availability.
type Availability string
const (
// Available ...
Available Availability = "Available"
// Unavailable ...
Availability = "Unavailable"
)
func PossibleAvailabilityValues() []Availability
PossibleAvailabilityValues returns an array of possible values for the Availability const type.
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 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"`
}
Backend backend address of a frontDoor load balancer.
type Backend struct {
// Address - Location of the backend (IP address or FQDN)
Address *string `json:"address,omitempty"`
// PrivateLinkAlias - The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
PrivateLinkAlias *string `json:"privateLinkAlias,omitempty"`
// PrivateEndpointStatus - READ-ONLY; The Approval status for the connection to the Private Link. Possible values include: 'Pending', 'Approved', 'Rejected', 'Disconnected', 'Timeout'
PrivateEndpointStatus PrivateEndpointStatus `json:"privateEndpointStatus,omitempty"`
// PrivateLinkApprovalMessage - A custom message to be included in the approval request to connect to the Private Link
PrivateLinkApprovalMessage *string `json:"privateLinkApprovalMessage,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"`
}
func (b Backend) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Backend.
BackendEnabledState enumerates the values for backend enabled state.
type BackendEnabledState string
const (
// Disabled ...
Disabled BackendEnabledState = "Disabled"
// Enabled ...
Enabled BackendEnabledState = "Enabled"
)
func PossibleBackendEnabledStateValues() []BackendEnabledState
PossibleBackendEnabledStateValues returns an array of possible values for the BackendEnabledState const type.
BackendPool a backend pool is a collection of backends that can be routed to.
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"`
}
func (bp BackendPool) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BackendPool.
func (bp *BackendPool) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for BackendPool struct.
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 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"`
}
func (bplr BackendPoolListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BackendPoolListResult.
BackendPoolProperties the JSON object that contains the properties required to create a Backend Pool.
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"`
}
BackendPoolUpdateParameters a collection of backends that can be routed to.
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"`
}
BackendPoolsSettings settings that apply to all backend pools.
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"`
// SendRecvTimeoutSeconds - Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns.
SendRecvTimeoutSeconds *int32 `json:"sendRecvTimeoutSeconds,omitempty"`
}
BaseClient is the base client for Frontdoor.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
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 (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 (client BaseClient) CheckFrontDoorNameAvailabilityPreparer(ctx context.Context, checkFrontDoorNameAvailabilityInput CheckNameAvailabilityInput) (*http.Request, error)
CheckFrontDoorNameAvailabilityPreparer prepares the CheckFrontDoorNameAvailability request.
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 (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 (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 (client BaseClient) CheckFrontDoorNameAvailabilityWithSubscriptionPreparer(ctx context.Context, checkFrontDoorNameAvailabilityInput CheckNameAvailabilityInput) (*http.Request, error)
CheckFrontDoorNameAvailabilityWithSubscriptionPreparer prepares the CheckFrontDoorNameAvailabilityWithSubscription request.
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 (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.
BasicRouteConfiguration base class for all types of Route.
type BasicRouteConfiguration interface {
AsForwardingConfiguration() (*ForwardingConfiguration, bool)
AsRedirectConfiguration() (*RedirectConfiguration, bool)
AsRouteConfiguration() (*RouteConfiguration, bool)
}
CacheConfiguration caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.
type CacheConfiguration struct {
// QueryParameterStripDirective - Treatment of URL query terms when forming the cache key. Possible values include: 'StripNone', 'StripAll', 'StripOnly', 'StripAllExcept'
QueryParameterStripDirective Query `json:"queryParameterStripDirective,omitempty"`
// QueryParameters - query parameters to include or exclude (comma separated).
QueryParameters *string `json:"queryParameters,omitempty"`
// DynamicCompression - Whether to use dynamic compression for cached content. Possible values include: 'DynamicCompressionEnabledEnabled', 'DynamicCompressionEnabledDisabled'
DynamicCompression DynamicCompressionEnabled `json:"dynamicCompression,omitempty"`
// CacheDuration - The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year
CacheDuration *string `json:"cacheDuration,omitempty"`
}
CertificateSource enumerates the values for certificate source.
type CertificateSource string
const (
// CertificateSourceAzureKeyVault ...
CertificateSourceAzureKeyVault CertificateSource = "AzureKeyVault"
// CertificateSourceFrontDoor ...
CertificateSourceFrontDoor CertificateSource = "FrontDoor"
)
func PossibleCertificateSourceValues() []CertificateSource
PossibleCertificateSourceValues returns an array of possible values for the CertificateSource const type.
CertificateSourceParameters parameters required for enabling SSL with Front Door-managed certificates
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"`
}
CertificateType enumerates the values for certificate type.
type CertificateType string
const (
// Dedicated ...
Dedicated CertificateType = "Dedicated"
)
func PossibleCertificateTypeValues() []CertificateType
PossibleCertificateTypeValues returns an array of possible values for the CertificateType const type.
CheckNameAvailabilityInput input of CheckNameAvailability API.
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"`
}
CheckNameAvailabilityOutput output of check name availability API.
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"`
}
func (cnao CheckNameAvailabilityOutput) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CheckNameAvailabilityOutput.
CustomHTTPSConfiguration https settings for a domain
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
ProtocolType *string `json:"protocolType,omitempty"`
// MinimumTLSVersion - The minimum TLS version required from the clients to establish an SSL handshake with Front Door. Possible values include: 'OneFullStopZero', 'OneFullStopTwo'
MinimumTLSVersion MinimumTLSVersion `json:"minimumTlsVersion,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"`
}
func (chc CustomHTTPSConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CustomHTTPSConfiguration.
func (chc *CustomHTTPSConfiguration) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CustomHTTPSConfiguration struct.
CustomHTTPSProvisioningState enumerates the values for custom https provisioning state.
type CustomHTTPSProvisioningState string
const (
// CustomHTTPSProvisioningStateDisabled ...
CustomHTTPSProvisioningStateDisabled CustomHTTPSProvisioningState = "Disabled"
// CustomHTTPSProvisioningStateDisabling ...
CustomHTTPSProvisioningStateDisabling CustomHTTPSProvisioningState = "Disabling"
// CustomHTTPSProvisioningStateEnabled ...
CustomHTTPSProvisioningStateEnabled CustomHTTPSProvisioningState = "Enabled"
// CustomHTTPSProvisioningStateEnabling ...
CustomHTTPSProvisioningStateEnabling CustomHTTPSProvisioningState = "Enabling"
// CustomHTTPSProvisioningStateFailed ...
CustomHTTPSProvisioningStateFailed CustomHTTPSProvisioningState = "Failed"
)
func PossibleCustomHTTPSProvisioningStateValues() []CustomHTTPSProvisioningState
PossibleCustomHTTPSProvisioningStateValues returns an array of possible values for the CustomHTTPSProvisioningState const type.
CustomHTTPSProvisioningSubstate enumerates the values for custom https provisioning substate.
type CustomHTTPSProvisioningSubstate string
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() []CustomHTTPSProvisioningSubstate
PossibleCustomHTTPSProvisioningSubstateValues returns an array of possible values for the CustomHTTPSProvisioningSubstate const type.
CustomRule defines contents of a web application rule
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"`
}
CustomRuleEnabledState enumerates the values for custom rule enabled state.
type CustomRuleEnabledState string
const (
// CustomRuleEnabledStateDisabled ...
CustomRuleEnabledStateDisabled CustomRuleEnabledState = "Disabled"
// CustomRuleEnabledStateEnabled ...
CustomRuleEnabledStateEnabled CustomRuleEnabledState = "Enabled"
)
func PossibleCustomRuleEnabledStateValues() []CustomRuleEnabledState
PossibleCustomRuleEnabledStateValues returns an array of possible values for the CustomRuleEnabledState const type.
CustomRuleList defines contents of custom rules
type CustomRuleList struct {
// Rules - List of rules
Rules *[]CustomRule `json:"rules,omitempty"`
}
DynamicCompressionEnabled enumerates the values for dynamic compression enabled.
type DynamicCompressionEnabled string
const (
// DynamicCompressionEnabledDisabled ...
DynamicCompressionEnabledDisabled DynamicCompressionEnabled = "Disabled"
// DynamicCompressionEnabledEnabled ...
DynamicCompressionEnabledEnabled DynamicCompressionEnabled = "Enabled"
)
func PossibleDynamicCompressionEnabledValues() []DynamicCompressionEnabled
PossibleDynamicCompressionEnabledValues returns an array of possible values for the DynamicCompressionEnabled const type.
EnabledState enumerates the values for enabled state.
type EnabledState string
const (
// EnabledStateDisabled ...
EnabledStateDisabled EnabledState = "Disabled"
// EnabledStateEnabled ...
EnabledStateEnabled EnabledState = "Enabled"
)
func PossibleEnabledStateValues() []EnabledState
PossibleEnabledStateValues returns an array of possible values for the EnabledState const type.
Endpoint defines the endpoint properties
type Endpoint struct {
// Name - The name of the endpoint
Name *string `json:"name,omitempty"`
// Endpoint - The endpoint URL
Endpoint *string `json:"endpoint,omitempty"`
}
EndpointType enumerates the values for endpoint type.
type EndpointType string
const (
// AFD ...
AFD EndpointType = "AFD"
// ATM ...
ATM EndpointType = "ATM"
// AzureRegion ...
AzureRegion EndpointType = "AzureRegion"
// CDN ...
CDN EndpointType = "CDN"
)
func PossibleEndpointTypeValues() []EndpointType
PossibleEndpointTypeValues returns an array of possible values for the EndpointType const type.
EndpointsClient is the frontDoor Client
type EndpointsClient struct {
BaseClient
}
func NewEndpointsClient(subscriptionID string) EndpointsClient
NewEndpointsClient creates an instance of the EndpointsClient client.
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 (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 (client EndpointsClient) PurgeContentPreparer(ctx context.Context, resourceGroupName string, frontDoorName string, contentFilePaths PurgeParameters) (*http.Request, error)
PurgeContentPreparer prepares the PurgeContent request.
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 (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.
EndpointsPurgeContentFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EndpointsPurgeContentFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EndpointsClient) (autorest.Response, error)
}
func (future *EndpointsPurgeContentFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
EnforceCertificateNameCheckEnabledState enumerates the values for enforce certificate name check enabled state.
type EnforceCertificateNameCheckEnabledState string
const (
// EnforceCertificateNameCheckEnabledStateDisabled ...
EnforceCertificateNameCheckEnabledStateDisabled EnforceCertificateNameCheckEnabledState = "Disabled"
// EnforceCertificateNameCheckEnabledStateEnabled ...
EnforceCertificateNameCheckEnabledStateEnabled EnforceCertificateNameCheckEnabledState = "Enabled"
)
func PossibleEnforceCertificateNameCheckEnabledStateValues() []EnforceCertificateNameCheckEnabledState
PossibleEnforceCertificateNameCheckEnabledStateValues returns an array of possible values for the EnforceCertificateNameCheckEnabledState const 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"`
}
ErrorDetails ...
type ErrorDetails struct {
Code *string `json:"code,omitempty"`
Target *string `json:"target,omitempty"`
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 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"`
}
func (er ErrorResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorResponse.
Experiment defines the properties of an Experiment
type Experiment struct {
autorest.Response `json:"-"`
// ExperimentProperties - The properties of an Experiment
*ExperimentProperties `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"`
}
func (e Experiment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Experiment.
func (e *Experiment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Experiment struct.
ExperimentList defines a list of Experiments. It contains a list of Experiment objects and a URL link to get the next set of results.
type ExperimentList struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of Experiments within a resource group.
Value *[]Experiment `json:"value,omitempty"`
// NextLink - URL to get the next set of Experiment objects if there are any.
NextLink *string `json:"nextLink,omitempty"`
}
func (el ExperimentList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (el ExperimentList) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ExperimentList.
ExperimentListIterator provides access to a complete listing of Experiment values.
type ExperimentListIterator struct {
// contains filtered or unexported fields
}
func NewExperimentListIterator(page ExperimentListPage) ExperimentListIterator
Creates a new instance of the ExperimentListIterator type.
func (iter *ExperimentListIterator) 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 (iter *ExperimentListIterator) 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 (iter ExperimentListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ExperimentListIterator) Response() ExperimentList
Response returns the raw server response from the last page request.
func (iter ExperimentListIterator) Value() Experiment
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ExperimentListPage contains a page of Experiment values.
type ExperimentListPage struct {
// contains filtered or unexported fields
}
func NewExperimentListPage(cur ExperimentList, getNextPage func(context.Context, ExperimentList) (ExperimentList, error)) ExperimentListPage
Creates a new instance of the ExperimentListPage type.
func (page *ExperimentListPage) 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 (page *ExperimentListPage) 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 (page ExperimentListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ExperimentListPage) Response() ExperimentList
Response returns the raw server response from the last page request.
func (page ExperimentListPage) Values() []Experiment
Values returns the slice of values for the current page or nil if there are no values.
ExperimentProperties defines the properties of an experiment
type ExperimentProperties struct {
// Description - The description of the details or intents of the Experiment
Description *string `json:"description,omitempty"`
// EndpointA - The endpoint A of an experiment
EndpointA *Endpoint `json:"endpointA,omitempty"`
// EndpointB - The endpoint B of an experiment
EndpointB *Endpoint `json:"endpointB,omitempty"`
// EnabledState - The state of the Experiment. Possible values include: 'StateEnabled', 'StateDisabled'
EnabledState State `json:"enabledState,omitempty"`
// ResourceState - Resource status. Possible values include: 'NetworkExperimentResourceStateCreating', 'NetworkExperimentResourceStateEnabling', 'NetworkExperimentResourceStateEnabled', 'NetworkExperimentResourceStateDisabling', 'NetworkExperimentResourceStateDisabled', 'NetworkExperimentResourceStateDeleting'
ResourceState NetworkExperimentResourceState `json:"resourceState,omitempty"`
// Status - READ-ONLY; The description of Experiment status from the server side
Status *string `json:"status,omitempty"`
// ScriptFileURI - READ-ONLY; The uri to the Script used in the Experiment
ScriptFileURI *string `json:"scriptFileUri,omitempty"`
}
func (ep ExperimentProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ExperimentProperties.
ExperimentUpdateModel defines modifiable attributes of an Experiment
type ExperimentUpdateModel struct {
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
// ExperimentUpdateProperties - The properties of a Profile
*ExperimentUpdateProperties `json:"properties,omitempty"`
}
func (eum ExperimentUpdateModel) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ExperimentUpdateModel.
func (eum *ExperimentUpdateModel) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ExperimentUpdateModel struct.
ExperimentUpdateProperties defines the properties of an experiment
type ExperimentUpdateProperties struct {
// Description - The description of the intent or details of the Experiment
Description *string `json:"description,omitempty"`
// EnabledState - The state of the Experiment. Possible values include: 'StateEnabled', 'StateDisabled'
EnabledState State `json:"enabledState,omitempty"`
}
ExperimentsClient is the frontDoor Client
type ExperimentsClient struct {
BaseClient
}
func NewExperimentsClient(subscriptionID string) ExperimentsClient
NewExperimentsClient creates an instance of the ExperimentsClient client.
func NewExperimentsClientWithBaseURI(baseURI string, subscriptionID string) ExperimentsClient
NewExperimentsClientWithBaseURI creates an instance of the ExperimentsClient 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 (client ExperimentsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, profileName string, experimentName string, parameters Experiment) (result ExperimentsCreateOrUpdateFuture, err error)
CreateOrUpdate sends the create or update request. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. profileName - the Profile identifier associated with the Tenant and Partner experimentName - the Experiment identifier associated with the Experiment parameters - the Experiment resource
func (client ExperimentsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, profileName string, experimentName string, parameters Experiment) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ExperimentsClient) CreateOrUpdateResponder(resp *http.Response) (result Experiment, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ExperimentsClient) CreateOrUpdateSender(req *http.Request) (future ExperimentsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ExperimentsClient) Delete(ctx context.Context, resourceGroupName string, profileName string, experimentName string) (result ExperimentsDeleteFuture, err error)
Delete sends the delete request. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. profileName - the Profile identifier associated with the Tenant and Partner experimentName - the Experiment identifier associated with the Experiment
func (client ExperimentsClient) DeletePreparer(ctx context.Context, resourceGroupName string, profileName string, experimentName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ExperimentsClient) 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 (client ExperimentsClient) DeleteSender(req *http.Request) (future ExperimentsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ExperimentsClient) Get(ctx context.Context, resourceGroupName string, profileName string, experimentName string) (result Experiment, err error)
Get sends the get request. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. profileName - the Profile identifier associated with the Tenant and Partner experimentName - the Experiment identifier associated with the Experiment
func (client ExperimentsClient) GetPreparer(ctx context.Context, resourceGroupName string, profileName string, experimentName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ExperimentsClient) GetResponder(resp *http.Response) (result Experiment, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ExperimentsClient) 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 (client ExperimentsClient) ListByProfile(ctx context.Context, resourceGroupName string, profileName string) (result ExperimentListPage, err error)
ListByProfile sends the list by profile request. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. profileName - the Profile identifier associated with the Tenant and Partner
func (client ExperimentsClient) ListByProfileComplete(ctx context.Context, resourceGroupName string, profileName string) (result ExperimentListIterator, err error)
ListByProfileComplete enumerates all values, automatically crossing page boundaries as required.
func (client ExperimentsClient) ListByProfilePreparer(ctx context.Context, resourceGroupName string, profileName string) (*http.Request, error)
ListByProfilePreparer prepares the ListByProfile request.
func (client ExperimentsClient) ListByProfileResponder(resp *http.Response) (result ExperimentList, err error)
ListByProfileResponder handles the response to the ListByProfile request. The method always closes the http.Response Body.
func (client ExperimentsClient) ListByProfileSender(req *http.Request) (*http.Response, error)
ListByProfileSender sends the ListByProfile request. The method will close the http.Response Body if it receives an error.
func (client ExperimentsClient) Update(ctx context.Context, resourceGroupName string, profileName string, experimentName string, parameters ExperimentUpdateModel) (result ExperimentsUpdateFuture, err error)
Update updates an Experiment Parameters: resourceGroupName - name of the Resource group within the Azure subscription. profileName - the Profile identifier associated with the Tenant and Partner experimentName - the Experiment identifier associated with the Experiment parameters - the Experiment Update Model
func (client ExperimentsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, profileName string, experimentName string, parameters ExperimentUpdateModel) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ExperimentsClient) UpdateResponder(resp *http.Response) (result Experiment, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ExperimentsClient) UpdateSender(req *http.Request) (future ExperimentsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
ExperimentsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExperimentsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExperimentsClient) (Experiment, error)
}
func (future *ExperimentsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ExperimentsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExperimentsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExperimentsClient) (autorest.Response, error)
}
func (future *ExperimentsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ExperimentsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExperimentsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ExperimentsClient) (Experiment, error)
}
func (future *ExperimentsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ForwardingConfiguration describes Forwarding Route.
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"`
}
func (fc ForwardingConfiguration) AsBasicRouteConfiguration() (BasicRouteConfiguration, bool)
AsBasicRouteConfiguration is the BasicRouteConfiguration implementation for ForwardingConfiguration.
func (fc ForwardingConfiguration) AsForwardingConfiguration() (*ForwardingConfiguration, bool)
AsForwardingConfiguration is the BasicRouteConfiguration implementation for ForwardingConfiguration.
func (fc ForwardingConfiguration) AsRedirectConfiguration() (*RedirectConfiguration, bool)
AsRedirectConfiguration is the BasicRouteConfiguration implementation for ForwardingConfiguration.
func (fc ForwardingConfiguration) AsRouteConfiguration() (*RouteConfiguration, bool)
AsRouteConfiguration is the BasicRouteConfiguration implementation for ForwardingConfiguration.
func (fc ForwardingConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ForwardingConfiguration.
ForwardingProtocol enumerates the values for forwarding protocol.
type ForwardingProtocol string
const (
// HTTPOnly ...
HTTPOnly ForwardingProtocol = "HttpOnly"
// HTTPSOnly ...
HTTPSOnly ForwardingProtocol = "HttpsOnly"
// MatchRequest ...
MatchRequest ForwardingProtocol = "MatchRequest"
)
func PossibleForwardingProtocolValues() []ForwardingProtocol
PossibleForwardingProtocolValues returns an array of possible values for the ForwardingProtocol const type.
FrontDoor front Door represents a collection of backend endpoints to route traffic to along with rules that specify how traffic is sent there.
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"`
}
func (fd FrontDoor) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FrontDoor.
func (fd *FrontDoor) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FrontDoor struct.
FrontDoorsClient is the frontDoor Client
type FrontDoorsClient struct {
BaseClient
}
func NewFrontDoorsClient(subscriptionID string) FrontDoorsClient
NewFrontDoorsClient creates an instance of the FrontDoorsClient client.
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 (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 (client FrontDoorsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, frontDoorName string, frontDoorParameters FrontDoor) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client FrontDoorsClient) DeletePreparer(ctx context.Context, resourceGroupName string, frontDoorName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client FrontDoorsClient) GetPreparer(ctx context.Context, resourceGroupName string, frontDoorName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (client FrontDoorsClient) List(ctx context.Context) (result ListResultPage, err error)
List lists all of the Front Doors within an Azure subscription.
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 (client FrontDoorsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client FrontDoorsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 (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 (client FrontDoorsClient) ListComplete(ctx context.Context) (result ListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client FrontDoorsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (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 (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 (client FrontDoorsClient) ValidateCustomDomainPreparer(ctx context.Context, resourceGroupName string, frontDoorName string, customDomainProperties ValidateCustomDomainInput) (*http.Request, error)
ValidateCustomDomainPreparer prepares the ValidateCustomDomain request.
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 (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.
FrontDoorsCreateOrUpdateFutureType an abstraction for monitoring and retrieving the results of a long-running operation.
type FrontDoorsCreateOrUpdateFutureType struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(FrontDoorsClient) (FrontDoor, error)
}
func (future *FrontDoorsCreateOrUpdateFutureType) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
FrontDoorsDeleteFutureType an abstraction for monitoring and retrieving the results of a long-running operation.
type FrontDoorsDeleteFutureType struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(FrontDoorsClient) (autorest.Response, error)
}
func (future *FrontDoorsDeleteFutureType) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
FrontendEndpoint a frontend endpoint used for routing.
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"`
}
func (fe FrontendEndpoint) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FrontendEndpoint.
func (fe *FrontendEndpoint) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FrontendEndpoint struct.
FrontendEndpointLink defines the Resource ID for a Frontend Endpoint.
type FrontendEndpointLink struct {
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}
FrontendEndpointProperties the JSON object that contains the properties required to create a frontend endpoint.
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"`
}
func (fep FrontendEndpointProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FrontendEndpointProperties.
FrontendEndpointUpdateParameters frontend endpoint used in routing rule
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"`
}
FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink defines the Web Application Firewall policy for each host (if applicable)
type FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink struct {
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}
FrontendEndpointsClient is the frontDoor Client
type FrontendEndpointsClient struct {
BaseClient
}
func NewFrontendEndpointsClient(subscriptionID string) FrontendEndpointsClient
NewFrontendEndpointsClient creates an instance of the FrontendEndpointsClient client.
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 (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 (client FrontendEndpointsClient) DisableHTTPSPreparer(ctx context.Context, resourceGroupName string, frontDoorName string, frontendEndpointName string) (*http.Request, error)
DisableHTTPSPreparer prepares the DisableHTTPS request.
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 (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 (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 (client FrontendEndpointsClient) EnableHTTPSPreparer(ctx context.Context, resourceGroupName string, frontDoorName string, frontendEndpointName string, customHTTPSConfiguration CustomHTTPSConfiguration) (*http.Request, error)
EnableHTTPSPreparer prepares the EnableHTTPS request.
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 (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 (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 (client FrontendEndpointsClient) GetPreparer(ctx context.Context, resourceGroupName string, frontDoorName string, frontendEndpointName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (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 (client FrontendEndpointsClient) ListByFrontDoorPreparer(ctx context.Context, resourceGroupName string, frontDoorName string) (*http.Request, error)
ListByFrontDoorPreparer prepares the ListByFrontDoor request.
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 (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.
FrontendEndpointsDisableHTTPSFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type FrontendEndpointsDisableHTTPSFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(FrontendEndpointsClient) (autorest.Response, error)
}
func (future *FrontendEndpointsDisableHTTPSFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
FrontendEndpointsEnableHTTPSFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type FrontendEndpointsEnableHTTPSFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(FrontendEndpointsClient) (autorest.Response, error)
}
func (future *FrontendEndpointsEnableHTTPSFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
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.
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"`
}
func (felr FrontendEndpointsListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (felr FrontendEndpointsListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FrontendEndpointsListResult.
FrontendEndpointsListResultIterator provides access to a complete listing of FrontendEndpoint values.
type FrontendEndpointsListResultIterator struct {
// contains filtered or unexported fields
}
func NewFrontendEndpointsListResultIterator(page FrontendEndpointsListResultPage) FrontendEndpointsListResultIterator
Creates a new instance of the FrontendEndpointsListResultIterator type.
func (iter *FrontendEndpointsListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (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 (iter FrontendEndpointsListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter FrontendEndpointsListResultIterator) Response() FrontendEndpointsListResult
Response returns the raw server response from the last page request.
func (iter FrontendEndpointsListResultIterator) Value() FrontendEndpoint
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
FrontendEndpointsListResultPage contains a page of FrontendEndpoint values.
type FrontendEndpointsListResultPage struct {
// contains filtered or unexported fields
}
func NewFrontendEndpointsListResultPage(cur FrontendEndpointsListResult, getNextPage func(context.Context, FrontendEndpointsListResult) (FrontendEndpointsListResult, error)) FrontendEndpointsListResultPage
Creates a new instance of the FrontendEndpointsListResultPage type.
func (page *FrontendEndpointsListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (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 (page FrontendEndpointsListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page FrontendEndpointsListResultPage) Response() FrontendEndpointsListResult
Response returns the raw server response from the last page request.
func (page FrontendEndpointsListResultPage) Values() []FrontendEndpoint
Values returns the slice of values for the current page or nil if there are no values.
HeaderAction an action that can manipulate an http header.
type HeaderAction struct {
// HeaderActionType - Which type of manipulation to apply to the header. Possible values include: 'Append', 'Delete', 'Overwrite'
HeaderActionType HeaderActionType `json:"headerActionType,omitempty"`
// HeaderName - The name of the header this action will apply to.
HeaderName *string `json:"headerName,omitempty"`
// Value - The value to update the given header name with. This value is not used if the actionType is Delete.
Value *string `json:"value,omitempty"`
}
HeaderActionType enumerates the values for header action type.
type HeaderActionType string
const (
// Append ...
Append HeaderActionType = "Append"
// Delete ...
Delete HeaderActionType = "Delete"
// Overwrite ...
Overwrite HeaderActionType = "Overwrite"
)
func PossibleHeaderActionTypeValues() []HeaderActionType
PossibleHeaderActionTypeValues returns an array of possible values for the HeaderActionType const type.
HealthProbeEnabled enumerates the values for health probe enabled.
type HealthProbeEnabled string
const (
// HealthProbeEnabledDisabled ...
HealthProbeEnabledDisabled HealthProbeEnabled = "Disabled"
// HealthProbeEnabledEnabled ...
HealthProbeEnabledEnabled HealthProbeEnabled = "Enabled"
)
func PossibleHealthProbeEnabledValues() []HealthProbeEnabled
PossibleHealthProbeEnabledValues returns an array of possible values for the HealthProbeEnabled const type.
HealthProbeMethod enumerates the values for health probe method.
type HealthProbeMethod string
const (
// GET ...
GET HealthProbeMethod = "GET"
// HEAD ...
HEAD HealthProbeMethod = "HEAD"
)
func PossibleHealthProbeMethodValues() []HealthProbeMethod
PossibleHealthProbeMethodValues returns an array of possible values for the HealthProbeMethod const type.
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 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"`
}
func (hpslr HealthProbeSettingsListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for HealthProbeSettingsListResult.
HealthProbeSettingsModel load balancing settings for a backend pool
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"`
}
func (hpsm HealthProbeSettingsModel) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for HealthProbeSettingsModel.
func (hpsm *HealthProbeSettingsModel) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for HealthProbeSettingsModel struct.
HealthProbeSettingsProperties the JSON object that contains the properties required to create a health probe settings.
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"`
// HealthProbeMethod - Configures which HTTP method to use to probe the backends defined under backendPools. Possible values include: 'GET', 'HEAD'
HealthProbeMethod HealthProbeMethod `json:"healthProbeMethod,omitempty"`
// EnabledState - Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. Possible values include: 'HealthProbeEnabledEnabled', 'HealthProbeEnabledDisabled'
EnabledState HealthProbeEnabled `json:"enabledState,omitempty"`
}
HealthProbeSettingsUpdateParameters l7 health probe settings for a backend pool
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"`
// HealthProbeMethod - Configures which HTTP method to use to probe the backends defined under backendPools. Possible values include: 'GET', 'HEAD'
HealthProbeMethod HealthProbeMethod `json:"healthProbeMethod,omitempty"`
// EnabledState - Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. Possible values include: 'HealthProbeEnabledEnabled', 'HealthProbeEnabledDisabled'
EnabledState HealthProbeEnabled `json:"enabledState,omitempty"`
}
KeyVaultCertificateSourceParameters parameters required for bring-your-own-certification via Key Vault
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"`
}
KeyVaultCertificateSourceParametersVault the Key Vault containing the SSL certificate
type KeyVaultCertificateSourceParametersVault struct {
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}
LatencyMetric defines the properties of a latency metric used in the latency scorecard
type LatencyMetric struct {
// Name - READ-ONLY; The name of the Latency Metric
Name *string `json:"name,omitempty"`
// EndDateTimeUTC - READ-ONLY; The end time of the Latency Scorecard in UTC
EndDateTimeUTC *string `json:"endDateTimeUTC,omitempty"`
// AValue - READ-ONLY; The metric value of the A endpoint
AValue *float64 `json:"aValue,omitempty"`
// BValue - READ-ONLY; The metric value of the B endpoint
BValue *float64 `json:"bValue,omitempty"`
// Delta - READ-ONLY; The difference in value between endpoint A and B
Delta *float64 `json:"delta,omitempty"`
// DeltaPercent - READ-ONLY; The percent difference between endpoint A and B
DeltaPercent *float64 `json:"deltaPercent,omitempty"`
// ACLower95CI - READ-ONLY; The lower end of the 95% confidence interval for endpoint A
ACLower95CI *float64 `json:"aCLower95CI,omitempty"`
// AHUpper95CI - READ-ONLY; The upper end of the 95% confidence interval for endpoint A
AHUpper95CI *float64 `json:"aHUpper95CI,omitempty"`
// BCLower95CI - READ-ONLY; The lower end of the 95% confidence interval for endpoint B
BCLower95CI *float64 `json:"bCLower95CI,omitempty"`
// BUpper95CI - READ-ONLY; The upper end of the 95% confidence interval for endpoint B
BUpper95CI *float64 `json:"bUpper95CI,omitempty"`
}
func (lm LatencyMetric) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LatencyMetric.
LatencyScorecard defines the LatencyScorecard
type LatencyScorecard struct {
autorest.Response `json:"-"`
// LatencyScorecardProperties - The properties of a latency scorecard
*LatencyScorecardProperties `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"`
}
func (ls LatencyScorecard) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LatencyScorecard.
func (ls *LatencyScorecard) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LatencyScorecard struct.
LatencyScorecardAggregationInterval enumerates the values for latency scorecard aggregation interval.
type LatencyScorecardAggregationInterval string
const (
// LatencyScorecardAggregationIntervalDaily ...
LatencyScorecardAggregationIntervalDaily LatencyScorecardAggregationInterval = "Daily"
// LatencyScorecardAggregationIntervalMonthly ...
LatencyScorecardAggregationIntervalMonthly LatencyScorecardAggregationInterval = "Monthly"
// LatencyScorecardAggregationIntervalWeekly ...
LatencyScorecardAggregationIntervalWeekly LatencyScorecardAggregationInterval = "Weekly"
)
func PossibleLatencyScorecardAggregationIntervalValues() []LatencyScorecardAggregationInterval
PossibleLatencyScorecardAggregationIntervalValues returns an array of possible values for the LatencyScorecardAggregationInterval const type.
LatencyScorecardProperties defines a the properties of a Latency Scorecard
type LatencyScorecardProperties struct {
// ID - READ-ONLY; The unique identifier of the Latency Scorecard
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the Latency Scorecard
Name *string `json:"name,omitempty"`
// Description - READ-ONLY; The description of the Latency Scorecard
Description *string `json:"description,omitempty"`
// EndpointA - READ-ONLY; The A endpoint in the scorecard
EndpointA *string `json:"endpointA,omitempty"`
// EndpointB - READ-ONLY; The B endpoint in the scorecard
EndpointB *string `json:"endpointB,omitempty"`
// StartDateTimeUTC - READ-ONLY; The start time of the Latency Scorecard in UTC
StartDateTimeUTC *date.Time `json:"startDateTimeUTC,omitempty"`
// EndDateTimeUTC - READ-ONLY; The end time of the Latency Scorecard in UTC
EndDateTimeUTC *date.Time `json:"endDateTimeUTC,omitempty"`
// Country - READ-ONLY; The country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html
Country *string `json:"country,omitempty"`
// LatencyMetrics - The latency metrics of the Latency Scorecard
LatencyMetrics *[]LatencyMetric `json:"latencyMetrics,omitempty"`
}
func (lsp LatencyScorecardProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LatencyScorecardProperties.
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.
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"`
}
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (lr ListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ListResult.
ListResultIterator provides access to a complete listing of FrontDoor values.
type ListResultIterator struct {
// contains filtered or unexported fields
}
func NewListResultIterator(page ListResultPage) ListResultIterator
Creates a new instance of the ListResultIterator type.
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 (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 (iter ListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListResultIterator) Response() ListResult
Response returns the raw server response from the last page request.
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.
ListResultPage contains a page of FrontDoor values.
type ListResultPage struct {
// contains filtered or unexported fields
}
func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage
Creates a new instance of the ListResultPage type.
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 (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 (page ListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListResultPage) Response() ListResult
Response returns the raw server response from the last page request.
func (page ListResultPage) Values() []FrontDoor
Values returns the slice of values for the current page or nil if there are no values.
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 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"`
}
func (lbslr LoadBalancingSettingsListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LoadBalancingSettingsListResult.
LoadBalancingSettingsModel load balancing settings for a backend pool
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"`
}
func (lbsm LoadBalancingSettingsModel) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LoadBalancingSettingsModel.
func (lbsm *LoadBalancingSettingsModel) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LoadBalancingSettingsModel struct.
LoadBalancingSettingsProperties the JSON object that contains the properties required to create load balancing settings
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"`
}
LoadBalancingSettingsUpdateParameters round-Robin load balancing settings for a backend pool
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"`
}
ManagedRuleDefinition describes a managed rule definition.
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"`
}
func (mrd ManagedRuleDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagedRuleDefinition.
ManagedRuleEnabledState enumerates the values for managed rule enabled state.
type ManagedRuleEnabledState string
const (
// ManagedRuleEnabledStateDisabled ...
ManagedRuleEnabledStateDisabled ManagedRuleEnabledState = "Disabled"
// ManagedRuleEnabledStateEnabled ...
ManagedRuleEnabledStateEnabled ManagedRuleEnabledState = "Enabled"
)
func PossibleManagedRuleEnabledStateValues() []ManagedRuleEnabledState
PossibleManagedRuleEnabledStateValues returns an array of possible values for the ManagedRuleEnabledState const type.
ManagedRuleExclusion exclude variables from managed rule evaluation.
type ManagedRuleExclusion struct {
// MatchVariable - The variable type to be excluded. Possible values include: 'RequestHeaderNames', 'RequestCookieNames', 'QueryStringArgNames', 'RequestBodyPostArgNames'
MatchVariable ManagedRuleExclusionMatchVariable `json:"matchVariable,omitempty"`
// SelectorMatchOperator - Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. Possible values include: 'Equals', 'Contains', 'StartsWith', 'EndsWith', 'EqualsAny'
SelectorMatchOperator ManagedRuleExclusionSelectorMatchOperator `json:"selectorMatchOperator,omitempty"`
// Selector - Selector value for which elements in the collection this exclusion applies to.
Selector *string `json:"selector,omitempty"`
}
ManagedRuleExclusionMatchVariable enumerates the values for managed rule exclusion match variable.
type ManagedRuleExclusionMatchVariable string
const (
// QueryStringArgNames ...
QueryStringArgNames ManagedRuleExclusionMatchVariable = "QueryStringArgNames"
// RequestBodyPostArgNames ...
RequestBodyPostArgNames ManagedRuleExclusionMatchVariable = "RequestBodyPostArgNames"
// RequestCookieNames ...
RequestCookieNames ManagedRuleExclusionMatchVariable = "RequestCookieNames"
// RequestHeaderNames ...
RequestHeaderNames ManagedRuleExclusionMatchVariable = "RequestHeaderNames"
)
func PossibleManagedRuleExclusionMatchVariableValues() []ManagedRuleExclusionMatchVariable
PossibleManagedRuleExclusionMatchVariableValues returns an array of possible values for the ManagedRuleExclusionMatchVariable const type.
ManagedRuleExclusionSelectorMatchOperator enumerates the values for managed rule exclusion selector match operator.
type ManagedRuleExclusionSelectorMatchOperator string
const (
// Contains ...
Contains ManagedRuleExclusionSelectorMatchOperator = "Contains"
// EndsWith ...
EndsWith ManagedRuleExclusionSelectorMatchOperator = "EndsWith"
// Equals ...
Equals ManagedRuleExclusionSelectorMatchOperator = "Equals"
// EqualsAny ...
EqualsAny ManagedRuleExclusionSelectorMatchOperator = "EqualsAny"
// StartsWith ...
StartsWith ManagedRuleExclusionSelectorMatchOperator = "StartsWith"
)
func PossibleManagedRuleExclusionSelectorMatchOperatorValues() []ManagedRuleExclusionSelectorMatchOperator
PossibleManagedRuleExclusionSelectorMatchOperatorValues returns an array of possible values for the ManagedRuleExclusionSelectorMatchOperator const type.
ManagedRuleGroupDefinition describes a managed rule group.
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"`
}
func (mrgd ManagedRuleGroupDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagedRuleGroupDefinition.
ManagedRuleGroupOverride defines a managed rule group override setting.
type ManagedRuleGroupOverride struct {
// RuleGroupName - Describes the managed rule group to override.
RuleGroupName *string `json:"ruleGroupName,omitempty"`
// Exclusions - Describes the exclusions that are applied to all rules in the group.
Exclusions *[]ManagedRuleExclusion `json:"exclusions,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"`
}
ManagedRuleOverride defines a managed rule group override setting.
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"`
// Exclusions - Describes the exclusions that are applied to this specific rule.
Exclusions *[]ManagedRuleExclusion `json:"exclusions,omitempty"`
}
ManagedRuleSet defines a managed rule set.
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"`
// Exclusions - Describes the exclusions that are applied to all rules in the set.
Exclusions *[]ManagedRuleExclusion `json:"exclusions,omitempty"`
// RuleGroupOverrides - Defines the rule group overrides to apply to the rule set.
RuleGroupOverrides *[]ManagedRuleGroupOverride `json:"ruleGroupOverrides,omitempty"`
}
ManagedRuleSetDefinition describes the a managed rule set definition.
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"`
}
func (mrsd ManagedRuleSetDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagedRuleSetDefinition.
func (mrsd *ManagedRuleSetDefinition) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ManagedRuleSetDefinition struct.
ManagedRuleSetDefinitionList list of managed rule set definitions available for use in a policy.
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"`
}
func (mrsdl ManagedRuleSetDefinitionList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (mrsdl ManagedRuleSetDefinitionList) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagedRuleSetDefinitionList.
ManagedRuleSetDefinitionListIterator provides access to a complete listing of ManagedRuleSetDefinition values.
type ManagedRuleSetDefinitionListIterator struct {
// contains filtered or unexported fields
}
func NewManagedRuleSetDefinitionListIterator(page ManagedRuleSetDefinitionListPage) ManagedRuleSetDefinitionListIterator
Creates a new instance of the ManagedRuleSetDefinitionListIterator type.
func (iter *ManagedRuleSetDefinitionListIterator) 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 (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 (iter ManagedRuleSetDefinitionListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ManagedRuleSetDefinitionListIterator) Response() ManagedRuleSetDefinitionList
Response returns the raw server response from the last page request.
func (iter ManagedRuleSetDefinitionListIterator) Value() ManagedRuleSetDefinition
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ManagedRuleSetDefinitionListPage contains a page of ManagedRuleSetDefinition values.
type ManagedRuleSetDefinitionListPage struct {
// contains filtered or unexported fields
}
func NewManagedRuleSetDefinitionListPage(cur ManagedRuleSetDefinitionList, getNextPage func(context.Context, ManagedRuleSetDefinitionList) (ManagedRuleSetDefinitionList, error)) ManagedRuleSetDefinitionListPage
Creates a new instance of the ManagedRuleSetDefinitionListPage type.
func (page *ManagedRuleSetDefinitionListPage) 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 (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 (page ManagedRuleSetDefinitionListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ManagedRuleSetDefinitionListPage) Response() ManagedRuleSetDefinitionList
Response returns the raw server response from the last page request.
func (page ManagedRuleSetDefinitionListPage) Values() []ManagedRuleSetDefinition
Values returns the slice of values for the current page or nil if there are no values.
ManagedRuleSetDefinitionProperties properties for a managed rule set definition.
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"`
}
func (mrsdp ManagedRuleSetDefinitionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagedRuleSetDefinitionProperties.
ManagedRuleSetList defines the list of managed rule sets for the policy.
type ManagedRuleSetList struct {
// ManagedRuleSets - List of rule sets.
ManagedRuleSets *[]ManagedRuleSet `json:"managedRuleSets,omitempty"`
}
ManagedRuleSetsClient is the frontDoor Client
type ManagedRuleSetsClient struct {
BaseClient
}
func NewManagedRuleSetsClient(subscriptionID string) ManagedRuleSetsClient
NewManagedRuleSetsClient creates an instance of the ManagedRuleSetsClient client.
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 (client ManagedRuleSetsClient) List(ctx context.Context) (result ManagedRuleSetDefinitionListPage, err error)
List lists all available managed rule sets.
func (client ManagedRuleSetsClient) ListComplete(ctx context.Context) (result ManagedRuleSetDefinitionListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ManagedRuleSetsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
MatchCondition define a match condition.
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: 'OperatorAny', 'OperatorIPMatch', 'OperatorGeoMatch', 'OperatorEqual', 'OperatorContains', 'OperatorLessThan', 'OperatorGreaterThan', 'OperatorLessThanOrEqual', 'OperatorGreaterThanOrEqual', 'OperatorBeginsWith', 'OperatorEndsWith', 'OperatorRegEx'
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"`
}
MatchProcessingBehavior enumerates the values for match processing behavior.
type MatchProcessingBehavior string
const (
// Continue ...
Continue MatchProcessingBehavior = "Continue"
// Stop ...
Stop MatchProcessingBehavior = "Stop"
)
func PossibleMatchProcessingBehaviorValues() []MatchProcessingBehavior
PossibleMatchProcessingBehaviorValues returns an array of possible values for the MatchProcessingBehavior const type.
MatchVariable enumerates the values for match variable.
type MatchVariable string
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() []MatchVariable
PossibleMatchVariableValues returns an array of possible values for the MatchVariable const type.
MinimumTLSVersion enumerates the values for minimum tls version.
type MinimumTLSVersion string
const (
// OneFullStopTwo ...
OneFullStopTwo MinimumTLSVersion = "1.2"
// OneFullStopZero ...
OneFullStopZero MinimumTLSVersion = "1.0"
)
func PossibleMinimumTLSVersionValues() []MinimumTLSVersion
PossibleMinimumTLSVersionValues returns an array of possible values for the MinimumTLSVersion const type.
NetworkExperimentProfilesClient is the frontDoor Client
type NetworkExperimentProfilesClient struct {
BaseClient
}
func NewNetworkExperimentProfilesClient(subscriptionID string) NetworkExperimentProfilesClient
NewNetworkExperimentProfilesClient creates an instance of the NetworkExperimentProfilesClient client.
func NewNetworkExperimentProfilesClientWithBaseURI(baseURI string, subscriptionID string) NetworkExperimentProfilesClient
NewNetworkExperimentProfilesClientWithBaseURI creates an instance of the NetworkExperimentProfilesClient 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 (client NetworkExperimentProfilesClient) CreateOrUpdate(ctx context.Context, profileName string, resourceGroupName string, parameters Profile) (result NetworkExperimentProfilesCreateOrUpdateFuture, err error)
CreateOrUpdate sends the create or update request. Parameters: profileName - the Profile identifier associated with the Tenant and Partner resourceGroupName - name of the Resource group within the Azure subscription. parameters - an Network Experiment Profile
func (client NetworkExperimentProfilesClient) CreateOrUpdatePreparer(ctx context.Context, profileName string, resourceGroupName string, parameters Profile) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client NetworkExperimentProfilesClient) CreateOrUpdateResponder(resp *http.Response) (result Profile, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client NetworkExperimentProfilesClient) CreateOrUpdateSender(req *http.Request) (future NetworkExperimentProfilesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client NetworkExperimentProfilesClient) Delete(ctx context.Context, resourceGroupName string, profileName string) (result NetworkExperimentProfilesDeleteFuture, err error)
Delete sends the delete request. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. profileName - the Profile identifier associated with the Tenant and Partner
func (client NetworkExperimentProfilesClient) DeletePreparer(ctx context.Context, resourceGroupName string, profileName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client NetworkExperimentProfilesClient) 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 (client NetworkExperimentProfilesClient) DeleteSender(req *http.Request) (future NetworkExperimentProfilesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client NetworkExperimentProfilesClient) Get(ctx context.Context, resourceGroupName string, profileName string) (result Profile, err error)
Get sends the get request. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. profileName - the Profile identifier associated with the Tenant and Partner
func (client NetworkExperimentProfilesClient) GetPreparer(ctx context.Context, resourceGroupName string, profileName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client NetworkExperimentProfilesClient) GetResponder(resp *http.Response) (result Profile, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client NetworkExperimentProfilesClient) 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 (client NetworkExperimentProfilesClient) List(ctx context.Context) (result ProfileListPage, err error)
List sends the list request.
func (client NetworkExperimentProfilesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ProfileListPage, err error)
ListByResourceGroup sends the list by resource group request. Parameters: resourceGroupName - name of the Resource group within the Azure subscription.
func (client NetworkExperimentProfilesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ProfileListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client NetworkExperimentProfilesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client NetworkExperimentProfilesClient) ListByResourceGroupResponder(resp *http.Response) (result ProfileList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client NetworkExperimentProfilesClient) 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 (client NetworkExperimentProfilesClient) ListComplete(ctx context.Context) (result ProfileListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client NetworkExperimentProfilesClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client NetworkExperimentProfilesClient) ListResponder(resp *http.Response) (result ProfileList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client NetworkExperimentProfilesClient) 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 (client NetworkExperimentProfilesClient) Update(ctx context.Context, resourceGroupName string, profileName string, parameters ProfileUpdateModel) (result NetworkExperimentProfilesUpdateFuture, err error)
Update updates an NetworkExperimentProfiles Parameters: resourceGroupName - name of the Resource group within the Azure subscription. profileName - the Profile identifier associated with the Tenant and Partner parameters - the Profile Update Model
func (client NetworkExperimentProfilesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, profileName string, parameters ProfileUpdateModel) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client NetworkExperimentProfilesClient) UpdateResponder(resp *http.Response) (result Profile, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client NetworkExperimentProfilesClient) UpdateSender(req *http.Request) (future NetworkExperimentProfilesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
NetworkExperimentProfilesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type NetworkExperimentProfilesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(NetworkExperimentProfilesClient) (Profile, error)
}
func (future *NetworkExperimentProfilesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
NetworkExperimentProfilesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type NetworkExperimentProfilesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(NetworkExperimentProfilesClient) (autorest.Response, error)
}
func (future *NetworkExperimentProfilesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
NetworkExperimentProfilesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type NetworkExperimentProfilesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(NetworkExperimentProfilesClient) (Profile, error)
}
func (future *NetworkExperimentProfilesUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
NetworkExperimentResourceState enumerates the values for network experiment resource state.
type NetworkExperimentResourceState string
const (
// NetworkExperimentResourceStateCreating ...
NetworkExperimentResourceStateCreating NetworkExperimentResourceState = "Creating"
// NetworkExperimentResourceStateDeleting ...
NetworkExperimentResourceStateDeleting NetworkExperimentResourceState = "Deleting"
// NetworkExperimentResourceStateDisabled ...
NetworkExperimentResourceStateDisabled NetworkExperimentResourceState = "Disabled"
// NetworkExperimentResourceStateDisabling ...
NetworkExperimentResourceStateDisabling NetworkExperimentResourceState = "Disabling"
// NetworkExperimentResourceStateEnabled ...
NetworkExperimentResourceStateEnabled NetworkExperimentResourceState = "Enabled"
// NetworkExperimentResourceStateEnabling ...
NetworkExperimentResourceStateEnabling NetworkExperimentResourceState = "Enabling"
)
func PossibleNetworkExperimentResourceStateValues() []NetworkExperimentResourceState
PossibleNetworkExperimentResourceStateValues returns an array of possible values for the NetworkExperimentResourceState const type.
NetworkOperationStatus enumerates the values for network operation status.
type NetworkOperationStatus string
const (
// Failed ...
Failed NetworkOperationStatus = "Failed"
// InProgress ...
InProgress NetworkOperationStatus = "InProgress"
// Succeeded ...
Succeeded NetworkOperationStatus = "Succeeded"
)
func PossibleNetworkOperationStatusValues() []NetworkOperationStatus
PossibleNetworkOperationStatusValues returns an array of possible values for the NetworkOperationStatus const type.
OdataType enumerates the values for odata type.
type OdataType string
const (
// OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorForwardingConfiguration ...
OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorForwardingConfiguration OdataType = "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration"
// OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorRedirectConfiguration ...
OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorRedirectConfiguration OdataType = "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration"
// OdataTypeRouteConfiguration ...
OdataTypeRouteConfiguration OdataType = "RouteConfiguration"
)
func PossibleOdataTypeValues() []OdataType
PossibleOdataTypeValues returns an array of possible values for the OdataType const type.
Operator enumerates the values for operator.
type Operator string
const (
// OperatorAny ...
OperatorAny Operator = "Any"
// OperatorBeginsWith ...
OperatorBeginsWith Operator = "BeginsWith"
// OperatorContains ...
OperatorContains Operator = "Contains"
// OperatorEndsWith ...
OperatorEndsWith Operator = "EndsWith"
// OperatorEqual ...
OperatorEqual Operator = "Equal"
// OperatorGeoMatch ...
OperatorGeoMatch Operator = "GeoMatch"
// OperatorGreaterThan ...
OperatorGreaterThan Operator = "GreaterThan"
// OperatorGreaterThanOrEqual ...
OperatorGreaterThanOrEqual Operator = "GreaterThanOrEqual"
// OperatorIPMatch ...
OperatorIPMatch Operator = "IPMatch"
// OperatorLessThan ...
OperatorLessThan Operator = "LessThan"
// OperatorLessThanOrEqual ...
OperatorLessThanOrEqual Operator = "LessThanOrEqual"
// OperatorRegEx ...
OperatorRegEx Operator = "RegEx"
)
func PossibleOperatorValues() []Operator
PossibleOperatorValues returns an array of possible values for the Operator const type.
PoliciesClient is the frontDoor Client
type PoliciesClient struct {
BaseClient
}
func NewPoliciesClient(subscriptionID string) PoliciesClient
NewPoliciesClient creates an instance of the PoliciesClient client.
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 (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 (client PoliciesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, policyName string, parameters WebApplicationFirewallPolicy) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client PoliciesClient) DeletePreparer(ctx context.Context, resourceGroupName string, policyName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client PoliciesClient) GetPreparer(ctx context.Context, resourceGroupName string, policyName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (client PoliciesClient) ListComplete(ctx context.Context, resourceGroupName string) (result WebApplicationFirewallPolicyListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client PoliciesClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
PoliciesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type PoliciesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(PoliciesClient) (WebApplicationFirewallPolicy, error)
}
func (future *PoliciesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
PoliciesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type PoliciesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(PoliciesClient) (autorest.Response, error)
}
func (future *PoliciesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
PolicyEnabledState enumerates the values for policy enabled state.
type PolicyEnabledState string
const (
// PolicyEnabledStateDisabled ...
PolicyEnabledStateDisabled PolicyEnabledState = "Disabled"
// PolicyEnabledStateEnabled ...
PolicyEnabledStateEnabled PolicyEnabledState = "Enabled"
)
func PossiblePolicyEnabledStateValues() []PolicyEnabledState
PossiblePolicyEnabledStateValues returns an array of possible values for the PolicyEnabledState const type.
PolicyMode enumerates the values for policy mode.
type PolicyMode string
const (
// Detection ...
Detection PolicyMode = "Detection"
// Prevention ...
Prevention PolicyMode = "Prevention"
)
func PossiblePolicyModeValues() []PolicyMode
PossiblePolicyModeValues returns an array of possible values for the PolicyMode const type.
PolicyResourceState enumerates the values for policy resource state.
type PolicyResourceState string
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() []PolicyResourceState
PossiblePolicyResourceStateValues returns an array of possible values for the PolicyResourceState const type.
PolicySettings defines top-level WebApplicationFirewallPolicy configuration settings.
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"`
}
PreconfiguredEndpoint defines the properties of a preconfigured endpoint
type PreconfiguredEndpoint struct {
// PreconfiguredEndpointProperties - The properties of a preconfiguredEndpoint
*PreconfiguredEndpointProperties `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"`
}
func (peVar PreconfiguredEndpoint) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PreconfiguredEndpoint.
func (peVar *PreconfiguredEndpoint) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PreconfiguredEndpoint struct.
PreconfiguredEndpointList defines a list of preconfigured endpoints.
type PreconfiguredEndpointList struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of PreconfiguredEndpoints supported by NetworkExperiment.
Value *[]PreconfiguredEndpoint `json:"value,omitempty"`
// NextLink - URL to get the next set of PreconfiguredEndpoints if there are any.
NextLink *string `json:"nextLink,omitempty"`
}
func (pel PreconfiguredEndpointList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (pel PreconfiguredEndpointList) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PreconfiguredEndpointList.
PreconfiguredEndpointListIterator provides access to a complete listing of PreconfiguredEndpoint values.
type PreconfiguredEndpointListIterator struct {
// contains filtered or unexported fields
}
func NewPreconfiguredEndpointListIterator(page PreconfiguredEndpointListPage) PreconfiguredEndpointListIterator
Creates a new instance of the PreconfiguredEndpointListIterator type.
func (iter *PreconfiguredEndpointListIterator) 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 (iter *PreconfiguredEndpointListIterator) 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 (iter PreconfiguredEndpointListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter PreconfiguredEndpointListIterator) Response() PreconfiguredEndpointList
Response returns the raw server response from the last page request.
func (iter PreconfiguredEndpointListIterator) Value() PreconfiguredEndpoint
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
PreconfiguredEndpointListPage contains a page of PreconfiguredEndpoint values.
type PreconfiguredEndpointListPage struct {
// contains filtered or unexported fields
}
func NewPreconfiguredEndpointListPage(cur PreconfiguredEndpointList, getNextPage func(context.Context, PreconfiguredEndpointList) (PreconfiguredEndpointList, error)) PreconfiguredEndpointListPage
Creates a new instance of the PreconfiguredEndpointListPage type.
func (page *PreconfiguredEndpointListPage) 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 (page *PreconfiguredEndpointListPage) 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 (page PreconfiguredEndpointListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page PreconfiguredEndpointListPage) Response() PreconfiguredEndpointList
Response returns the raw server response from the last page request.
func (page PreconfiguredEndpointListPage) Values() []PreconfiguredEndpoint
Values returns the slice of values for the current page or nil if there are no values.
PreconfiguredEndpointProperties defines the properties of a preconfigured endpoint
type PreconfiguredEndpointProperties struct {
// Description - The description of the endpoint
Description *string `json:"description,omitempty"`
// Endpoint - The endpoint that is preconfigured
Endpoint *string `json:"endpoint,omitempty"`
// EndpointType - The type of endpoint. Possible values include: 'AFD', 'AzureRegion', 'CDN', 'ATM'
EndpointType EndpointType `json:"endpointType,omitempty"`
// Backend - The preconfigured endpoint backend
Backend *string `json:"backend,omitempty"`
}
PreconfiguredEndpointsClient is the frontDoor Client
type PreconfiguredEndpointsClient struct {
BaseClient
}
func NewPreconfiguredEndpointsClient(subscriptionID string) PreconfiguredEndpointsClient
NewPreconfiguredEndpointsClient creates an instance of the PreconfiguredEndpointsClient client.
func NewPreconfiguredEndpointsClientWithBaseURI(baseURI string, subscriptionID string) PreconfiguredEndpointsClient
NewPreconfiguredEndpointsClientWithBaseURI creates an instance of the PreconfiguredEndpointsClient 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 (client PreconfiguredEndpointsClient) List(ctx context.Context, resourceGroupName string, profileName string) (result PreconfiguredEndpointListPage, err error)
List sends the list request. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. profileName - the Profile identifier associated with the Tenant and Partner
func (client PreconfiguredEndpointsClient) ListComplete(ctx context.Context, resourceGroupName string, profileName string) (result PreconfiguredEndpointListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client PreconfiguredEndpointsClient) ListPreparer(ctx context.Context, resourceGroupName string, profileName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client PreconfiguredEndpointsClient) ListResponder(resp *http.Response) (result PreconfiguredEndpointList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client PreconfiguredEndpointsClient) 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.
PrivateEndpointStatus enumerates the values for private endpoint status.
type PrivateEndpointStatus string
const (
// Approved ...
Approved PrivateEndpointStatus = "Approved"
// Disconnected ...
Disconnected PrivateEndpointStatus = "Disconnected"
// Pending ...
Pending PrivateEndpointStatus = "Pending"
// Rejected ...
Rejected PrivateEndpointStatus = "Rejected"
// Timeout ...
Timeout PrivateEndpointStatus = "Timeout"
)
func PossiblePrivateEndpointStatusValues() []PrivateEndpointStatus
PossiblePrivateEndpointStatusValues returns an array of possible values for the PrivateEndpointStatus const type.
Profile defines an Network Experiment Profile and lists of Experiments
type Profile struct {
autorest.Response `json:"-"`
// ProfileProperties - The properties of a Profile
*ProfileProperties `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"`
}
func (p Profile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Profile.
func (p *Profile) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Profile struct.
ProfileList defines a list of Profiles. It contains a list of Profile objects and a URL link to get the next set of results.
type ProfileList struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of Profiles within a resource group.
Value *[]Profile `json:"value,omitempty"`
// NextLink - URL to get the next set of Profile objects if there are any.
NextLink *string `json:"nextLink,omitempty"`
}
func (pl ProfileList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (pl ProfileList) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProfileList.
ProfileListIterator provides access to a complete listing of Profile values.
type ProfileListIterator struct {
// contains filtered or unexported fields
}
func NewProfileListIterator(page ProfileListPage) ProfileListIterator
Creates a new instance of the ProfileListIterator type.
func (iter *ProfileListIterator) 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 (iter *ProfileListIterator) 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 (iter ProfileListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ProfileListIterator) Response() ProfileList
Response returns the raw server response from the last page request.
func (iter ProfileListIterator) Value() Profile
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ProfileListPage contains a page of Profile values.
type ProfileListPage struct {
// contains filtered or unexported fields
}
func NewProfileListPage(cur ProfileList, getNextPage func(context.Context, ProfileList) (ProfileList, error)) ProfileListPage
Creates a new instance of the ProfileListPage type.
func (page *ProfileListPage) 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 (page *ProfileListPage) 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 (page ProfileListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ProfileListPage) Response() ProfileList
Response returns the raw server response from the last page request.
func (page ProfileListPage) Values() []Profile
Values returns the slice of values for the current page or nil if there are no values.
ProfileProperties defines the properties of an experiment
type ProfileProperties struct {
// ResourceState - Resource status. Possible values include: 'NetworkExperimentResourceStateCreating', 'NetworkExperimentResourceStateEnabling', 'NetworkExperimentResourceStateEnabled', 'NetworkExperimentResourceStateDisabling', 'NetworkExperimentResourceStateDisabled', 'NetworkExperimentResourceStateDeleting'
ResourceState NetworkExperimentResourceState `json:"resourceState,omitempty"`
// EnabledState - The state of the Experiment. Possible values include: 'StateEnabled', 'StateDisabled'
EnabledState State `json:"enabledState,omitempty"`
}
ProfileUpdateModel defines modifiable attributes of a Profile
type ProfileUpdateModel struct {
// ProfileUpdateProperties - The properties of a Profile
*ProfileUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}
func (pum ProfileUpdateModel) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProfileUpdateModel.
func (pum *ProfileUpdateModel) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ProfileUpdateModel struct.
ProfileUpdateProperties defines the properties of an experiment
type ProfileUpdateProperties struct {
// EnabledState - The enabled state of the Profile. Possible values include: 'StateEnabled', 'StateDisabled'
EnabledState State `json:"enabledState,omitempty"`
}
Properties the JSON object that contains the properties required to create an endpoint.
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"`
// FrontdoorID - READ-ONLY; The Id of the frontdoor.
FrontdoorID *string `json:"frontdoorId,omitempty"`
// RulesEngines - READ-ONLY; Rules Engine Configurations available to routing rules.
RulesEngines *[]RulesEngine `json:"rulesEngines,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"`
}
func (p Properties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Properties.
Protocol enumerates the values for protocol.
type Protocol string
const (
// HTTP ...
HTTP Protocol = "Http"
// HTTPS ...
HTTPS Protocol = "Https"
)
func PossibleProtocolValues() []Protocol
PossibleProtocolValues returns an array of possible values for the Protocol const type.
PurgeParameters parameters required for content purge.
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"`
}
Query enumerates the values for query.
type Query string
const (
// StripAll ...
StripAll Query = "StripAll"
// StripAllExcept ...
StripAllExcept Query = "StripAllExcept"
// StripNone ...
StripNone Query = "StripNone"
// StripOnly ...
StripOnly Query = "StripOnly"
)
func PossibleQueryValues() []Query
PossibleQueryValues returns an array of possible values for the Query const type.
RedirectConfiguration describes Redirect Route.
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"`
}
func (rc RedirectConfiguration) AsBasicRouteConfiguration() (BasicRouteConfiguration, bool)
AsBasicRouteConfiguration is the BasicRouteConfiguration implementation for RedirectConfiguration.
func (rc RedirectConfiguration) AsForwardingConfiguration() (*ForwardingConfiguration, bool)
AsForwardingConfiguration is the BasicRouteConfiguration implementation for RedirectConfiguration.
func (rc RedirectConfiguration) AsRedirectConfiguration() (*RedirectConfiguration, bool)
AsRedirectConfiguration is the BasicRouteConfiguration implementation for RedirectConfiguration.
func (rc RedirectConfiguration) AsRouteConfiguration() (*RouteConfiguration, bool)
AsRouteConfiguration is the BasicRouteConfiguration implementation for RedirectConfiguration.
func (rc RedirectConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RedirectConfiguration.
RedirectProtocol enumerates the values for redirect protocol.
type RedirectProtocol string
const (
// RedirectProtocolHTTPOnly ...
RedirectProtocolHTTPOnly RedirectProtocol = "HttpOnly"
// RedirectProtocolHTTPSOnly ...
RedirectProtocolHTTPSOnly RedirectProtocol = "HttpsOnly"
// RedirectProtocolMatchRequest ...
RedirectProtocolMatchRequest RedirectProtocol = "MatchRequest"
)
func PossibleRedirectProtocolValues() []RedirectProtocol
PossibleRedirectProtocolValues returns an array of possible values for the RedirectProtocol const type.
RedirectType enumerates the values for redirect type.
type RedirectType string
const (
// Found ...
Found RedirectType = "Found"
// Moved ...
Moved RedirectType = "Moved"
// PermanentRedirect ...
PermanentRedirect RedirectType = "PermanentRedirect"
// TemporaryRedirect ...
TemporaryRedirect RedirectType = "TemporaryRedirect"
)
func PossibleRedirectTypeValues() []RedirectType
PossibleRedirectTypeValues returns an array of possible values for the RedirectType const type.
ReportsClient is the frontDoor Client
type ReportsClient struct {
BaseClient
}
func NewReportsClient(subscriptionID string) ReportsClient
NewReportsClient creates an instance of the ReportsClient client.
func NewReportsClientWithBaseURI(baseURI string, subscriptionID string) ReportsClient
NewReportsClientWithBaseURI creates an instance of the ReportsClient 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 (client ReportsClient) GetLatencyScorecards(ctx context.Context, resourceGroupName string, profileName string, experimentName string, aggregationInterval LatencyScorecardAggregationInterval, endDateTimeUTC string, country string) (result LatencyScorecard, err error)
GetLatencyScorecards sends the get latency scorecards request. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. profileName - the Profile identifier associated with the Tenant and Partner experimentName - the Experiment identifier associated with the Experiment aggregationInterval - the aggregation interval of the Latency Scorecard endDateTimeUTC - the end DateTime of the Latency Scorecard in UTC country - the country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html
func (client ReportsClient) GetLatencyScorecardsPreparer(ctx context.Context, resourceGroupName string, profileName string, experimentName string, aggregationInterval LatencyScorecardAggregationInterval, endDateTimeUTC string, country string) (*http.Request, error)
GetLatencyScorecardsPreparer prepares the GetLatencyScorecards request.
func (client ReportsClient) GetLatencyScorecardsResponder(resp *http.Response) (result LatencyScorecard, err error)
GetLatencyScorecardsResponder handles the response to the GetLatencyScorecards request. The method always closes the http.Response Body.
func (client ReportsClient) GetLatencyScorecardsSender(req *http.Request) (*http.Response, error)
GetLatencyScorecardsSender sends the GetLatencyScorecards request. The method will close the http.Response Body if it receives an error.
func (client ReportsClient) GetTimeseries(ctx context.Context, resourceGroupName string, profileName string, experimentName string, startDateTimeUTC date.Time, endDateTimeUTC date.Time, aggregationInterval TimeseriesAggregationInterval, timeseriesType TimeseriesType, endpoint string, country string) (result Timeseries, err error)
GetTimeseries sends the get timeseries request. Parameters: resourceGroupName - name of the Resource group within the Azure subscription. profileName - the Profile identifier associated with the Tenant and Partner experimentName - the Experiment identifier associated with the Experiment startDateTimeUTC - the start DateTime of the Timeseries in UTC endDateTimeUTC - the end DateTime of the Timeseries in UTC aggregationInterval - the aggregation interval of the Timeseries timeseriesType - the type of Timeseries endpoint - the specific endpoint country - the country associated with the Timeseries. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html
func (client ReportsClient) GetTimeseriesPreparer(ctx context.Context, resourceGroupName string, profileName string, experimentName string, startDateTimeUTC date.Time, endDateTimeUTC date.Time, aggregationInterval TimeseriesAggregationInterval, timeseriesType TimeseriesType, endpoint string, country string) (*http.Request, error)
GetTimeseriesPreparer prepares the GetTimeseries request.
func (client ReportsClient) GetTimeseriesResponder(resp *http.Response) (result Timeseries, err error)
GetTimeseriesResponder handles the response to the GetTimeseries request. The method always closes the http.Response Body.
func (client ReportsClient) GetTimeseriesSender(req *http.Request) (*http.Response, error)
GetTimeseriesSender sends the GetTimeseries request. The method will close the http.Response Body if it receives an error.
Resource common resource representation.
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"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceState enumerates the values for resource state.
type ResourceState string
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() []ResourceState
PossibleResourceStateValues returns an array of possible values for the ResourceState const type.
ResourceType enumerates the values for resource type.
type ResourceType string
const (
// MicrosoftNetworkfrontDoors ...
MicrosoftNetworkfrontDoors ResourceType = "Microsoft.Network/frontDoors"
// MicrosoftNetworkfrontDoorsfrontendEndpoints ...
MicrosoftNetworkfrontDoorsfrontendEndpoints ResourceType = "Microsoft.Network/frontDoors/frontendEndpoints"
)
func PossibleResourceTypeValues() []ResourceType
PossibleResourceTypeValues returns an array of possible values for the ResourceType const type.
RouteConfiguration base class for all types of Route.
type RouteConfiguration struct {
// OdataType - Possible values include: 'OdataTypeRouteConfiguration', 'OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorForwardingConfiguration', 'OdataTypeMicrosoftAzureFrontDoorModelsFrontdoorRedirectConfiguration'
OdataType OdataType `json:"@odata.type,omitempty"`
}
func (rc RouteConfiguration) AsBasicRouteConfiguration() (BasicRouteConfiguration, bool)
AsBasicRouteConfiguration is the BasicRouteConfiguration implementation for RouteConfiguration.
func (rc RouteConfiguration) AsForwardingConfiguration() (*ForwardingConfiguration, bool)
AsForwardingConfiguration is the BasicRouteConfiguration implementation for RouteConfiguration.
func (rc RouteConfiguration) AsRedirectConfiguration() (*RedirectConfiguration, bool)
AsRedirectConfiguration is the BasicRouteConfiguration implementation for RouteConfiguration.
func (rc RouteConfiguration) AsRouteConfiguration() (*RouteConfiguration, bool)
AsRouteConfiguration is the BasicRouteConfiguration implementation for RouteConfiguration.
func (rc RouteConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RouteConfiguration.
RoutingRule a routing rule represents a specification for traffic to treat and where to send it, along with health probe information.
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"`
}
func (rr RoutingRule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RoutingRule.
func (rr *RoutingRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RoutingRule struct.
RoutingRuleEnabledState enumerates the values for routing rule enabled state.
type RoutingRuleEnabledState string
const (
// RoutingRuleEnabledStateDisabled ...
RoutingRuleEnabledStateDisabled RoutingRuleEnabledState = "Disabled"
// RoutingRuleEnabledStateEnabled ...
RoutingRuleEnabledStateEnabled RoutingRuleEnabledState = "Enabled"
)
func PossibleRoutingRuleEnabledStateValues() []RoutingRuleEnabledState
PossibleRoutingRuleEnabledStateValues returns an array of possible values for the RoutingRuleEnabledState const type.
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 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"`
}
func (rrlr RoutingRuleListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RoutingRuleListResult.
RoutingRuleProperties the JSON object that contains the properties required to create a routing rule.
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"`
// RulesEngine - A reference to a specific Rules Engine Configuration to apply to this route.
RulesEngine *SubResource `json:"rulesEngine,omitempty"`
}
func (rrp *RoutingRuleProperties) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RoutingRuleProperties struct.
RoutingRuleUpdateParameters routing rules to apply to an endpoint
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"`
// RulesEngine - A reference to a specific Rules Engine Configuration to apply to this route.
RulesEngine *SubResource `json:"rulesEngine,omitempty"`
}
func (rrup *RoutingRuleUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RoutingRuleUpdateParameters struct.
RuleType enumerates the values for rule type.
type RuleType string
const (
// MatchRule ...
MatchRule RuleType = "MatchRule"
// RateLimitRule ...
RateLimitRule RuleType = "RateLimitRule"
)
func PossibleRuleTypeValues() []RuleType
PossibleRuleTypeValues returns an array of possible values for the RuleType const type.
RulesEngine a rules engine configuration containing a list of rules that will run to modify the runtime behavior of the request and response.
type RulesEngine struct {
autorest.Response `json:"-"`
// RulesEngineProperties - Properties of the Rules Engine Configuration.
*RulesEngineProperties `json:"properties,omitempty"`
// Name - READ-ONLY; Resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; Resource type.
Type *string `json:"type,omitempty"`
// ID - READ-ONLY; Resource ID.
ID *string `json:"id,omitempty"`
}
func (re RulesEngine) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RulesEngine.
func (re *RulesEngine) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RulesEngine struct.
RulesEngineAction one or more actions that will execute, modifying the request and/or response.
type RulesEngineAction struct {
// RequestHeaderActions - A list of header actions to apply from the request from AFD to the origin.
RequestHeaderActions *[]HeaderAction `json:"requestHeaderActions,omitempty"`
// ResponseHeaderActions - A list of header actions to apply from the response from AFD to the client.
ResponseHeaderActions *[]HeaderAction `json:"responseHeaderActions,omitempty"`
// RouteConfigurationOverride - Override the route configuration.
RouteConfigurationOverride BasicRouteConfiguration `json:"routeConfigurationOverride,omitempty"`
}
func (rea *RulesEngineAction) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RulesEngineAction struct.
RulesEngineListResult result of the request to list Rules Engine Configurations. It contains a list of RulesEngine objects and a URL link to get the next set of results.
type RulesEngineListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of rulesEngines within a Front Door.
Value *[]RulesEngine `json:"value,omitempty"`
// NextLink - URL to get the next set of RulesEngine objects if there are any.
NextLink *string `json:"nextLink,omitempty"`
}
func (relr RulesEngineListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (relr RulesEngineListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RulesEngineListResult.
RulesEngineListResultIterator provides access to a complete listing of RulesEngine values.
type RulesEngineListResultIterator struct {
// contains filtered or unexported fields
}
func NewRulesEngineListResultIterator(page RulesEngineListResultPage) RulesEngineListResultIterator
Creates a new instance of the RulesEngineListResultIterator type.
func (iter *RulesEngineListResultIterator) 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 (iter *RulesEngineListResultIterator) 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 (iter RulesEngineListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RulesEngineListResultIterator) Response() RulesEngineListResult
Response returns the raw server response from the last page request.
func (iter RulesEngineListResultIterator) Value() RulesEngine
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
RulesEngineListResultPage contains a page of RulesEngine values.
type RulesEngineListResultPage struct {
// contains filtered or unexported fields
}
func NewRulesEngineListResultPage(cur RulesEngineListResult, getNextPage func(context.Context, RulesEngineListResult) (RulesEngineListResult, error)) RulesEngineListResultPage
Creates a new instance of the RulesEngineListResultPage type.
func (page *RulesEngineListResultPage) 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 (page *RulesEngineListResultPage) 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 (page RulesEngineListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RulesEngineListResultPage) Response() RulesEngineListResult
Response returns the raw server response from the last page request.
func (page RulesEngineListResultPage) Values() []RulesEngine
Values returns the slice of values for the current page or nil if there are no values.
RulesEngineMatchCondition define a match condition
type RulesEngineMatchCondition struct {
// RulesEngineMatchVariable - Match Variable. Possible values include: 'RulesEngineMatchVariableIsMobile', 'RulesEngineMatchVariableRemoteAddr', 'RulesEngineMatchVariableRequestMethod', 'RulesEngineMatchVariableQueryString', 'RulesEngineMatchVariablePostArgs', 'RulesEngineMatchVariableRequestURI', 'RulesEngineMatchVariableRequestPath', 'RulesEngineMatchVariableRequestFilename', 'RulesEngineMatchVariableRequestFilenameExtension', 'RulesEngineMatchVariableRequestHeader', 'RulesEngineMatchVariableRequestBody', 'RulesEngineMatchVariableRequestScheme'
RulesEngineMatchVariable RulesEngineMatchVariable `json:"rulesEngineMatchVariable,omitempty"`
// Selector - Name of selector in RequestHeader or RequestBody to be matched
Selector *string `json:"selector,omitempty"`
// RulesEngineOperator - Describes operator to apply to the match condition. Possible values include: 'RulesEngineOperatorAny', 'RulesEngineOperatorIPMatch', 'RulesEngineOperatorGeoMatch', 'RulesEngineOperatorEqual', 'RulesEngineOperatorContains', 'RulesEngineOperatorLessThan', 'RulesEngineOperatorGreaterThan', 'RulesEngineOperatorLessThanOrEqual', 'RulesEngineOperatorGreaterThanOrEqual', 'RulesEngineOperatorBeginsWith', 'RulesEngineOperatorEndsWith'
RulesEngineOperator RulesEngineOperator `json:"rulesEngineOperator,omitempty"`
// NegateCondition - Describes if this is negate condition or not
NegateCondition *bool `json:"negateCondition,omitempty"`
// RulesEngineMatchValue - Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.
RulesEngineMatchValue *[]string `json:"rulesEngineMatchValue,omitempty"`
// Transforms - List of transforms
Transforms *[]Transform `json:"transforms,omitempty"`
}
RulesEngineMatchVariable enumerates the values for rules engine match variable.
type RulesEngineMatchVariable string
const (
// RulesEngineMatchVariableIsMobile ...
RulesEngineMatchVariableIsMobile RulesEngineMatchVariable = "IsMobile"
// RulesEngineMatchVariablePostArgs ...
RulesEngineMatchVariablePostArgs RulesEngineMatchVariable = "PostArgs"
// RulesEngineMatchVariableQueryString ...
RulesEngineMatchVariableQueryString RulesEngineMatchVariable = "QueryString"
// RulesEngineMatchVariableRemoteAddr ...
RulesEngineMatchVariableRemoteAddr RulesEngineMatchVariable = "RemoteAddr"
// RulesEngineMatchVariableRequestBody ...
RulesEngineMatchVariableRequestBody RulesEngineMatchVariable = "RequestBody"
// RulesEngineMatchVariableRequestFilename ...
RulesEngineMatchVariableRequestFilename RulesEngineMatchVariable = "RequestFilename"
// RulesEngineMatchVariableRequestFilenameExtension ...
RulesEngineMatchVariableRequestFilenameExtension RulesEngineMatchVariable = "RequestFilenameExtension"
// RulesEngineMatchVariableRequestHeader ...
RulesEngineMatchVariableRequestHeader RulesEngineMatchVariable = "RequestHeader"
// RulesEngineMatchVariableRequestMethod ...
RulesEngineMatchVariableRequestMethod RulesEngineMatchVariable = "RequestMethod"
// RulesEngineMatchVariableRequestPath ...
RulesEngineMatchVariableRequestPath RulesEngineMatchVariable = "RequestPath"
// RulesEngineMatchVariableRequestScheme ...
RulesEngineMatchVariableRequestScheme RulesEngineMatchVariable = "RequestScheme"
// RulesEngineMatchVariableRequestURI ...
RulesEngineMatchVariableRequestURI RulesEngineMatchVariable = "RequestUri"
)
func PossibleRulesEngineMatchVariableValues() []RulesEngineMatchVariable
PossibleRulesEngineMatchVariableValues returns an array of possible values for the RulesEngineMatchVariable const type.
RulesEngineOperator enumerates the values for rules engine operator.
type RulesEngineOperator string
const (
// RulesEngineOperatorAny ...
RulesEngineOperatorAny RulesEngineOperator = "Any"
// RulesEngineOperatorBeginsWith ...
RulesEngineOperatorBeginsWith RulesEngineOperator = "BeginsWith"
// RulesEngineOperatorContains ...
RulesEngineOperatorContains RulesEngineOperator = "Contains"
// RulesEngineOperatorEndsWith ...
RulesEngineOperatorEndsWith RulesEngineOperator = "EndsWith"
// RulesEngineOperatorEqual ...
RulesEngineOperatorEqual RulesEngineOperator = "Equal"
// RulesEngineOperatorGeoMatch ...
RulesEngineOperatorGeoMatch RulesEngineOperator = "GeoMatch"
// RulesEngineOperatorGreaterThan ...
RulesEngineOperatorGreaterThan RulesEngineOperator = "GreaterThan"
// RulesEngineOperatorGreaterThanOrEqual ...
RulesEngineOperatorGreaterThanOrEqual RulesEngineOperator = "GreaterThanOrEqual"
// RulesEngineOperatorIPMatch ...
RulesEngineOperatorIPMatch RulesEngineOperator = "IPMatch"
// RulesEngineOperatorLessThan ...
RulesEngineOperatorLessThan RulesEngineOperator = "LessThan"
// RulesEngineOperatorLessThanOrEqual ...
RulesEngineOperatorLessThanOrEqual RulesEngineOperator = "LessThanOrEqual"
)
func PossibleRulesEngineOperatorValues() []RulesEngineOperator
PossibleRulesEngineOperatorValues returns an array of possible values for the RulesEngineOperator const type.
RulesEngineProperties the JSON object that contains the properties required to create a Rules Engine Configuration.
type RulesEngineProperties struct {
// ResourceState - Resource status. Possible values include: 'ResourceStateCreating', 'ResourceStateEnabling', 'ResourceStateEnabled', 'ResourceStateDisabling', 'ResourceStateDisabled', 'ResourceStateDeleting'
ResourceState ResourceState `json:"resourceState,omitempty"`
// Rules - A list of rules that define a particular Rules Engine Configuration.
Rules *[]RulesEngineRule `json:"rules,omitempty"`
}
RulesEngineRule contains a list of match conditions, and an action on how to modify the request/response. If multiple rules match, the actions from one rule that conflict with a previous rule overwrite for a singular action, or append in the case of headers manipulation.
type RulesEngineRule struct {
// Name - A name to refer to this specific rule.
Name *string `json:"name,omitempty"`
// Priority - A priority assigned to this rule.
Priority *int32 `json:"priority,omitempty"`
// Action - Actions to perform on the request and response if all of the match conditions are met.
Action *RulesEngineAction `json:"action,omitempty"`
// MatchConditions - A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.
MatchConditions *[]RulesEngineMatchCondition `json:"matchConditions,omitempty"`
// MatchProcessingBehavior - If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Possible values include: 'Continue', 'Stop'
MatchProcessingBehavior MatchProcessingBehavior `json:"matchProcessingBehavior,omitempty"`
}
RulesEngineUpdateParameters rules Engine Configuration to apply to a Routing Rule.
type RulesEngineUpdateParameters struct {
// Rules - A list of rules that define a particular Rules Engine Configuration.
Rules *[]RulesEngineRule `json:"rules,omitempty"`
}
RulesEnginesClient is the frontDoor Client
type RulesEnginesClient struct {
BaseClient
}
func NewRulesEnginesClient(subscriptionID string) RulesEnginesClient
NewRulesEnginesClient creates an instance of the RulesEnginesClient client.
func NewRulesEnginesClientWithBaseURI(baseURI string, subscriptionID string) RulesEnginesClient
NewRulesEnginesClientWithBaseURI creates an instance of the RulesEnginesClient 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 (client RulesEnginesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, frontDoorName string, rulesEngineName string, rulesEngineParameters RulesEngine) (result RulesEnginesCreateOrUpdateFuture, err error)
CreateOrUpdate creates a new Rules Engine Configuration 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. rulesEngineName - name of the Rules Engine which is unique within the Front Door. rulesEngineParameters - rules Engine Configuration properties needed to create a new Rules Engine Configuration.
func (client RulesEnginesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, frontDoorName string, rulesEngineName string, rulesEngineParameters RulesEngine) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client RulesEnginesClient) CreateOrUpdateResponder(resp *http.Response) (result RulesEngine, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client RulesEnginesClient) CreateOrUpdateSender(req *http.Request) (future RulesEnginesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client RulesEnginesClient) Delete(ctx context.Context, resourceGroupName string, frontDoorName string, rulesEngineName string) (result RulesEnginesDeleteFuture, err error)
Delete deletes an existing Rules Engine Configuration 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. rulesEngineName - name of the Rules Engine which is unique within the Front Door.
func (client RulesEnginesClient) DeletePreparer(ctx context.Context, resourceGroupName string, frontDoorName string, rulesEngineName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client RulesEnginesClient) 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 (client RulesEnginesClient) DeleteSender(req *http.Request) (future RulesEnginesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client RulesEnginesClient) Get(ctx context.Context, resourceGroupName string, frontDoorName string, rulesEngineName string) (result RulesEngine, err error)
Get gets a Rules Engine Configuration 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. rulesEngineName - name of the Rules Engine which is unique within the Front Door.
func (client RulesEnginesClient) GetPreparer(ctx context.Context, resourceGroupName string, frontDoorName string, rulesEngineName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client RulesEnginesClient) GetResponder(resp *http.Response) (result RulesEngine, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client RulesEnginesClient) 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 (client RulesEnginesClient) ListByFrontDoor(ctx context.Context, resourceGroupName string, frontDoorName string) (result RulesEngineListResultPage, err error)
ListByFrontDoor lists all of the Rules Engine Configurations 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 (client RulesEnginesClient) ListByFrontDoorComplete(ctx context.Context, resourceGroupName string, frontDoorName string) (result RulesEngineListResultIterator, err error)
ListByFrontDoorComplete enumerates all values, automatically crossing page boundaries as required.
func (client RulesEnginesClient) ListByFrontDoorPreparer(ctx context.Context, resourceGroupName string, frontDoorName string) (*http.Request, error)
ListByFrontDoorPreparer prepares the ListByFrontDoor request.
func (client RulesEnginesClient) ListByFrontDoorResponder(resp *http.Response) (result RulesEngineListResult, err error)
ListByFrontDoorResponder handles the response to the ListByFrontDoor request. The method always closes the http.Response Body.
func (client RulesEnginesClient) 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.
RulesEnginesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RulesEnginesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RulesEnginesClient) (RulesEngine, error)
}
func (future *RulesEnginesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
RulesEnginesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RulesEnginesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(RulesEnginesClient) (autorest.Response, error)
}
func (future *RulesEnginesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SessionAffinityEnabledState enumerates the values for session affinity enabled state.
type SessionAffinityEnabledState string
const (
// SessionAffinityEnabledStateDisabled ...
SessionAffinityEnabledStateDisabled SessionAffinityEnabledState = "Disabled"
// SessionAffinityEnabledStateEnabled ...
SessionAffinityEnabledStateEnabled SessionAffinityEnabledState = "Enabled"
)
func PossibleSessionAffinityEnabledStateValues() []SessionAffinityEnabledState
PossibleSessionAffinityEnabledStateValues returns an array of possible values for the SessionAffinityEnabledState const type.
State enumerates the values for state.
type State string
const (
// StateDisabled ...
StateDisabled State = "Disabled"
// StateEnabled ...
StateEnabled State = "Enabled"
)
func PossibleStateValues() []State
PossibleStateValues returns an array of possible values for the State const type.
SubResource reference to another subresource.
type SubResource struct {
// ID - Resource ID.
ID *string `json:"id,omitempty"`
}
TagsObject tags object for patch operations.
type TagsObject struct {
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}
func (toVar TagsObject) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TagsObject.
Timeseries defines the Timeseries
type Timeseries struct {
autorest.Response `json:"-"`
// TimeseriesProperties - The properties of a Timeseries
*TimeseriesProperties `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"`
}
func (t Timeseries) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Timeseries.
func (t *Timeseries) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Timeseries struct.
TimeseriesAggregationInterval enumerates the values for timeseries aggregation interval.
type TimeseriesAggregationInterval string
const (
// TimeseriesAggregationIntervalDaily ...
TimeseriesAggregationIntervalDaily TimeseriesAggregationInterval = "Daily"
// TimeseriesAggregationIntervalHourly ...
TimeseriesAggregationIntervalHourly TimeseriesAggregationInterval = "Hourly"
)
func PossibleTimeseriesAggregationIntervalValues() []TimeseriesAggregationInterval
PossibleTimeseriesAggregationIntervalValues returns an array of possible values for the TimeseriesAggregationInterval const type.
TimeseriesDataPoint defines a timeseries datapoint used in a timeseries
type TimeseriesDataPoint struct {
// DateTimeUTC - The DateTime of the Timeseries data point in UTC
DateTimeUTC *string `json:"dateTimeUTC,omitempty"`
// Value - The Value of the Timeseries data point
Value *float64 `json:"value,omitempty"`
}
TimeseriesProperties defines the properties of a timeseries
type TimeseriesProperties struct {
// Endpoint - The endpoint associated with the Timeseries data point
Endpoint *string `json:"endpoint,omitempty"`
// StartDateTimeUTC - The start DateTime of the Timeseries in UTC
StartDateTimeUTC *string `json:"startDateTimeUTC,omitempty"`
// EndDateTimeUTC - The end DateTime of the Timeseries in UTC
EndDateTimeUTC *string `json:"endDateTimeUTC,omitempty"`
// AggregationInterval - The aggregation interval of the Timeseries. Possible values include: 'Hourly', 'Daily'
AggregationInterval AggregationInterval `json:"aggregationInterval,omitempty"`
// TimeseriesType - The type of Timeseries. Possible values include: 'MeasurementCounts', 'LatencyP50', 'LatencyP75', 'LatencyP95'
TimeseriesType TimeseriesType `json:"timeseriesType,omitempty"`
// Country - The country associated with the Timeseries. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html
Country *string `json:"country,omitempty"`
// TimeseriesData - The set of data points for the timeseries
TimeseriesData *[]TimeseriesDataPoint `json:"timeseriesData,omitempty"`
}
TimeseriesType enumerates the values for timeseries type.
type TimeseriesType string
const (
// LatencyP50 ...
LatencyP50 TimeseriesType = "LatencyP50"
// LatencyP75 ...
LatencyP75 TimeseriesType = "LatencyP75"
// LatencyP95 ...
LatencyP95 TimeseriesType = "LatencyP95"
// MeasurementCounts ...
MeasurementCounts TimeseriesType = "MeasurementCounts"
)
func PossibleTimeseriesTypeValues() []TimeseriesType
PossibleTimeseriesTypeValues returns an array of possible values for the TimeseriesType const type.
Transform enumerates the values for transform.
type Transform string
const (
// Lowercase ...
Lowercase Transform = "Lowercase"
// RemoveNulls ...
RemoveNulls Transform = "RemoveNulls"
// Trim ...
Trim Transform = "Trim"
// Uppercase ...
Uppercase Transform = "Uppercase"
// URLDecode ...
URLDecode Transform = "UrlDecode"
// URLEncode ...
URLEncode Transform = "UrlEncode"
)
func PossibleTransformValues() []Transform
PossibleTransformValues returns an array of possible values for the Transform const type.
TransformType enumerates the values for transform type.
type TransformType string
const (
// TransformTypeLowercase ...
TransformTypeLowercase TransformType = "Lowercase"
// TransformTypeRemoveNulls ...
TransformTypeRemoveNulls TransformType = "RemoveNulls"
// TransformTypeTrim ...
TransformTypeTrim TransformType = "Trim"
// TransformTypeUppercase ...
TransformTypeUppercase TransformType = "Uppercase"
// TransformTypeURLDecode ...
TransformTypeURLDecode TransformType = "UrlDecode"
// TransformTypeURLEncode ...
TransformTypeURLEncode TransformType = "UrlEncode"
)
func PossibleTransformTypeValues() []TransformType
PossibleTransformTypeValues returns an array of possible values for the TransformType const type.
UpdateParameters the properties needed to update a Front Door
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"`
}
ValidateCustomDomainInput input of the custom domain to be validated for DNS mapping.
type ValidateCustomDomainInput struct {
// HostName - The host name of the custom domain. Must be a domain name.
HostName *string `json:"hostName,omitempty"`
}
ValidateCustomDomainOutput output of custom domain validation.
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"`
}
func (vcdo ValidateCustomDomainOutput) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ValidateCustomDomainOutput.
WebApplicationFirewallPolicy defines web application firewall policy.
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"`
}
func (wafp WebApplicationFirewallPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for WebApplicationFirewallPolicy.
func (wafp *WebApplicationFirewallPolicy) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for WebApplicationFirewallPolicy struct.
WebApplicationFirewallPolicyList defines a list of WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.
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"`
}
func (wafpl WebApplicationFirewallPolicyList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (wafpl WebApplicationFirewallPolicyList) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for WebApplicationFirewallPolicyList.
WebApplicationFirewallPolicyListIterator provides access to a complete listing of WebApplicationFirewallPolicy values.
type WebApplicationFirewallPolicyListIterator struct {
// contains filtered or unexported fields
}
func NewWebApplicationFirewallPolicyListIterator(page WebApplicationFirewallPolicyListPage) WebApplicationFirewallPolicyListIterator
Creates a new instance of the WebApplicationFirewallPolicyListIterator type.
func (iter *WebApplicationFirewallPolicyListIterator) 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 (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 (iter WebApplicationFirewallPolicyListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter WebApplicationFirewallPolicyListIterator) Response() WebApplicationFirewallPolicyList
Response returns the raw server response from the last page request.
func (iter WebApplicationFirewallPolicyListIterator) Value() WebApplicationFirewallPolicy
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
WebApplicationFirewallPolicyListPage contains a page of WebApplicationFirewallPolicy values.
type WebApplicationFirewallPolicyListPage struct {
// contains filtered or unexported fields
}
func NewWebApplicationFirewallPolicyListPage(cur WebApplicationFirewallPolicyList, getNextPage func(context.Context, WebApplicationFirewallPolicyList) (WebApplicationFirewallPolicyList, error)) WebApplicationFirewallPolicyListPage
Creates a new instance of the WebApplicationFirewallPolicyListPage type.
func (page *WebApplicationFirewallPolicyListPage) 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 (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 (page WebApplicationFirewallPolicyListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page WebApplicationFirewallPolicyListPage) Response() WebApplicationFirewallPolicyList
Response returns the raw server response from the last page request.
func (page WebApplicationFirewallPolicyListPage) Values() []WebApplicationFirewallPolicy
Values returns the slice of values for the current page or nil if there are no values.
WebApplicationFirewallPolicyProperties defines web application firewall policy properties.
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"`
}
func (wafpp WebApplicationFirewallPolicyProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for WebApplicationFirewallPolicyProperties.
| Name | Synopsis |
|---|---|
| .. | |
| frontdoorapi | Deprecated: Please note, this package has been deprecated. |