trafficmanager

package
v59.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 4, 2021 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package trafficmanager implements the Azure ARM Trafficmanager service API version 2018-03-01.

Index

Constants

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

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type BaseClient 

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

BaseClient is the base client for Trafficmanager.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

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

type CheckTrafficManagerRelativeDNSNameAvailabilityParameters 

type CheckTrafficManagerRelativeDNSNameAvailabilityParameters struct {
	// Name - The name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource.
	Type *string `json:"type,omitempty"`
}

CheckTrafficManagerRelativeDNSNameAvailabilityParameters parameters supplied to check Traffic Manager name operation.

type CloudError 

type CloudError struct {
	// Error - The content of the error.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError an error returned by the Azure Resource Manager

type CloudErrorBody 

type CloudErrorBody struct {
	// Code - Error code
	Code *string `json:"code,omitempty"`
	// Message - Error message
	Message *string `json:"message,omitempty"`
	// Target - Error target
	Target *string `json:"target,omitempty"`
	// Details - Error details
	Details *[]CloudErrorBody `json:"details,omitempty"`
}

CloudErrorBody the content of an error returned by the Azure Resource Manager

type DNSConfig 

type DNSConfig struct {
	// RelativeName - The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile.
	RelativeName *string `json:"relativeName,omitempty"`
	// Fqdn - READ-ONLY; The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager.
	Fqdn *string `json:"fqdn,omitempty"`
	// TTL - The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile.
	TTL *int64 `json:"ttl,omitempty"`
}

DNSConfig class containing DNS settings in a Traffic Manager profile.

func (DNSConfig) MarshalJSON 

func (dc DNSConfig) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DNSConfig.

type DeleteOperationResult 

type DeleteOperationResult struct {
	autorest.Response `json:"-"`
	// OperationResult - READ-ONLY; The result of the operation or request.
	OperationResult *bool `json:"boolean,omitempty"`
}

DeleteOperationResult the result of the request or operation.

func (DeleteOperationResult) MarshalJSON 

func (dor DeleteOperationResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeleteOperationResult.

type Endpoint 

type Endpoint struct {
	autorest.Response `json:"-"`
	// EndpointProperties - The properties of the Traffic Manager endpoint.
	*EndpointProperties `json:"properties,omitempty"`
	// ID - Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
	Type *string `json:"type,omitempty"`
}

Endpoint class representing a Traffic Manager endpoint.

func (Endpoint) MarshalJSON 

func (e Endpoint) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Endpoint.

func (*Endpoint) UnmarshalJSON 

func (e *Endpoint) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Endpoint struct.

type EndpointMonitorStatus 

type EndpointMonitorStatus string

EndpointMonitorStatus enumerates the values for endpoint monitor status. 

const (
	// CheckingEndpoint ...
	CheckingEndpoint EndpointMonitorStatus = "CheckingEndpoint"
	// Degraded ...
	Degraded EndpointMonitorStatus = "Degraded"
	// Disabled ...
	Disabled EndpointMonitorStatus = "Disabled"
	// Inactive ...
	Inactive EndpointMonitorStatus = "Inactive"
	// Online ...
	Online EndpointMonitorStatus = "Online"
	// Stopped ...
	Stopped EndpointMonitorStatus = "Stopped"
)

func PossibleEndpointMonitorStatusValues 

func PossibleEndpointMonitorStatusValues() []EndpointMonitorStatus

PossibleEndpointMonitorStatusValues returns an array of possible values for the EndpointMonitorStatus const type.

type EndpointProperties 

type EndpointProperties struct {
	// TargetResourceID - The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
	TargetResourceID *string `json:"targetResourceId,omitempty"`
	// Target - The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.
	Target *string `json:"target,omitempty"`
	// EndpointStatus - The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values include: 'EndpointStatusEnabled', 'EndpointStatusDisabled'
	EndpointStatus EndpointStatus `json:"endpointStatus,omitempty"`
	// Weight - The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.
	Weight *int64 `json:"weight,omitempty"`
	// Priority - The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter.  If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value.
	Priority *int64 `json:"priority,omitempty"`
	// EndpointLocation - Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method.
	EndpointLocation *string `json:"endpointLocation,omitempty"`
	// EndpointMonitorStatus - The monitoring status of the endpoint. Possible values include: 'CheckingEndpoint', 'Online', 'Degraded', 'Disabled', 'Inactive', 'Stopped'
	EndpointMonitorStatus EndpointMonitorStatus `json:"endpointMonitorStatus,omitempty"`
	// MinChildEndpoints - The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
	MinChildEndpoints *int64 `json:"minChildEndpoints,omitempty"`
	// GeoMapping - The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.
	GeoMapping *[]string `json:"geoMapping,omitempty"`
	// CustomHeaders - List of custom headers.
	CustomHeaders *[]EndpointPropertiesCustomHeadersItem `json:"customHeaders,omitempty"`
}

EndpointProperties class representing a Traffic Manager endpoint properties.

type EndpointPropertiesCustomHeadersItem 

type EndpointPropertiesCustomHeadersItem struct {
	// Name - Header name.
	Name *string `json:"name,omitempty"`
	// Value - Header value.
	Value *string `json:"value,omitempty"`
}

EndpointPropertiesCustomHeadersItem custom header name and value.

type EndpointStatus 

type EndpointStatus string

EndpointStatus enumerates the values for endpoint status. 

const (
	// EndpointStatusDisabled ...
	EndpointStatusDisabled EndpointStatus = "Disabled"
	// EndpointStatusEnabled ...
	EndpointStatusEnabled EndpointStatus = "Enabled"
)

func PossibleEndpointStatusValues 

func PossibleEndpointStatusValues() []EndpointStatus

PossibleEndpointStatusValues returns an array of possible values for the EndpointStatus const type.

type EndpointsClient 

type EndpointsClient struct {
	BaseClient
}

EndpointsClient is the client for the Endpoints methods of the Trafficmanager service.

func NewEndpointsClient 

func NewEndpointsClient(subscriptionID string) EndpointsClient

NewEndpointsClient creates an instance of the EndpointsClient client.

func NewEndpointsClientWithBaseURI 

func NewEndpointsClientWithBaseURI(baseURI string, subscriptionID string) EndpointsClient

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

func (EndpointsClient) CreateOrUpdate 

func (client EndpointsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, profileName string, endpointType string, endpointName string, parameters Endpoint) (result Endpoint, err error)

CreateOrUpdate create or update a Traffic Manager endpoint. Parameters: resourceGroupName - the name of the resource group containing the Traffic Manager endpoint to be created or updated. profileName - the name of the Traffic Manager profile. endpointType - the type of the Traffic Manager endpoint to be created or updated. endpointName - the name of the Traffic Manager endpoint to be created or updated. parameters - the Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation.

func (EndpointsClient) CreateOrUpdatePreparer 

func (client EndpointsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, profileName string, endpointType string, endpointName string, parameters Endpoint) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (EndpointsClient) CreateOrUpdateResponder 

func (client EndpointsClient) CreateOrUpdateResponder(resp *http.Response) (result Endpoint, err error)

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

func (EndpointsClient) CreateOrUpdateSender 

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

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

func (EndpointsClient) Delete 

func (client EndpointsClient) Delete(ctx context.Context, resourceGroupName string, profileName string, endpointType string, endpointName string) (result DeleteOperationResult, err error)

Delete deletes a Traffic Manager endpoint. Parameters: resourceGroupName - the name of the resource group containing the Traffic Manager endpoint to be deleted. profileName - the name of the Traffic Manager profile. endpointType - the type of the Traffic Manager endpoint to be deleted. endpointName - the name of the Traffic Manager endpoint to be deleted.

func (EndpointsClient) DeletePreparer 

func (client EndpointsClient) DeletePreparer(ctx context.Context, resourceGroupName string, profileName string, endpointType string, endpointName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (EndpointsClient) DeleteResponder 

func (client EndpointsClient) DeleteResponder(resp *http.Response) (result DeleteOperationResult, err error)

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

func (EndpointsClient) DeleteSender 

func (client EndpointsClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (EndpointsClient) Get 

func (client EndpointsClient) Get(ctx context.Context, resourceGroupName string, profileName string, endpointType string, endpointName string) (result Endpoint, err error)

Get gets a Traffic Manager endpoint. Parameters: resourceGroupName - the name of the resource group containing the Traffic Manager endpoint. profileName - the name of the Traffic Manager profile. endpointType - the type of the Traffic Manager endpoint. endpointName - the name of the Traffic Manager endpoint.

func (EndpointsClient) GetPreparer 

func (client EndpointsClient) GetPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointType string, endpointName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (EndpointsClient) GetResponder 

func (client EndpointsClient) GetResponder(resp *http.Response) (result Endpoint, err error)

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

func (EndpointsClient) GetSender 

func (client EndpointsClient) 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 (EndpointsClient) Update 

func (client EndpointsClient) Update(ctx context.Context, resourceGroupName string, profileName string, endpointType string, endpointName string, parameters Endpoint) (result Endpoint, err error)

Update update a Traffic Manager endpoint. Parameters: resourceGroupName - the name of the resource group containing the Traffic Manager endpoint to be updated. profileName - the name of the Traffic Manager profile. endpointType - the type of the Traffic Manager endpoint to be updated. endpointName - the name of the Traffic Manager endpoint to be updated. parameters - the Traffic Manager endpoint parameters supplied to the Update operation.

func (EndpointsClient) UpdatePreparer 

func (client EndpointsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, profileName string, endpointType string, endpointName string, parameters Endpoint) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (EndpointsClient) UpdateResponder 

func (client EndpointsClient) UpdateResponder(resp *http.Response) (result Endpoint, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (EndpointsClient) UpdateSender 

func (client EndpointsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type GeographicHierarchiesClient 

type GeographicHierarchiesClient struct {
	BaseClient
}

GeographicHierarchiesClient is the client for the GeographicHierarchies methods of the Trafficmanager service.

func NewGeographicHierarchiesClient 

func NewGeographicHierarchiesClient(subscriptionID string) GeographicHierarchiesClient

NewGeographicHierarchiesClient creates an instance of the GeographicHierarchiesClient client.

func NewGeographicHierarchiesClientWithBaseURI 

func NewGeographicHierarchiesClientWithBaseURI(baseURI string, subscriptionID string) GeographicHierarchiesClient

NewGeographicHierarchiesClientWithBaseURI creates an instance of the GeographicHierarchiesClient 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 (GeographicHierarchiesClient) GetDefault 

func (client GeographicHierarchiesClient) GetDefault(ctx context.Context) (result GeographicHierarchy, err error)

GetDefault gets the default Geographic Hierarchy used by the Geographic traffic routing method.

func (GeographicHierarchiesClient) GetDefaultPreparer 

func (client GeographicHierarchiesClient) GetDefaultPreparer(ctx context.Context) (*http.Request, error)

GetDefaultPreparer prepares the GetDefault request.

func (GeographicHierarchiesClient) GetDefaultResponder 

func (client GeographicHierarchiesClient) GetDefaultResponder(resp *http.Response) (result GeographicHierarchy, err error)

GetDefaultResponder handles the response to the GetDefault request. The method always closes the http.Response Body.

func (GeographicHierarchiesClient) GetDefaultSender 

func (client GeographicHierarchiesClient) GetDefaultSender(req *http.Request) (*http.Response, error)

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

type GeographicHierarchy 

type GeographicHierarchy struct {
	autorest.Response `json:"-"`
	// GeographicHierarchyProperties - The properties of the Geographic Hierarchy resource.
	*GeographicHierarchyProperties `json:"properties,omitempty"`
	// ID - Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
	Type *string `json:"type,omitempty"`
}

GeographicHierarchy class representing the Geographic hierarchy used with the Geographic traffic routing method.

func (GeographicHierarchy) MarshalJSON 

func (gh GeographicHierarchy) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GeographicHierarchy.

func (*GeographicHierarchy) UnmarshalJSON 

func (gh *GeographicHierarchy) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GeographicHierarchy struct.

type GeographicHierarchyProperties 

type GeographicHierarchyProperties struct {
	// GeographicHierarchy - The region at the root of the hierarchy from all the regions in the hierarchy can be retrieved.
	GeographicHierarchy *Region `json:"geographicHierarchy,omitempty"`
}

GeographicHierarchyProperties class representing the properties of the Geographic hierarchy used with the Geographic traffic routing method.

type HeatMapClient 

type HeatMapClient struct {
	BaseClient
}

HeatMapClient is the client for the HeatMap methods of the Trafficmanager service.

func NewHeatMapClient 

func NewHeatMapClient(subscriptionID string) HeatMapClient

NewHeatMapClient creates an instance of the HeatMapClient client.

func NewHeatMapClientWithBaseURI 

func NewHeatMapClientWithBaseURI(baseURI string, subscriptionID string) HeatMapClient

NewHeatMapClientWithBaseURI creates an instance of the HeatMapClient 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 (HeatMapClient) Get 

func (client HeatMapClient) Get(ctx context.Context, resourceGroupName string, profileName string, topLeft []float64, botRight []float64) (result HeatMapModel, err error)

Get gets latest heatmap for Traffic Manager profile. Parameters: resourceGroupName - the name of the resource group containing the Traffic Manager endpoint. profileName - the name of the Traffic Manager profile. topLeft - the top left latitude,longitude pair of the rectangular viewport to query for. botRight - the bottom right latitude,longitude pair of the rectangular viewport to query for.

func (HeatMapClient) GetPreparer 

func (client HeatMapClient) GetPreparer(ctx context.Context, resourceGroupName string, profileName string, topLeft []float64, botRight []float64) (*http.Request, error)

GetPreparer prepares the Get request.

func (HeatMapClient) GetResponder 

func (client HeatMapClient) GetResponder(resp *http.Response) (result HeatMapModel, err error)

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

func (HeatMapClient) GetSender 

func (client HeatMapClient) 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.

type HeatMapEndpoint 

type HeatMapEndpoint struct {
	// ResourceID - The ARM Resource ID of this Traffic Manager endpoint.
	ResourceID *string `json:"resourceId,omitempty"`
	// EndpointID - A number uniquely identifying this endpoint in query experiences.
	EndpointID *int32 `json:"endpointId,omitempty"`
}

HeatMapEndpoint class which is a sparse representation of a Traffic Manager endpoint.

type HeatMapModel 

type HeatMapModel struct {
	autorest.Response `json:"-"`
	// HeatMapProperties - The properties of the Traffic Manager HeatMap.
	*HeatMapProperties `json:"properties,omitempty"`
	// ID - Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
	Type *string `json:"type,omitempty"`
}

HeatMapModel class representing a Traffic Manager HeatMap.

func (HeatMapModel) MarshalJSON 

func (hmm HeatMapModel) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for HeatMapModel.

func (*HeatMapModel) UnmarshalJSON 

func (hmm *HeatMapModel) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for HeatMapModel struct.

type HeatMapProperties 

type HeatMapProperties struct {
	// StartTime - The beginning of the time window for this HeatMap, inclusive.
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - The ending of the time window for this HeatMap, exclusive.
	EndTime *date.Time `json:"endTime,omitempty"`
	// Endpoints - The endpoints used in this HeatMap calculation.
	Endpoints *[]HeatMapEndpoint `json:"endpoints,omitempty"`
	// TrafficFlows - The traffic flows produced in this HeatMap calculation.
	TrafficFlows *[]TrafficFlow `json:"trafficFlows,omitempty"`
}

HeatMapProperties class representing a Traffic Manager HeatMap properties.

type MonitorConfig 

type MonitorConfig struct {
	// ProfileMonitorStatus - The profile-level monitoring status of the Traffic Manager profile. Possible values include: 'ProfileMonitorStatusCheckingEndpoints', 'ProfileMonitorStatusOnline', 'ProfileMonitorStatusDegraded', 'ProfileMonitorStatusDisabled', 'ProfileMonitorStatusInactive'
	ProfileMonitorStatus ProfileMonitorStatus `json:"profileMonitorStatus,omitempty"`
	// Protocol - The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. Possible values include: 'HTTP', 'HTTPS', 'TCP'
	Protocol MonitorProtocol `json:"protocol,omitempty"`
	// Port - The TCP port used to probe for endpoint health.
	Port *int64 `json:"port,omitempty"`
	// Path - The path relative to the endpoint domain name used to probe for endpoint health.
	Path *string `json:"path,omitempty"`
	// IntervalInSeconds - The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.
	IntervalInSeconds *int64 `json:"intervalInSeconds,omitempty"`
	// TimeoutInSeconds - The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.
	TimeoutInSeconds *int64 `json:"timeoutInSeconds,omitempty"`
	// ToleratedNumberOfFailures - The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.
	ToleratedNumberOfFailures *int64 `json:"toleratedNumberOfFailures,omitempty"`
	// CustomHeaders - List of custom headers.
	CustomHeaders *[]MonitorConfigCustomHeadersItem `json:"customHeaders,omitempty"`
	// ExpectedStatusCodeRanges - List of expected status code ranges.
	ExpectedStatusCodeRanges *[]MonitorConfigExpectedStatusCodeRangesItem `json:"expectedStatusCodeRanges,omitempty"`
}

MonitorConfig class containing endpoint monitoring settings in a Traffic Manager profile.

type MonitorConfigCustomHeadersItem 

type MonitorConfigCustomHeadersItem struct {
	// Name - Header name.
	Name *string `json:"name,omitempty"`
	// Value - Header value.
	Value *string `json:"value,omitempty"`
}

MonitorConfigCustomHeadersItem custom header name and value.

type MonitorConfigExpectedStatusCodeRangesItem 

type MonitorConfigExpectedStatusCodeRangesItem struct {
	// Min - Min status code.
	Min *int32 `json:"min,omitempty"`
	// Max - Max status code.
	Max *int32 `json:"max,omitempty"`
}

MonitorConfigExpectedStatusCodeRangesItem min and max value of a status code range.

type MonitorProtocol 

type MonitorProtocol string

MonitorProtocol enumerates the values for monitor protocol. 

const (
	// HTTP ...
	HTTP MonitorProtocol = "HTTP"
	// HTTPS ...
	HTTPS MonitorProtocol = "HTTPS"
	// TCP ...
	TCP MonitorProtocol = "TCP"
)

func PossibleMonitorProtocolValues 

func PossibleMonitorProtocolValues() []MonitorProtocol

PossibleMonitorProtocolValues returns an array of possible values for the MonitorProtocol const type.

type NameAvailability 

type NameAvailability struct {
	autorest.Response `json:"-"`
	// Name - The relative name.
	Name *string `json:"name,omitempty"`
	// Type - Traffic Manager profile resource type.
	Type *string `json:"type,omitempty"`
	// NameAvailable - Describes whether the relative name is available or not.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - The reason why the name is not available, when applicable.
	Reason *string `json:"reason,omitempty"`
	// Message - Descriptive message that explains why the name is not available, when applicable.
	Message *string `json:"message,omitempty"`
}

NameAvailability class representing a Traffic Manager Name Availability response.

type Profile 

type Profile struct {
	autorest.Response `json:"-"`
	// ProfileProperties - The properties of the Traffic Manager profile.
	*ProfileProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The Azure Region where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
	Type *string `json:"type,omitempty"`
}

Profile class representing a Traffic Manager profile.

func (Profile) MarshalJSON 

func (p Profile) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Profile.

func (*Profile) UnmarshalJSON 

func (p *Profile) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Profile struct.

type ProfileListResult 

type ProfileListResult struct {
	autorest.Response `json:"-"`
	// Value - Gets the list of Traffic manager profiles.
	Value *[]Profile `json:"value,omitempty"`
}

ProfileListResult the list Traffic Manager profiles operation response.

type ProfileMonitorStatus 

type ProfileMonitorStatus string

ProfileMonitorStatus enumerates the values for profile monitor status. 

const (
	// ProfileMonitorStatusCheckingEndpoints ...
	ProfileMonitorStatusCheckingEndpoints ProfileMonitorStatus = "CheckingEndpoints"
	// ProfileMonitorStatusDegraded ...
	ProfileMonitorStatusDegraded ProfileMonitorStatus = "Degraded"
	// ProfileMonitorStatusDisabled ...
	ProfileMonitorStatusDisabled ProfileMonitorStatus = "Disabled"
	// ProfileMonitorStatusInactive ...
	ProfileMonitorStatusInactive ProfileMonitorStatus = "Inactive"
	// ProfileMonitorStatusOnline ...
	ProfileMonitorStatusOnline ProfileMonitorStatus = "Online"
)

func PossibleProfileMonitorStatusValues 

func PossibleProfileMonitorStatusValues() []ProfileMonitorStatus

PossibleProfileMonitorStatusValues returns an array of possible values for the ProfileMonitorStatus const type.

type ProfileProperties 

type ProfileProperties struct {
	// ProfileStatus - The status of the Traffic Manager profile. Possible values include: 'ProfileStatusEnabled', 'ProfileStatusDisabled'
	ProfileStatus ProfileStatus `json:"profileStatus,omitempty"`
	// TrafficRoutingMethod - The traffic routing method of the Traffic Manager profile. Possible values include: 'Performance', 'Priority', 'Weighted', 'Geographic'
	TrafficRoutingMethod TrafficRoutingMethod `json:"trafficRoutingMethod,omitempty"`
	// DNSConfig - The DNS settings of the Traffic Manager profile.
	DNSConfig *DNSConfig `json:"dnsConfig,omitempty"`
	// MonitorConfig - The endpoint monitoring settings of the Traffic Manager profile.
	MonitorConfig *MonitorConfig `json:"monitorConfig,omitempty"`
	// Endpoints - The list of endpoints in the Traffic Manager profile.
	Endpoints *[]Endpoint `json:"endpoints,omitempty"`
	// TrafficViewEnrollmentStatus - Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile. Possible values include: 'TrafficViewEnrollmentStatusEnabled', 'TrafficViewEnrollmentStatusDisabled'
	TrafficViewEnrollmentStatus TrafficViewEnrollmentStatus `json:"trafficViewEnrollmentStatus,omitempty"`
}

ProfileProperties class representing the Traffic Manager profile properties.

type ProfileStatus 

type ProfileStatus string

ProfileStatus enumerates the values for profile status. 

const (
	// ProfileStatusDisabled ...
	ProfileStatusDisabled ProfileStatus = "Disabled"
	// ProfileStatusEnabled ...
	ProfileStatusEnabled ProfileStatus = "Enabled"
)

func PossibleProfileStatusValues 

func PossibleProfileStatusValues() []ProfileStatus

PossibleProfileStatusValues returns an array of possible values for the ProfileStatus const type.

type ProfilesClient 

type ProfilesClient struct {
	BaseClient
}

ProfilesClient is the client for the Profiles methods of the Trafficmanager service.

func NewProfilesClient 

func NewProfilesClient(subscriptionID string) ProfilesClient

NewProfilesClient creates an instance of the ProfilesClient client.

func NewProfilesClientWithBaseURI 

func NewProfilesClientWithBaseURI(baseURI string, subscriptionID string) ProfilesClient

NewProfilesClientWithBaseURI creates an instance of the ProfilesClient 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 (ProfilesClient) CheckTrafficManagerRelativeDNSNameAvailability 

func (client ProfilesClient) CheckTrafficManagerRelativeDNSNameAvailability(ctx context.Context, parameters CheckTrafficManagerRelativeDNSNameAvailabilityParameters) (result NameAvailability, err error)

CheckTrafficManagerRelativeDNSNameAvailability checks the availability of a Traffic Manager Relative DNS name. Parameters: parameters - the Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation.

func (ProfilesClient) CheckTrafficManagerRelativeDNSNameAvailabilityPreparer 

func (client ProfilesClient) CheckTrafficManagerRelativeDNSNameAvailabilityPreparer(ctx context.Context, parameters CheckTrafficManagerRelativeDNSNameAvailabilityParameters) (*http.Request, error)

CheckTrafficManagerRelativeDNSNameAvailabilityPreparer prepares the CheckTrafficManagerRelativeDNSNameAvailability request.

func (ProfilesClient) CheckTrafficManagerRelativeDNSNameAvailabilityResponder 

func (client ProfilesClient) CheckTrafficManagerRelativeDNSNameAvailabilityResponder(resp *http.Response) (result NameAvailability, err error)

CheckTrafficManagerRelativeDNSNameAvailabilityResponder handles the response to the CheckTrafficManagerRelativeDNSNameAvailability request. The method always closes the http.Response Body.

func (ProfilesClient) CheckTrafficManagerRelativeDNSNameAvailabilitySender 

func (client ProfilesClient) CheckTrafficManagerRelativeDNSNameAvailabilitySender(req *http.Request) (*http.Response, error)

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

func (ProfilesClient) CreateOrUpdate 

func (client ProfilesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, profileName string, parameters Profile) (result Profile, err error)

CreateOrUpdate create or update a Traffic Manager profile. Parameters: resourceGroupName - the name of the resource group containing the Traffic Manager profile. profileName - the name of the Traffic Manager profile. parameters - the Traffic Manager profile parameters supplied to the CreateOrUpdate operation.

func (ProfilesClient) CreateOrUpdatePreparer 

func (client ProfilesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, profileName string, parameters Profile) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ProfilesClient) CreateOrUpdateResponder 

func (client ProfilesClient) 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 (ProfilesClient) CreateOrUpdateSender 

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

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

func (ProfilesClient) Delete 

func (client ProfilesClient) Delete(ctx context.Context, resourceGroupName string, profileName string) (result DeleteOperationResult, err error)

Delete deletes a Traffic Manager profile. Parameters: resourceGroupName - the name of the resource group containing the Traffic Manager profile to be deleted. profileName - the name of the Traffic Manager profile to be deleted.

func (ProfilesClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (ProfilesClient) DeleteResponder 

func (client ProfilesClient) DeleteResponder(resp *http.Response) (result DeleteOperationResult, err error)

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

func (ProfilesClient) DeleteSender 

func (client ProfilesClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (ProfilesClient) Get 

func (client ProfilesClient) Get(ctx context.Context, resourceGroupName string, profileName string) (result Profile, err error)

Get gets a Traffic Manager profile. Parameters: resourceGroupName - the name of the resource group containing the Traffic Manager profile. profileName - the name of the Traffic Manager profile.

func (ProfilesClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (ProfilesClient) GetResponder 

func (client ProfilesClient) 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 (ProfilesClient) GetSender 

func (client ProfilesClient) 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 (ProfilesClient) ListByResourceGroup 

func (client ProfilesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ProfileListResult, err error)

ListByResourceGroup lists all Traffic Manager profiles within a resource group. Parameters: resourceGroupName - the name of the resource group containing the Traffic Manager profiles to be listed.

func (ProfilesClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ProfilesClient) ListByResourceGroupResponder 

func (client ProfilesClient) ListByResourceGroupResponder(resp *http.Response) (result ProfileListResult, err error)

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

func (ProfilesClient) ListByResourceGroupSender 

func (client ProfilesClient) 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 (ProfilesClient) ListBySubscription 

func (client ProfilesClient) ListBySubscription(ctx context.Context) (result ProfileListResult, err error)

ListBySubscription lists all Traffic Manager profiles within a subscription.

func (ProfilesClient) ListBySubscriptionPreparer 

func (client ProfilesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (ProfilesClient) ListBySubscriptionResponder 

func (client ProfilesClient) ListBySubscriptionResponder(resp *http.Response) (result ProfileListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (ProfilesClient) ListBySubscriptionSender 

func (client ProfilesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

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

func (ProfilesClient) Update 

func (client ProfilesClient) Update(ctx context.Context, resourceGroupName string, profileName string, parameters Profile) (result Profile, err error)

Update update a Traffic Manager profile. Parameters: resourceGroupName - the name of the resource group containing the Traffic Manager profile. profileName - the name of the Traffic Manager profile. parameters - the Traffic Manager profile parameters supplied to the Update operation.

func (ProfilesClient) UpdatePreparer 

func (client ProfilesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, profileName string, parameters Profile) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ProfilesClient) UpdateResponder 

func (client ProfilesClient) 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 (ProfilesClient) UpdateSender 

func (client ProfilesClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type ProxyResource 

type ProxyResource struct {
	// ID - Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags

type QueryExperience 

type QueryExperience struct {
	// EndpointID - The id of the endpoint from the 'endpoints' array which these queries were routed to.
	EndpointID *int32 `json:"endpointId,omitempty"`
	// QueryCount - The number of queries originating from this location.
	QueryCount *int32 `json:"queryCount,omitempty"`
	// Latency - The latency experienced by queries originating from this location.
	Latency *float64 `json:"latency,omitempty"`
}

QueryExperience class representing a Traffic Manager HeatMap query experience properties.

type Region 

type Region struct {
	// Code - The code of the region
	Code *string `json:"code,omitempty"`
	// Name - The name of the region
	Name *string `json:"name,omitempty"`
	// Regions - The list of Regions grouped under this Region in the Geographic Hierarchy.
	Regions *[]Region `json:"regions,omitempty"`
}

Region class representing a region in the Geographic hierarchy used with the Geographic traffic routing method.

type Resource 

type Resource struct {
	// ID - Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
	Type *string `json:"type,omitempty"`
}

Resource the core properties of ARM resources

type TrackedResource 

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The Azure Region where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for a ARM tracked top level resource

func (TrackedResource) MarshalJSON 

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type TrafficFlow 

type TrafficFlow struct {
	// SourceIP - The IP address that this query experience originated from.
	SourceIP *string `json:"sourceIp,omitempty"`
	// Latitude - The approximate latitude that these queries originated from.
	Latitude *float64 `json:"latitude,omitempty"`
	// Longitude - The approximate longitude that these queries originated from.
	Longitude *float64 `json:"longitude,omitempty"`
	// QueryExperiences - The query experiences produced in this HeatMap calculation.
	QueryExperiences *[]QueryExperience `json:"queryExperiences,omitempty"`
}

TrafficFlow class representing a Traffic Manager HeatMap traffic flow properties.

type TrafficRoutingMethod 

type TrafficRoutingMethod string

TrafficRoutingMethod enumerates the values for traffic routing method. 

const (
	// Geographic ...
	Geographic TrafficRoutingMethod = "Geographic"
	// Performance ...
	Performance TrafficRoutingMethod = "Performance"
	// Priority ...
	Priority TrafficRoutingMethod = "Priority"
	// Weighted ...
	Weighted TrafficRoutingMethod = "Weighted"
)

func PossibleTrafficRoutingMethodValues 

func PossibleTrafficRoutingMethodValues() []TrafficRoutingMethod

PossibleTrafficRoutingMethodValues returns an array of possible values for the TrafficRoutingMethod const type.

type TrafficViewEnrollmentStatus 

type TrafficViewEnrollmentStatus string

TrafficViewEnrollmentStatus enumerates the values for traffic view enrollment status. 

const (
	// TrafficViewEnrollmentStatusDisabled ...
	TrafficViewEnrollmentStatusDisabled TrafficViewEnrollmentStatus = "Disabled"
	// TrafficViewEnrollmentStatusEnabled ...
	TrafficViewEnrollmentStatusEnabled TrafficViewEnrollmentStatus = "Enabled"
)

func PossibleTrafficViewEnrollmentStatusValues 

func PossibleTrafficViewEnrollmentStatusValues() []TrafficViewEnrollmentStatus

PossibleTrafficViewEnrollmentStatusValues returns an array of possible values for the TrafficViewEnrollmentStatus const type.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.