privatelinks

README

github.com/hashicorp/go-azure-sdk/resource-manager/mongocluster/2024-07-01/privatelinks Documentation

The privatelinks SDK allows for interaction with Azure Resource Manager mongocluster (API Version 2024-07-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/mongocluster/2024-07-01/privatelinks"

Client Initialization

client := privatelinks.NewPrivateLinksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinksClient.ListByMongoCluster

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

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

Documentation

Index

• func ValidateMongoClusterID(input interface{}, key string) (warnings []string, errors []error)
• type ListByMongoClusterCompleteResult
• type ListByMongoClusterCustomPager
  • func (p *ListByMongoClusterCustomPager) NextPageLink() *odata.Link
• type ListByMongoClusterOperationResponse
• type MongoClusterId
  • func NewMongoClusterID(subscriptionId string, resourceGroupName string, mongoClusterName string) MongoClusterId
  • func ParseMongoClusterID(input string) (*MongoClusterId, error)
  • func ParseMongoClusterIDInsensitively(input string) (*MongoClusterId, error)
  • func (id *MongoClusterId) FromParseResult(input resourceids.ParseResult) error
  • func (id MongoClusterId) ID() string
  • func (id MongoClusterId) Segments() []resourceids.Segment
  • func (id MongoClusterId) String() string
• type PrivateLinkResource
• type PrivateLinkResourceOperationPredicate
  • func (p PrivateLinkResourceOperationPredicate) Matches(input PrivateLinkResource) bool
• type PrivateLinkResourceProperties
• type PrivateLinksClient
  • func NewPrivateLinksClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinksClient, error)
  • func (c PrivateLinksClient) ListByMongoCluster(ctx context.Context, id MongoClusterId) (result ListByMongoClusterOperationResponse, err error)
  • func (c PrivateLinksClient) ListByMongoClusterComplete(ctx context.Context, id MongoClusterId) (ListByMongoClusterCompleteResult, error)
  • func (c PrivateLinksClient) ListByMongoClusterCompleteMatchingPredicate(ctx context.Context, id MongoClusterId, ...) (result ListByMongoClusterCompleteResult, err error)

Functions

func ValidateMongoClusterID

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

ValidateMongoClusterID checks that 'input' can be parsed as a Mongo Cluster ID

Types

type ListByMongoClusterCompleteResult

type ListByMongoClusterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateLinkResource
}

type ListByMongoClusterCustomPager

type ListByMongoClusterCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByMongoClusterCustomPager) NextPageLink

func (p *ListByMongoClusterCustomPager) NextPageLink() *odata.Link

type ListByMongoClusterOperationResponse

type ListByMongoClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateLinkResource
}

type MongoClusterId

type MongoClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	MongoClusterName  string
}

MongoClusterId is a struct representing the Resource ID for a Mongo Cluster

func NewMongoClusterID

func NewMongoClusterID(subscriptionId string, resourceGroupName string, mongoClusterName string) MongoClusterId

NewMongoClusterID returns a new MongoClusterId struct

func ParseMongoClusterID

func ParseMongoClusterID(input string) (*MongoClusterId, error)

ParseMongoClusterID parses 'input' into a MongoClusterId

func ParseMongoClusterIDInsensitively

func ParseMongoClusterIDInsensitively(input string) (*MongoClusterId, error)

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

func (*MongoClusterId) FromParseResult

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

func (MongoClusterId) ID

func (id MongoClusterId) ID() string

ID returns the formatted Mongo Cluster ID

func (MongoClusterId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Mongo Cluster ID

func (MongoClusterId) String

func (id MongoClusterId) String() string

String returns a human-readable description of this Mongo Cluster ID

type PrivateLinkResource

type PrivateLinkResource struct {
	Id         *string                        `json:"id,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData         `json:"systemData,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type PrivateLinkResourceOperationPredicate

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

func (PrivateLinkResourceOperationPredicate) Matches

func (p PrivateLinkResourceOperationPredicate) Matches(input PrivateLinkResource) bool

type PrivateLinkResourceProperties

type PrivateLinkResourceProperties struct {
	GroupId           *string   `json:"groupId,omitempty"`
	RequiredMembers   *[]string `json:"requiredMembers,omitempty"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type PrivateLinksClient

type PrivateLinksClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinksClientWithBaseURI

func NewPrivateLinksClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinksClient, error)

func (PrivateLinksClient) ListByMongoCluster

func (c PrivateLinksClient) ListByMongoCluster(ctx context.Context, id MongoClusterId) (result ListByMongoClusterOperationResponse, err error)

ListByMongoCluster ...

func (PrivateLinksClient) ListByMongoClusterComplete

func (c PrivateLinksClient) ListByMongoClusterComplete(ctx context.Context, id MongoClusterId) (ListByMongoClusterCompleteResult, error)

ListByMongoClusterComplete retrieves all the results into a single object

func (PrivateLinksClient) ListByMongoClusterCompleteMatchingPredicate

func (c PrivateLinksClient) ListByMongoClusterCompleteMatchingPredicate(ctx context.Context, id MongoClusterId, predicate PrivateLinkResourceOperationPredicate) (result ListByMongoClusterCompleteResult, err error)

ListByMongoClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate