profiles

package
v0.20241128.1084944 Latest Latest
Warning

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

 Go to latest Published: Nov 28, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/trafficmanager/2022-04-01/profiles Documentation

The profiles SDK allows for interaction with Azure Resource Manager trafficmanager (API Version 2022-04-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/trafficmanager/2022-04-01/profiles"

Client Initialization

client := profiles.NewProfilesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProfilesClient.CheckTrafficManagerNameAvailabilityV2

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := profiles.CheckTrafficManagerRelativeDnsNameAvailabilityParameters{
	// ...
}


read, err := client.CheckTrafficManagerNameAvailabilityV2(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ProfilesClient.CheckTrafficManagerRelativeDnsNameAvailability

ctx := context.TODO()

payload := profiles.CheckTrafficManagerRelativeDnsNameAvailabilityParameters{
	// ...
}


read, err := client.CheckTrafficManagerRelativeDnsNameAvailability(ctx, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ProfilesClient.CreateOrUpdate

ctx := context.TODO()
id := profiles.NewTrafficManagerProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficManagerProfileName")

payload := profiles.Profile{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ProfilesClient.Delete

ctx := context.TODO()
id := profiles.NewTrafficManagerProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficManagerProfileName")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ProfilesClient.Get

ctx := context.TODO()
id := profiles.NewTrafficManagerProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficManagerProfileName")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ProfilesClient.ListByResourceGroup

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

read, err := client.ListByResourceGroup(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ProfilesClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

read, err := client.ListBySubscription(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ProfilesClient.Update

ctx := context.TODO()
id := profiles.NewTrafficManagerProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficManagerProfileName")

payload := profiles.Profile{
	// ...
}


read, err := client.Update(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAllowedEndpointRecordType 

func PossibleValuesForAllowedEndpointRecordType() []string

func PossibleValuesForAlwaysServe 

func PossibleValuesForAlwaysServe() []string

func PossibleValuesForEndpointMonitorStatus 

func PossibleValuesForEndpointMonitorStatus() []string

func PossibleValuesForEndpointStatus 

func PossibleValuesForEndpointStatus() []string

func PossibleValuesForMonitorProtocol 

func PossibleValuesForMonitorProtocol() []string

func PossibleValuesForProfileMonitorStatus 

func PossibleValuesForProfileMonitorStatus() []string

func PossibleValuesForProfileStatus 

func PossibleValuesForProfileStatus() []string

func PossibleValuesForTrafficRoutingMethod 

func PossibleValuesForTrafficRoutingMethod() []string

func PossibleValuesForTrafficViewEnrollmentStatus 

func PossibleValuesForTrafficViewEnrollmentStatus() []string

func ValidateTrafficManagerProfileID 

func ValidateTrafficManagerProfileID(input interface{}, key string) (warnings []string, errors []error)

ValidateTrafficManagerProfileID checks that 'input' can be parsed as a Traffic Manager Profile ID

Types

type AllowedEndpointRecordType 

type AllowedEndpointRecordType string
const (
	AllowedEndpointRecordTypeAny            AllowedEndpointRecordType = "Any"
	AllowedEndpointRecordTypeDomainName     AllowedEndpointRecordType = "DomainName"
	AllowedEndpointRecordTypeIPvFourAddress AllowedEndpointRecordType = "IPv4Address"
	AllowedEndpointRecordTypeIPvSixAddress  AllowedEndpointRecordType = "IPv6Address"
)

func (*AllowedEndpointRecordType) UnmarshalJSON 

func (s *AllowedEndpointRecordType) UnmarshalJSON(bytes []byte) error

type AlwaysServe 

type AlwaysServe string
const (
	AlwaysServeDisabled AlwaysServe = "Disabled"
	AlwaysServeEnabled  AlwaysServe = "Enabled"
)

func (*AlwaysServe) UnmarshalJSON 

func (s *AlwaysServe) UnmarshalJSON(bytes []byte) error

type CheckTrafficManagerNameAvailabilityV2OperationResponse 

type CheckTrafficManagerNameAvailabilityV2OperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TrafficManagerNameAvailability
}

type CheckTrafficManagerRelativeDnsNameAvailabilityOperationResponse 

type CheckTrafficManagerRelativeDnsNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TrafficManagerNameAvailability
}

type CheckTrafficManagerRelativeDnsNameAvailabilityParameters 

type CheckTrafficManagerRelativeDnsNameAvailabilityParameters struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Profile
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DeleteOperationResult
}

type DeleteOperationResult 

type DeleteOperationResult struct {
	Boolean *bool `json:"boolean,omitempty"`
}

type DnsConfig 

type DnsConfig struct {
	Fqdn         *string `json:"fqdn,omitempty"`
	RelativeName *string `json:"relativeName,omitempty"`
	Ttl          *int64  `json:"ttl,omitempty"`
}

type Endpoint 

type Endpoint struct {
	Id         *string             `json:"id,omitempty"`
	Name       *string             `json:"name,omitempty"`
	Properties *EndpointProperties `json:"properties,omitempty"`
	Type       *string             `json:"type,omitempty"`
}

type EndpointMonitorStatus 

type EndpointMonitorStatus string
const (
	EndpointMonitorStatusCheckingEndpoint EndpointMonitorStatus = "CheckingEndpoint"
	EndpointMonitorStatusDegraded         EndpointMonitorStatus = "Degraded"
	EndpointMonitorStatusDisabled         EndpointMonitorStatus = "Disabled"
	EndpointMonitorStatusInactive         EndpointMonitorStatus = "Inactive"
	EndpointMonitorStatusOnline           EndpointMonitorStatus = "Online"
	EndpointMonitorStatusStopped          EndpointMonitorStatus = "Stopped"
	EndpointMonitorStatusUnmonitored      EndpointMonitorStatus = "Unmonitored"
)

func (*EndpointMonitorStatus) UnmarshalJSON 

func (s *EndpointMonitorStatus) UnmarshalJSON(bytes []byte) error

type EndpointProperties 

type EndpointProperties struct {
	AlwaysServe           *AlwaysServe                              `json:"alwaysServe,omitempty"`
	CustomHeaders         *[]EndpointPropertiesCustomHeadersInlined `json:"customHeaders,omitempty"`
	EndpointLocation      *string                                   `json:"endpointLocation,omitempty"`
	EndpointMonitorStatus *EndpointMonitorStatus                    `json:"endpointMonitorStatus,omitempty"`
	EndpointStatus        *EndpointStatus                           `json:"endpointStatus,omitempty"`
	GeoMapping            *[]string                                 `json:"geoMapping,omitempty"`
	MinChildEndpoints     *int64                                    `json:"minChildEndpoints,omitempty"`
	MinChildEndpointsIPv4 *int64                                    `json:"minChildEndpointsIPv4,omitempty"`
	MinChildEndpointsIPv6 *int64                                    `json:"minChildEndpointsIPv6,omitempty"`
	Priority              *int64                                    `json:"priority,omitempty"`
	Subnets               *[]EndpointPropertiesSubnetsInlined       `json:"subnets,omitempty"`
	Target                *string                                   `json:"target,omitempty"`
	TargetResourceId      *string                                   `json:"targetResourceId,omitempty"`
	Weight                *int64                                    `json:"weight,omitempty"`
}

type EndpointPropertiesCustomHeadersInlined 

type EndpointPropertiesCustomHeadersInlined struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type EndpointPropertiesSubnetsInlined 

type EndpointPropertiesSubnetsInlined struct {
	First *string `json:"first,omitempty"`
	Last  *string `json:"last,omitempty"`
	Scope *int64  `json:"scope,omitempty"`
}

type EndpointStatus 

type EndpointStatus string
const (
	EndpointStatusDisabled EndpointStatus = "Disabled"
	EndpointStatusEnabled  EndpointStatus = "Enabled"
)

func (*EndpointStatus) UnmarshalJSON 

func (s *EndpointStatus) UnmarshalJSON(bytes []byte) error

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Profile
}

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProfileListResult
}

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProfileListResult
}

type MonitorConfig 

type MonitorConfig struct {
	CustomHeaders             *[]MonitorConfigCustomHeadersInlined            `json:"customHeaders,omitempty"`
	ExpectedStatusCodeRanges  *[]MonitorConfigExpectedStatusCodeRangesInlined `json:"expectedStatusCodeRanges,omitempty"`
	IntervalInSeconds         *int64                                          `json:"intervalInSeconds,omitempty"`
	Path                      *string                                         `json:"path,omitempty"`
	Port                      *int64                                          `json:"port,omitempty"`
	ProfileMonitorStatus      *ProfileMonitorStatus                           `json:"profileMonitorStatus,omitempty"`
	Protocol                  *MonitorProtocol                                `json:"protocol,omitempty"`
	TimeoutInSeconds          *int64                                          `json:"timeoutInSeconds,omitempty"`
	ToleratedNumberOfFailures *int64                                          `json:"toleratedNumberOfFailures,omitempty"`
}

type MonitorConfigCustomHeadersInlined 

type MonitorConfigCustomHeadersInlined struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type MonitorConfigExpectedStatusCodeRangesInlined 

type MonitorConfigExpectedStatusCodeRangesInlined struct {
	Max *int64 `json:"max,omitempty"`
	Min *int64 `json:"min,omitempty"`
}

type MonitorProtocol 

type MonitorProtocol string
const (
	MonitorProtocolHTTP  MonitorProtocol = "HTTP"
	MonitorProtocolHTTPS MonitorProtocol = "HTTPS"
	MonitorProtocolTCP   MonitorProtocol = "TCP"
)

func (*MonitorProtocol) UnmarshalJSON 

func (s *MonitorProtocol) UnmarshalJSON(bytes []byte) error

type Profile 

type Profile struct {
	Id         *string            `json:"id,omitempty"`
	Location   *string            `json:"location,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties *ProfileProperties `json:"properties,omitempty"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

type ProfileListResult 

type ProfileListResult struct {
	Value *[]Profile `json:"value,omitempty"`
}

type ProfileMonitorStatus 

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

func (*ProfileMonitorStatus) UnmarshalJSON 

func (s *ProfileMonitorStatus) UnmarshalJSON(bytes []byte) error

type ProfileProperties 

type ProfileProperties struct {
	AllowedEndpointRecordTypes  *[]AllowedEndpointRecordType `json:"allowedEndpointRecordTypes,omitempty"`
	DnsConfig                   *DnsConfig                   `json:"dnsConfig,omitempty"`
	Endpoints                   *[]Endpoint                  `json:"endpoints,omitempty"`
	MaxReturn                   *int64                       `json:"maxReturn,omitempty"`
	MonitorConfig               *MonitorConfig               `json:"monitorConfig,omitempty"`
	ProfileStatus               *ProfileStatus               `json:"profileStatus,omitempty"`
	TrafficRoutingMethod        *TrafficRoutingMethod        `json:"trafficRoutingMethod,omitempty"`
	TrafficViewEnrollmentStatus *TrafficViewEnrollmentStatus `json:"trafficViewEnrollmentStatus,omitempty"`
}

type ProfileStatus 

type ProfileStatus string
const (
	ProfileStatusDisabled ProfileStatus = "Disabled"
	ProfileStatusEnabled  ProfileStatus = "Enabled"
)

func (*ProfileStatus) UnmarshalJSON 

func (s *ProfileStatus) UnmarshalJSON(bytes []byte) error

type ProfilesClient 

type ProfilesClient struct {
	Client *resourcemanager.Client
}

func NewProfilesClientWithBaseURI 

func NewProfilesClientWithBaseURI(sdkApi sdkEnv.Api) (*ProfilesClient, error)

func (ProfilesClient) CheckTrafficManagerNameAvailabilityV2 

func (c ProfilesClient) CheckTrafficManagerNameAvailabilityV2(ctx context.Context, id commonids.SubscriptionId, input CheckTrafficManagerRelativeDnsNameAvailabilityParameters) (result CheckTrafficManagerNameAvailabilityV2OperationResponse, err error)

CheckTrafficManagerNameAvailabilityV2 ...

func (ProfilesClient) CheckTrafficManagerRelativeDnsNameAvailability 

func (c ProfilesClient) CheckTrafficManagerRelativeDnsNameAvailability(ctx context.Context, input CheckTrafficManagerRelativeDnsNameAvailabilityParameters) (result CheckTrafficManagerRelativeDnsNameAvailabilityOperationResponse, err error)

CheckTrafficManagerRelativeDnsNameAvailability ...

func (ProfilesClient) CreateOrUpdate 

func (c ProfilesClient) CreateOrUpdate(ctx context.Context, id TrafficManagerProfileId, input Profile) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ProfilesClient) Delete 

func (c ProfilesClient) Delete(ctx context.Context, id TrafficManagerProfileId) (result DeleteOperationResponse, err error)

Delete ...

func (ProfilesClient) Get 

func (c ProfilesClient) Get(ctx context.Context, id TrafficManagerProfileId) (result GetOperationResponse, err error)

Get ...

func (ProfilesClient) ListByResourceGroup 

func (c ProfilesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ProfilesClient) ListBySubscription 

func (c ProfilesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (ProfilesClient) Update 

func (c ProfilesClient) Update(ctx context.Context, id TrafficManagerProfileId, input Profile) (result UpdateOperationResponse, err error)

Update ...

type TrafficManagerNameAvailability 

type TrafficManagerNameAvailability struct {
	Message       *string `json:"message,omitempty"`
	Name          *string `json:"name,omitempty"`
	NameAvailable *bool   `json:"nameAvailable,omitempty"`
	Reason        *string `json:"reason,omitempty"`
	Type          *string `json:"type,omitempty"`
}

type TrafficManagerProfileId 

type TrafficManagerProfileId struct {
	SubscriptionId            string
	ResourceGroupName         string
	TrafficManagerProfileName string
}

TrafficManagerProfileId is a struct representing the Resource ID for a Traffic Manager Profile

func NewTrafficManagerProfileID 

func NewTrafficManagerProfileID(subscriptionId string, resourceGroupName string, trafficManagerProfileName string) TrafficManagerProfileId

NewTrafficManagerProfileID returns a new TrafficManagerProfileId struct

func ParseTrafficManagerProfileID 

func ParseTrafficManagerProfileID(input string) (*TrafficManagerProfileId, error)

ParseTrafficManagerProfileID parses 'input' into a TrafficManagerProfileId

func ParseTrafficManagerProfileIDInsensitively 

func ParseTrafficManagerProfileIDInsensitively(input string) (*TrafficManagerProfileId, error)

ParseTrafficManagerProfileIDInsensitively parses 'input' case-insensitively into a TrafficManagerProfileId note: this method should only be used for API response data and not user input

func (*TrafficManagerProfileId) FromParseResult 

func (id *TrafficManagerProfileId) FromParseResult(input resourceids.ParseResult) error

func (TrafficManagerProfileId) ID 

func (id TrafficManagerProfileId) ID() string

ID returns the formatted Traffic Manager Profile ID

func (TrafficManagerProfileId) Segments 

func (id TrafficManagerProfileId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Traffic Manager Profile ID

func (TrafficManagerProfileId) String 

func (id TrafficManagerProfileId) String() string

String returns a human-readable description of this Traffic Manager Profile ID

type TrafficRoutingMethod 

type TrafficRoutingMethod string
const (
	TrafficRoutingMethodGeographic  TrafficRoutingMethod = "Geographic"
	TrafficRoutingMethodMultiValue  TrafficRoutingMethod = "MultiValue"
	TrafficRoutingMethodPerformance TrafficRoutingMethod = "Performance"
	TrafficRoutingMethodPriority    TrafficRoutingMethod = "Priority"
	TrafficRoutingMethodSubnet      TrafficRoutingMethod = "Subnet"
	TrafficRoutingMethodWeighted    TrafficRoutingMethod = "Weighted"
)

func (*TrafficRoutingMethod) UnmarshalJSON 

func (s *TrafficRoutingMethod) UnmarshalJSON(bytes []byte) error

type TrafficViewEnrollmentStatus 

type TrafficViewEnrollmentStatus string
const (
	TrafficViewEnrollmentStatusDisabled TrafficViewEnrollmentStatus = "Disabled"
	TrafficViewEnrollmentStatusEnabled  TrafficViewEnrollmentStatus = "Enabled"
)

func (*TrafficViewEnrollmentStatus) UnmarshalJSON 

func (s *TrafficViewEnrollmentStatus) UnmarshalJSON(bytes []byte) error

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Profile
}

Source Files

View all Source files

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.