privatelinkresources

package
v0.20230809.1081239 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 9, 2023 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2022-06-15/privatelinkresources Documentation

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

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/eventgrid/2022-06-15/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 := privatelinkresources.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

Constants

This section is empty.

Variables

This section is empty.

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 {
	Items []PrivateLinkResource
}

type ListByResourceOperationOptions

type ListByResourceOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByResourceOperationOptions

func DefaultListByResourceOperationOptions() ListByResourceOperationOptions

func (ListByResourceOperationOptions) ToHeaders

func (ListByResourceOperationOptions) ToOData

func (ListByResourceOperationOptions) ToQuery

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

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

Get ...

func (PrivateLinkResourcesClient) ListByResource

ListByResource ...

func (PrivateLinkResourcesClient) ListByResourceComplete

ListByResourceComplete retrieves all the results into a single object

func (PrivateLinkResourcesClient) ListByResourceCompleteMatchingPredicate

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) ID

ID returns the formatted Scoped Private Link Resource ID

func (ScopedPrivateLinkResourceId) Segments

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL