privatelinkscopesapis

package
v0.20241126.2320 Latest Latest
Warning

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

Go to latest
Published: Nov 26, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

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

The privatelinkscopesapis 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/insights/2021-07-01-preview/privatelinkscopesapis"

Client Initialization

client := privatelinkscopesapis.NewPrivateLinkScopesAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkScopesAPIsClient.PrivateLinkScopesCreateOrUpdate

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

payload := privatelinkscopesapis.AzureMonitorPrivateLinkScope{
	// ...
}


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

Example Usage: PrivateLinkScopesAPIsClient.PrivateLinkScopesDelete

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

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

Example Usage: PrivateLinkScopesAPIsClient.PrivateLinkScopesGet

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

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

Example Usage: PrivateLinkScopesAPIsClient.PrivateLinkScopesList

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: PrivateLinkScopesAPIsClient.PrivateLinkScopesListByResourceGroup

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

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

Example Usage: PrivateLinkScopesAPIsClient.PrivateLinkScopesUpdateTags

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

payload := privatelinkscopesapis.TagsResource{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccessMode

func PossibleValuesForAccessMode() []string

func PossibleValuesForPrivateEndpointConnectionProvisioningState

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateEndpointServiceConnectionStatus

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

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

Types

type AccessMode

type AccessMode string
const (
	AccessModeOpen        AccessMode = "Open"
	AccessModePrivateOnly AccessMode = "PrivateOnly"
)

func (*AccessMode) UnmarshalJSON

func (s *AccessMode) UnmarshalJSON(bytes []byte) error

type AccessModeSettings

type AccessModeSettings struct {
	Exclusions          *[]AccessModeSettingsExclusion `json:"exclusions,omitempty"`
	IngestionAccessMode AccessMode                     `json:"ingestionAccessMode"`
	QueryAccessMode     AccessMode                     `json:"queryAccessMode"`
}

type AccessModeSettingsExclusion

type AccessModeSettingsExclusion struct {
	IngestionAccessMode           *AccessMode `json:"ingestionAccessMode,omitempty"`
	PrivateEndpointConnectionName *string     `json:"privateEndpointConnectionName,omitempty"`
	QueryAccessMode               *AccessMode `json:"queryAccessMode,omitempty"`
}

type AzureMonitorPrivateLinkScope

type AzureMonitorPrivateLinkScope struct {
	Id         *string                                `json:"id,omitempty"`
	Location   string                                 `json:"location"`
	Name       *string                                `json:"name,omitempty"`
	Properties AzureMonitorPrivateLinkScopeProperties `json:"properties"`
	SystemData *systemdata.SystemData                 `json:"systemData,omitempty"`
	Tags       *map[string]string                     `json:"tags,omitempty"`
	Type       *string                                `json:"type,omitempty"`
}

type AzureMonitorPrivateLinkScopeOperationPredicate

type AzureMonitorPrivateLinkScopeOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (AzureMonitorPrivateLinkScopeOperationPredicate) Matches

type AzureMonitorPrivateLinkScopeProperties

type AzureMonitorPrivateLinkScopeProperties struct {
	AccessModeSettings         AccessModeSettings           `json:"accessModeSettings"`
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *string                      `json:"provisioningState,omitempty"`
}

type PrivateEndpoint

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpoint                            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState           `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState

type PrivateEndpointConnectionProvisioningState string
const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON

func (s *PrivateEndpointConnectionProvisioningState) UnmarshalJSON(bytes []byte) error

type PrivateEndpointServiceConnectionStatus

type PrivateEndpointServiceConnectionStatus string
const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON

func (s *PrivateEndpointServiceConnectionStatus) UnmarshalJSON(bytes []byte) error

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 PrivateLinkScopesAPIsClient

type PrivateLinkScopesAPIsClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkScopesAPIsClientWithBaseURI

func NewPrivateLinkScopesAPIsClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkScopesAPIsClient, error)

func (PrivateLinkScopesAPIsClient) PrivateLinkScopesCreateOrUpdate

PrivateLinkScopesCreateOrUpdate ...

func (PrivateLinkScopesAPIsClient) PrivateLinkScopesDelete

PrivateLinkScopesDelete ...

func (PrivateLinkScopesAPIsClient) PrivateLinkScopesDeleteThenPoll

func (c PrivateLinkScopesAPIsClient) PrivateLinkScopesDeleteThenPoll(ctx context.Context, id PrivateLinkScopeId) error

PrivateLinkScopesDeleteThenPoll performs PrivateLinkScopesDelete then polls until it's completed

func (PrivateLinkScopesAPIsClient) PrivateLinkScopesGet

PrivateLinkScopesGet ...

func (PrivateLinkScopesAPIsClient) PrivateLinkScopesList

PrivateLinkScopesList ...

func (PrivateLinkScopesAPIsClient) PrivateLinkScopesListByResourceGroup

PrivateLinkScopesListByResourceGroup ...

func (PrivateLinkScopesAPIsClient) PrivateLinkScopesListByResourceGroupComplete

PrivateLinkScopesListByResourceGroupComplete retrieves all the results into a single object

func (PrivateLinkScopesAPIsClient) PrivateLinkScopesListByResourceGroupCompleteMatchingPredicate

func (c PrivateLinkScopesAPIsClient) PrivateLinkScopesListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate AzureMonitorPrivateLinkScopeOperationPredicate) (result PrivateLinkScopesListByResourceGroupCompleteResult, err error)

PrivateLinkScopesListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateLinkScopesAPIsClient) PrivateLinkScopesListComplete

PrivateLinkScopesListComplete retrieves all the results into a single object

func (PrivateLinkScopesAPIsClient) PrivateLinkScopesListCompleteMatchingPredicate

PrivateLinkScopesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PrivateLinkScopesAPIsClient) PrivateLinkScopesUpdateTags

PrivateLinkScopesUpdateTags ...

type PrivateLinkScopesCreateOrUpdateOperationResponse

type PrivateLinkScopesCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AzureMonitorPrivateLinkScope
}

type PrivateLinkScopesDeleteOperationResponse

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

type PrivateLinkScopesGetOperationResponse

type PrivateLinkScopesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AzureMonitorPrivateLinkScope
}

type PrivateLinkScopesListByResourceGroupCompleteResult

type PrivateLinkScopesListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AzureMonitorPrivateLinkScope
}

type PrivateLinkScopesListByResourceGroupCustomPager

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

type PrivateLinkScopesListByResourceGroupOperationResponse

type PrivateLinkScopesListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AzureMonitorPrivateLinkScope
}

type PrivateLinkScopesListCompleteResult

type PrivateLinkScopesListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AzureMonitorPrivateLinkScope
}

type PrivateLinkScopesListCustomPager

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

type PrivateLinkScopesListOperationResponse

type PrivateLinkScopesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AzureMonitorPrivateLinkScope
}

type PrivateLinkScopesUpdateTagsOperationResponse

type PrivateLinkScopesUpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AzureMonitorPrivateLinkScope
}

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string                                 `json:"actionsRequired,omitempty"`
	Description     *string                                 `json:"description,omitempty"`
	Status          *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

type TagsResource

type TagsResource struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

Jump to

Keyboard shortcuts

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