outboundnetworkdependenciesendpoints

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/outboundnetworkdependenciesendpoints Documentation

The outboundnetworkdependenciesendpoints SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2022-08-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/apimanagement/2022-08-01/outboundnetworkdependenciesendpoints"

Client Initialization

client := outboundnetworkdependenciesendpoints.NewOutboundNetworkDependenciesEndpointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OutboundNetworkDependenciesEndpointsClient.ListByService

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

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

Documentation

Index

• func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
• type EndpointDependency
• type EndpointDetail
• type ListByServiceOperationResponse
• type OutboundEnvironmentEndpoint
• type OutboundEnvironmentEndpointList
• type OutboundNetworkDependenciesEndpointsClient
  • func NewOutboundNetworkDependenciesEndpointsClientWithBaseURI(sdkApi sdkEnv.Api) (*OutboundNetworkDependenciesEndpointsClient, error)
  • func (c OutboundNetworkDependenciesEndpointsClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)
• type ServiceId
  • func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId
  • func ParseServiceID(input string) (*ServiceId, error)
  • func ParseServiceIDInsensitively(input string) (*ServiceId, error)
  • func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error
  • func (id ServiceId) ID() string
  • func (id ServiceId) Segments() []resourceids.Segment
  • func (id ServiceId) String() string

Functions

func ValidateServiceID

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

Types

type EndpointDependency

type EndpointDependency struct {
	DomainName      *string           `json:"domainName,omitempty"`
	EndpointDetails *[]EndpointDetail `json:"endpointDetails,omitempty"`
}

type EndpointDetail

type EndpointDetail struct {
	Port   *int64  `json:"port,omitempty"`
	Region *string `json:"region,omitempty"`
}

type ListByServiceOperationResponse

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OutboundEnvironmentEndpointList
}

type OutboundEnvironmentEndpoint

type OutboundEnvironmentEndpoint struct {
	Category  *string               `json:"category,omitempty"`
	Endpoints *[]EndpointDependency `json:"endpoints,omitempty"`
}

type OutboundEnvironmentEndpointList

type OutboundEnvironmentEndpointList struct {
	NextLink *string                       `json:"nextLink,omitempty"`
	Value    []OutboundEnvironmentEndpoint `json:"value"`
}

type OutboundNetworkDependenciesEndpointsClient

type OutboundNetworkDependenciesEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewOutboundNetworkDependenciesEndpointsClientWithBaseURI

func NewOutboundNetworkDependenciesEndpointsClientWithBaseURI(sdkApi sdkEnv.Api) (*OutboundNetworkDependenciesEndpointsClient, error)

func (OutboundNetworkDependenciesEndpointsClient) ListByService

func (c OutboundNetworkDependenciesEndpointsClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)

ListByService ...

type ServiceId

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (*ServiceId) FromParseResult

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

func (ServiceId) ID

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments

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

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

func (ServiceId) String

func (id ServiceId) String() string

String returns a human-readable description of this Service ID