trafficmanager

package
v26.4.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2019 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package trafficmanager implements the Azure ARM Trafficmanager service API version 2015-11-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.

type CheckTrafficManagerRelativeDNSNameAvailabilityParameters 

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

CheckTrafficManagerRelativeDNSNameAvailabilityParameters parameters supplied to check Traffic Manager name operation.

type DNSConfig 

type DNSConfig struct {
	// RelativeName - Gets or sets 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 - Gets or sets 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 - Gets or sets 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.

type Endpoint 

type Endpoint struct {
	autorest.Response `json:"-"`
	// ID - Gets or sets the ID of the Traffic Manager endpoint.
	ID *string `json:"id,omitempty"`
	// Name - Gets or sets the name of the Traffic Manager endpoint.
	Name *string `json:"name,omitempty"`
	// Type - Gets or sets the endpoint type of the Traffic Manager endpoint.
	Type                *string `json:"type,omitempty"`
	*EndpointProperties `json:"properties,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 EndpointProperties 

type EndpointProperties struct {
	// TargetResourceID - Gets or sets the Azure Resource URI of the of the endpoint.  Not applicable to endpoints of type 'ExternalEndpoints'.
	TargetResourceID *string `json:"targetResourceId,omitempty"`
	// Target - Gets or sets the fully-qualified DNS name of the endpoint.  Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.
	Target *string `json:"target,omitempty"`
	// EndpointStatus - Gets or sets 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 are 'Enabled' and 'Disabled'.
	EndpointStatus *string `json:"endpointStatus,omitempty"`
	// Weight - Gets or sets 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 - Gets or sets 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 - Gets or sets the monitoring status of the endpoint.
	EndpointMonitorStatus *string `json:"endpointMonitorStatus,omitempty"`
	// MinChildEndpoints - Gets or sets 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"`
}

EndpointProperties class representing a Traffic Manager endpoint properties.

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.

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 autorest.Response, 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 autorest.Response, 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 MonitorConfig 

type MonitorConfig struct {
	// ProfileMonitorStatus - Gets or sets the profile-level monitoring status of the Traffic Manager profile.
	ProfileMonitorStatus *string `json:"profileMonitorStatus,omitempty"`
	// Protocol - Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health.
	Protocol *string `json:"protocol,omitempty"`
	// Port - Gets or sets the TCP port used to probe for endpoint health.
	Port *int64 `json:"port,omitempty"`
	// Path - Gets or sets the path relative to the endpoint domain name used to probe for endpoint health.
	Path *string `json:"path,omitempty"`
}

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

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 `json:"properties,omitempty"`
	// ID - Resource Id
	ID *string `json:"id,omitempty"`
	// Name - Resource name
	Name *string `json:"name,omitempty"`
	// Type - Resource type
	Type *string `json:"type,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

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 ProfileProperties 

type ProfileProperties struct {
	// ProfileStatus - Gets or sets the status of the Traffic Manager profile.  Possible values are 'Enabled' and 'Disabled'.
	ProfileStatus *string `json:"profileStatus,omitempty"`
	// TrafficRoutingMethod - Gets or sets the traffic routing method of the Traffic Manager profile.  Possible values are 'Performance', 'Weighted', or 'Priority'.
	TrafficRoutingMethod *string `json:"trafficRoutingMethod,omitempty"`
	// DNSConfig - Gets or sets the DNS settings of the Traffic Manager profile.
	DNSConfig *DNSConfig `json:"dnsConfig,omitempty"`
	// MonitorConfig - Gets or sets the endpoint monitoring settings of the Traffic Manager profile.
	MonitorConfig *MonitorConfig `json:"monitorConfig,omitempty"`
	// Endpoints - Gets or sets the list of endpoints in the Traffic Manager profile.
	Endpoints *[]Endpoint `json:"endpoints,omitempty"`
}

ProfileProperties class representing the Traffic Manager profile properties.

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.

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 autorest.Response, 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 autorest.Response, 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) ListAll 

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

ListAll lists all Traffic Manager profiles within a subscription.

func (ProfilesClient) ListAllInResourceGroup 

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

ListAllInResourceGroup 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) ListAllInResourceGroupPreparer 

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

ListAllInResourceGroupPreparer prepares the ListAllInResourceGroup request.

func (ProfilesClient) ListAllInResourceGroupResponder 

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

ListAllInResourceGroupResponder handles the response to the ListAllInResourceGroup request. The method always closes the http.Response Body.

func (ProfilesClient) ListAllInResourceGroupSender 

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

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

func (ProfilesClient) ListAllPreparer 

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

ListAllPreparer prepares the ListAll request.

func (ProfilesClient) ListAllResponder 

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

ListAllResponder handles the response to the ListAll request. The method always closes the http.Response Body.

func (ProfilesClient) ListAllSender 

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

ListAllSender sends the ListAll 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 Resource 

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

Resource ...

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

type SubResource 

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

SubResource ...

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.