endpointservices

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-11-01/endpointservices Documentation

The endpointservices SDK allows for interaction with the Azure Resource Manager Service network (API Version 2023-11-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/network/2023-11-01/endpointservices"

Client Initialization

client := endpointservices.NewEndpointServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EndpointServicesClient.AvailableEndpointServicesList

ctx := context.TODO()
id := endpointservices.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

// alternatively `client.AvailableEndpointServicesList(ctx, id)` can be used to do batched pagination
items, err := client.AvailableEndpointServicesListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type AvailableEndpointServicesListCompleteResult
• type AvailableEndpointServicesListOperationResponse
• type EndpointServiceResult
• type EndpointServiceResultOperationPredicate
  • func (p EndpointServiceResultOperationPredicate) Matches(input EndpointServiceResult) bool
• type EndpointServicesClient
  • func NewEndpointServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*EndpointServicesClient, error)
  • func (c EndpointServicesClient) AvailableEndpointServicesList(ctx context.Context, id LocationId) (result AvailableEndpointServicesListOperationResponse, err error)
  • func (c EndpointServicesClient) AvailableEndpointServicesListComplete(ctx context.Context, id LocationId) (AvailableEndpointServicesListCompleteResult, error)
  • func (c EndpointServicesClient) AvailableEndpointServicesListCompleteMatchingPredicate(ctx context.Context, id LocationId, ...) (result AvailableEndpointServicesListCompleteResult, err error)
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string

Functions

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type AvailableEndpointServicesListCompleteResult

type AvailableEndpointServicesListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []EndpointServiceResult
}

type AvailableEndpointServicesListOperationResponse

type AvailableEndpointServicesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EndpointServiceResult
}

type EndpointServiceResult

type EndpointServiceResult struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type EndpointServiceResultOperationPredicate

type EndpointServiceResultOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (EndpointServiceResultOperationPredicate) Matches

func (p EndpointServiceResultOperationPredicate) Matches(input EndpointServiceResult) bool

type EndpointServicesClient

type EndpointServicesClient struct {
	Client *resourcemanager.Client
}

func NewEndpointServicesClientWithBaseURI

func NewEndpointServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*EndpointServicesClient, error)

func (EndpointServicesClient) AvailableEndpointServicesList

func (c EndpointServicesClient) AvailableEndpointServicesList(ctx context.Context, id LocationId) (result AvailableEndpointServicesListOperationResponse, err error)

AvailableEndpointServicesList ...

func (EndpointServicesClient) AvailableEndpointServicesListComplete

func (c EndpointServicesClient) AvailableEndpointServicesListComplete(ctx context.Context, id LocationId) (AvailableEndpointServicesListCompleteResult, error)

AvailableEndpointServicesListComplete retrieves all the results into a single object

func (EndpointServicesClient) AvailableEndpointServicesListCompleteMatchingPredicate

func (c EndpointServicesClient) AvailableEndpointServicesListCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate EndpointServiceResultOperationPredicate) (result AvailableEndpointServicesListCompleteResult, err error)

AvailableEndpointServicesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID