privatelinkscopedresources

package
v0.20241128.1112539 Latest Latest
Warning

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

 Go to latest Published: Nov 28, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/insights/2021-07-01-preview/privatelinkscopedresources Documentation

The privatelinkscopedresources SDK allows for interaction with Azure Resource Manager insights (API Version 2021-07-01-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-sdk/resource-manager/insights/2021-07-01-preview/privatelinkscopedresources"

Client Initialization

client := privatelinkscopedresources.NewPrivateLinkScopedResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkScopedResourcesClient.CreateOrUpdate

ctx := context.TODO()
id := privatelinkscopedresources.NewScopedResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeName", "scopedResourceName")

payload := privatelinkscopedresources.ScopedResource{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: PrivateLinkScopedResourcesClient.Delete

ctx := context.TODO()
id := privatelinkscopedresources.NewScopedResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeName", "scopedResourceName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PrivateLinkScopedResourcesClient.Get

ctx := context.TODO()
id := privatelinkscopedresources.NewScopedResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeName", "scopedResourceName")

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: PrivateLinkScopedResourcesClient.ListByPrivateLinkScope

ctx := context.TODO()
id := privatelinkscopedresources.NewPrivateLinkScopeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateLinkScopeName")

// alternatively `client.ListByPrivateLinkScope(ctx, id)` can be used to do batched pagination
items, err := client.ListByPrivateLinkScopeComplete(ctx, id)
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 ValidatePrivateLinkScopeID 

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

ValidatePrivateLinkScopeID checks that 'input' can be parsed as a Private Link Scope ID

func ValidateScopedResourceID 

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

ValidateScopedResourceID checks that 'input' can be parsed as a Scoped Resource ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ScopedResource
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

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

type ListByPrivateLinkScopeCompleteResult 

type ListByPrivateLinkScopeCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ScopedResource
}

type ListByPrivateLinkScopeCustomPager added in v0.20240628.1153531 

type ListByPrivateLinkScopeCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByPrivateLinkScopeCustomPager) NextPageLink() *odata.Link

type ListByPrivateLinkScopeOperationResponse 

type ListByPrivateLinkScopeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ScopedResource
}

type PrivateLinkScopeId 

type PrivateLinkScopeId struct {
	SubscriptionId       string
	ResourceGroupName    string
	PrivateLinkScopeName string
}

PrivateLinkScopeId is a struct representing the Resource ID for a Private Link Scope

func NewPrivateLinkScopeID 

func NewPrivateLinkScopeID(subscriptionId string, resourceGroupName string, privateLinkScopeName string) PrivateLinkScopeId

NewPrivateLinkScopeID returns a new PrivateLinkScopeId struct

func ParsePrivateLinkScopeID 

func ParsePrivateLinkScopeID(input string) (*PrivateLinkScopeId, error)

ParsePrivateLinkScopeID parses 'input' into a PrivateLinkScopeId

func ParsePrivateLinkScopeIDInsensitively 

func ParsePrivateLinkScopeIDInsensitively(input string) (*PrivateLinkScopeId, error)

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

func (*PrivateLinkScopeId) FromParseResult 

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

func (PrivateLinkScopeId) ID 

func (id PrivateLinkScopeId) ID() string

ID returns the formatted Private Link Scope ID

func (PrivateLinkScopeId) Segments 

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

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

func (PrivateLinkScopeId) String 

func (id PrivateLinkScopeId) String() string

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

type PrivateLinkScopedResourcesClient 

type PrivateLinkScopedResourcesClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkScopedResourcesClientWithBaseURI 

func NewPrivateLinkScopedResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkScopedResourcesClient, error)

func (PrivateLinkScopedResourcesClient) CreateOrUpdate 

func (c PrivateLinkScopedResourcesClient) CreateOrUpdate(ctx context.Context, id ScopedResourceId, input ScopedResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PrivateLinkScopedResourcesClient) CreateOrUpdateThenPoll 

func (c PrivateLinkScopedResourcesClient) CreateOrUpdateThenPoll(ctx context.Context, id ScopedResourceId, input ScopedResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PrivateLinkScopedResourcesClient) Delete 

func (c PrivateLinkScopedResourcesClient) Delete(ctx context.Context, id ScopedResourceId) (result DeleteOperationResponse, err error)

Delete ...

func (PrivateLinkScopedResourcesClient) DeleteThenPoll 

func (c PrivateLinkScopedResourcesClient) DeleteThenPoll(ctx context.Context, id ScopedResourceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PrivateLinkScopedResourcesClient) Get 

func (c PrivateLinkScopedResourcesClient) Get(ctx context.Context, id ScopedResourceId) (result GetOperationResponse, err error)

Get ...

func (PrivateLinkScopedResourcesClient) ListByPrivateLinkScope 

func (c PrivateLinkScopedResourcesClient) ListByPrivateLinkScope(ctx context.Context, id PrivateLinkScopeId) (result ListByPrivateLinkScopeOperationResponse, err error)

ListByPrivateLinkScope ...

func (PrivateLinkScopedResourcesClient) ListByPrivateLinkScopeComplete 

func (c PrivateLinkScopedResourcesClient) ListByPrivateLinkScopeComplete(ctx context.Context, id PrivateLinkScopeId) (ListByPrivateLinkScopeCompleteResult, error)

ListByPrivateLinkScopeComplete retrieves all the results into a single object

func (PrivateLinkScopedResourcesClient) ListByPrivateLinkScopeCompleteMatchingPredicate 

func (c PrivateLinkScopedResourcesClient) ListByPrivateLinkScopeCompleteMatchingPredicate(ctx context.Context, id PrivateLinkScopeId, predicate ScopedResourceOperationPredicate) (result ListByPrivateLinkScopeCompleteResult, err error)

ListByPrivateLinkScopeCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ScopedResource 

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

type ScopedResourceId 

type ScopedResourceId struct {
	SubscriptionId       string
	ResourceGroupName    string
	PrivateLinkScopeName string
	ScopedResourceName   string
}

ScopedResourceId is a struct representing the Resource ID for a Scoped Resource

func NewScopedResourceID 

func NewScopedResourceID(subscriptionId string, resourceGroupName string, privateLinkScopeName string, scopedResourceName string) ScopedResourceId

NewScopedResourceID returns a new ScopedResourceId struct

func ParseScopedResourceID 

func ParseScopedResourceID(input string) (*ScopedResourceId, error)

ParseScopedResourceID parses 'input' into a ScopedResourceId

func ParseScopedResourceIDInsensitively 

func ParseScopedResourceIDInsensitively(input string) (*ScopedResourceId, error)

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

func (*ScopedResourceId) FromParseResult 

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

func (ScopedResourceId) ID 

func (id ScopedResourceId) ID() string

ID returns the formatted Scoped Resource ID

func (ScopedResourceId) Segments 

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

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

func (ScopedResourceId) String 

func (id ScopedResourceId) String() string

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

type ScopedResourceOperationPredicate 

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

func (ScopedResourceOperationPredicate) Matches 

func (p ScopedResourceOperationPredicate) Matches(input ScopedResource) bool

type ScopedResourceProperties 

type ScopedResourceProperties struct {
	LinkedResourceId  *string `json:"linkedResourceId,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.