endpoints

README

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

The endpoints SDK allows for interaction with the Azure Resource Manager Service 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-sdk/resource-manager/trafficmanager/2022-04-01/endpoints"

Client Initialization

client := endpoints.NewEndpointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EndpointsClient.CreateOrUpdate

ctx := context.TODO()
id := endpoints.NewEndpointTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficManagerProfileValue", "AzureEndpoints", "endpointValue")

payload := endpoints.Endpoint{
	// ...
}


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: EndpointsClient.Delete

ctx := context.TODO()
id := endpoints.NewEndpointTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficManagerProfileValue", "AzureEndpoints", "endpointValue")

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: EndpointsClient.Get

ctx := context.TODO()
id := endpoints.NewEndpointTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficManagerProfileValue", "AzureEndpoints", "endpointValue")

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: EndpointsClient.Update

ctx := context.TODO()
id := endpoints.NewEndpointTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficManagerProfileValue", "AzureEndpoints", "endpointValue")

payload := endpoints.Endpoint{
	// ...
}


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

• func PossibleValuesForAlwaysServe() []string
• func PossibleValuesForEndpointMonitorStatus() []string
• func PossibleValuesForEndpointStatus() []string
• func PossibleValuesForEndpointType() []string
• func ValidateEndpointTypeID(input interface{}, key string) (warnings []string, errors []error)
• type AlwaysServe
  • func (s *AlwaysServe) UnmarshalJSON(bytes []byte) error
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type DeleteOperationResult
• type Endpoint
• type EndpointMonitorStatus
  • func (s *EndpointMonitorStatus) UnmarshalJSON(bytes []byte) error
• type EndpointProperties
• type EndpointPropertiesCustomHeadersInlined
• type EndpointPropertiesSubnetsInlined
• type EndpointStatus
  • func (s *EndpointStatus) UnmarshalJSON(bytes []byte) error
• type EndpointType
  • func (s *EndpointType) UnmarshalJSON(bytes []byte) error
• type EndpointTypeId
  • func NewEndpointTypeID(subscriptionId string, resourceGroupName string, ...) EndpointTypeId
  • func ParseEndpointTypeID(input string) (*EndpointTypeId, error)
  • func ParseEndpointTypeIDInsensitively(input string) (*EndpointTypeId, error)
  • func (id *EndpointTypeId) FromParseResult(input resourceids.ParseResult) error
  • func (id EndpointTypeId) ID() string
  • func (id EndpointTypeId) Segments() []resourceids.Segment
  • func (id EndpointTypeId) String() string
• type EndpointsClient
  • func NewEndpointsClientWithBaseURI(sdkApi sdkEnv.Api) (*EndpointsClient, error)
  • func (c EndpointsClient) CreateOrUpdate(ctx context.Context, id EndpointTypeId, input Endpoint) (result CreateOrUpdateOperationResponse, err error)
  • func (c EndpointsClient) Delete(ctx context.Context, id EndpointTypeId) (result DeleteOperationResponse, err error)
  • func (c EndpointsClient) Get(ctx context.Context, id EndpointTypeId) (result GetOperationResponse, err error)
  • func (c EndpointsClient) Update(ctx context.Context, id EndpointTypeId, input Endpoint) (result UpdateOperationResponse, err error)
• type GetOperationResponse
• type UpdateOperationResponse

Functions

func PossibleValuesForAlwaysServe

func PossibleValuesForAlwaysServe() []string

func PossibleValuesForEndpointMonitorStatus

func PossibleValuesForEndpointMonitorStatus() []string

func PossibleValuesForEndpointStatus

func PossibleValuesForEndpointStatus() []string

func PossibleValuesForEndpointType

func PossibleValuesForEndpointType() []string

func ValidateEndpointTypeID

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

ValidateEndpointTypeID checks that 'input' can be parsed as a Endpoint Type ID

Types

type AlwaysServe

type AlwaysServe string

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

func (*AlwaysServe) UnmarshalJSON

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

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type DeleteOperationResult

type DeleteOperationResult struct {
	Boolean *bool `json:"boolean,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 EndpointType

type EndpointType string

const (
	EndpointTypeAzureEndpoints    EndpointType = "AzureEndpoints"
	EndpointTypeExternalEndpoints EndpointType = "ExternalEndpoints"
	EndpointTypeNestedEndpoints   EndpointType = "NestedEndpoints"
)

func (*EndpointType) UnmarshalJSON

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

type EndpointTypeId

type EndpointTypeId struct {
	SubscriptionId            string
	ResourceGroupName         string
	TrafficManagerProfileName string
	EndpointType              EndpointType
	EndpointName              string
}

EndpointTypeId is a struct representing the Resource ID for a Endpoint Type

func NewEndpointTypeID

func NewEndpointTypeID(subscriptionId string, resourceGroupName string, trafficManagerProfileName string, endpointType EndpointType, endpointName string) EndpointTypeId

NewEndpointTypeID returns a new EndpointTypeId struct

func ParseEndpointTypeID

func ParseEndpointTypeID(input string) (*EndpointTypeId, error)

ParseEndpointTypeID parses 'input' into a EndpointTypeId

func ParseEndpointTypeIDInsensitively

func ParseEndpointTypeIDInsensitively(input string) (*EndpointTypeId, error)

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

func (*EndpointTypeId) FromParseResult

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

func (EndpointTypeId) ID

func (id EndpointTypeId) ID() string

ID returns the formatted Endpoint Type ID

func (EndpointTypeId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Endpoint Type ID

func (EndpointTypeId) String

func (id EndpointTypeId) String() string

String returns a human-readable description of this Endpoint Type ID

type EndpointsClient

type EndpointsClient struct {
	Client *resourcemanager.Client
}

func NewEndpointsClientWithBaseURI

func NewEndpointsClientWithBaseURI(sdkApi sdkEnv.Api) (*EndpointsClient, error)

func (EndpointsClient) CreateOrUpdate

func (c EndpointsClient) CreateOrUpdate(ctx context.Context, id EndpointTypeId, input Endpoint) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (EndpointsClient) Delete

func (c EndpointsClient) Delete(ctx context.Context, id EndpointTypeId) (result DeleteOperationResponse, err error)

Delete ...

func (EndpointsClient) Get

func (c EndpointsClient) Get(ctx context.Context, id EndpointTypeId) (result GetOperationResponse, err error)

Get ...

func (EndpointsClient) Update

func (c EndpointsClient) Update(ctx context.Context, id EndpointTypeId, input Endpoint) (result UpdateOperationResponse, err error)

Update ...

type GetOperationResponse

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

type UpdateOperationResponse

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