privatelinkresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2023-12-15-preview/privatelinkresources Documentation

The privatelinkresources SDK allows for interaction with the Azure Resource Manager Service eventgrid (API Version 2023-12-15-preview).

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/eventgrid/2023-12-15-preview/privatelinkresources"

Client Initialization

client := privatelinkresources.NewPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkResourcesClient.Get

ctx := context.TODO()
id := privatelinkresources.NewScopedPrivateLinkResourceID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "privateLinkResourceValue")

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: PrivateLinkResourcesClient.ListByResource

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Documentation

Index

• func ValidateScopedPrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListByResourceCompleteResult
• type ListByResourceOperationOptions
  • func DefaultListByResourceOperationOptions() ListByResourceOperationOptions
  • func (o ListByResourceOperationOptions) ToHeaders() *client.Headers
  • func (o ListByResourceOperationOptions) ToOData() *odata.Query
  • func (o ListByResourceOperationOptions) ToQuery() *client.QueryParams
• type ListByResourceOperationResponse
• type PrivateLinkResource
• type PrivateLinkResourceOperationPredicate
  • func (p PrivateLinkResourceOperationPredicate) Matches(input PrivateLinkResource) bool
• type PrivateLinkResourceProperties
• type PrivateLinkResourcesClient
  • func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)
  • func (c PrivateLinkResourcesClient) Get(ctx context.Context, id ScopedPrivateLinkResourceId) (result GetOperationResponse, err error)
  • func (c PrivateLinkResourcesClient) ListByResource(ctx context.Context, id commonids.ScopeId, ...) (result ListByResourceOperationResponse, err error)
  • func (c PrivateLinkResourcesClient) ListByResourceComplete(ctx context.Context, id commonids.ScopeId, ...) (ListByResourceCompleteResult, error)
  • func (c PrivateLinkResourcesClient) ListByResourceCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, ...) (result ListByResourceCompleteResult, err error)
• type ScopedPrivateLinkResourceId
  • func NewScopedPrivateLinkResourceID(scope string, privateLinkResourceName string) ScopedPrivateLinkResourceId
  • func ParseScopedPrivateLinkResourceID(input string) (*ScopedPrivateLinkResourceId, error)
  • func ParseScopedPrivateLinkResourceIDInsensitively(input string) (*ScopedPrivateLinkResourceId, error)
  • func (id *ScopedPrivateLinkResourceId) FromParseResult(input resourceids.ParseResult) error
  • func (id ScopedPrivateLinkResourceId) ID() string
  • func (id ScopedPrivateLinkResourceId) Segments() []resourceids.Segment
  • func (id ScopedPrivateLinkResourceId) String() string

Functions

func ValidateScopedPrivateLinkResourceID

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

ValidateScopedPrivateLinkResourceID checks that 'input' can be parsed as a Scoped Private Link Resource ID

Types

type GetOperationResponse

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

type ListByResourceCompleteResult

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

type ListByResourceOperationOptions

type ListByResourceOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByResourceOperationOptions

func DefaultListByResourceOperationOptions() ListByResourceOperationOptions

func (ListByResourceOperationOptions) ToHeaders

func (o ListByResourceOperationOptions) ToHeaders() *client.Headers

func (ListByResourceOperationOptions) ToOData

func (o ListByResourceOperationOptions) ToOData() *odata.Query

func (ListByResourceOperationOptions) ToQuery

func (o ListByResourceOperationOptions) ToQuery() *client.QueryParams

type ListByResourceOperationResponse

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

type PrivateLinkResource

type PrivateLinkResource struct {
	Id         *string                        `json:"id,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *PrivateLinkResourceProperties `json:"properties,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 {
	DisplayName       *string   `json:"displayName,omitempty"`
	GroupId           *string   `json:"groupId,omitempty"`
	RequiredMembers   *[]string `json:"requiredMembers,omitempty"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkResourcesClientWithBaseURI

func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)

func (PrivateLinkResourcesClient) Get

func (c PrivateLinkResourcesClient) Get(ctx context.Context, id ScopedPrivateLinkResourceId) (result GetOperationResponse, err error)

Get ...

func (PrivateLinkResourcesClient) ListByResource

func (c PrivateLinkResourcesClient) ListByResource(ctx context.Context, id commonids.ScopeId, options ListByResourceOperationOptions) (result ListByResourceOperationResponse, err error)

ListByResource ...

func (PrivateLinkResourcesClient) ListByResourceComplete

func (c PrivateLinkResourcesClient) ListByResourceComplete(ctx context.Context, id commonids.ScopeId, options ListByResourceOperationOptions) (ListByResourceCompleteResult, error)

ListByResourceComplete retrieves all the results into a single object

func (PrivateLinkResourcesClient) ListByResourceCompleteMatchingPredicate

func (c PrivateLinkResourcesClient) ListByResourceCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ListByResourceOperationOptions, predicate PrivateLinkResourceOperationPredicate) (result ListByResourceCompleteResult, err error)

ListByResourceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ScopedPrivateLinkResourceId

type ScopedPrivateLinkResourceId struct {
	Scope                   string
	PrivateLinkResourceName string
}

ScopedPrivateLinkResourceId is a struct representing the Resource ID for a Scoped Private Link Resource

func NewScopedPrivateLinkResourceID

func NewScopedPrivateLinkResourceID(scope string, privateLinkResourceName string) ScopedPrivateLinkResourceId

NewScopedPrivateLinkResourceID returns a new ScopedPrivateLinkResourceId struct

func ParseScopedPrivateLinkResourceID

func ParseScopedPrivateLinkResourceID(input string) (*ScopedPrivateLinkResourceId, error)

ParseScopedPrivateLinkResourceID parses 'input' into a ScopedPrivateLinkResourceId

func ParseScopedPrivateLinkResourceIDInsensitively

func ParseScopedPrivateLinkResourceIDInsensitively(input string) (*ScopedPrivateLinkResourceId, error)

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

func (*ScopedPrivateLinkResourceId) FromParseResult

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

func (ScopedPrivateLinkResourceId) ID

func (id ScopedPrivateLinkResourceId) ID() string

ID returns the formatted Scoped Private Link Resource ID

func (ScopedPrivateLinkResourceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Scoped Private Link Resource ID

func (ScopedPrivateLinkResourceId) String

func (id ScopedPrivateLinkResourceId) String() string

String returns a human-readable description of this Scoped Private Link Resource ID