managedprivateendpoints

package
v0.20240123.1101251 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/dashboard/2023-09-01/managedprivateendpoints Documentation

The managedprivateendpoints SDK allows for interaction with the Azure Resource Manager Service dashboard (API Version 2023-09-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/dashboard/2023-09-01/managedprivateendpoints"

Client Initialization

client := managedprivateendpoints.NewManagedPrivateEndpointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedPrivateEndpointsClient.Create

ctx := context.TODO()
id := managedprivateendpoints.NewManagedPrivateEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaValue", "managedPrivateEndpointValue")

payload := managedprivateendpoints.ManagedPrivateEndpointModel{
	// ...
}


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

Example Usage: ManagedPrivateEndpointsClient.Delete

ctx := context.TODO()
id := managedprivateendpoints.NewManagedPrivateEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaValue", "managedPrivateEndpointValue")

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

Example Usage: ManagedPrivateEndpointsClient.Get

ctx := context.TODO()
id := managedprivateendpoints.NewManagedPrivateEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaValue", "managedPrivateEndpointValue")

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: ManagedPrivateEndpointsClient.List

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

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

Example Usage: ManagedPrivateEndpointsClient.Refresh

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

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

Example Usage: ManagedPrivateEndpointsClient.Update

ctx := context.TODO()
id := managedprivateendpoints.NewManagedPrivateEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "grafanaValue", "managedPrivateEndpointValue")

payload := managedprivateendpoints.ManagedPrivateEndpointUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForManagedPrivateEndpointConnectionStatus 

func PossibleValuesForManagedPrivateEndpointConnectionStatus() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateGrafanaID 

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

ValidateGrafanaID checks that 'input' can be parsed as a Grafana ID

func ValidateManagedPrivateEndpointID 

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

ValidateManagedPrivateEndpointID checks that 'input' can be parsed as a Managed Private Endpoint ID

Types

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedPrivateEndpointModel
}

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        *ManagedPrivateEndpointModel
}

type GrafanaId 

type GrafanaId struct {
	SubscriptionId    string
	ResourceGroupName string
	GrafanaName       string
}

GrafanaId is a struct representing the Resource ID for a Grafana

func NewGrafanaID 

func NewGrafanaID(subscriptionId string, resourceGroupName string, grafanaName string) GrafanaId

NewGrafanaID returns a new GrafanaId struct

func ParseGrafanaID 

func ParseGrafanaID(input string) (*GrafanaId, error)

ParseGrafanaID parses 'input' into a GrafanaId

func ParseGrafanaIDInsensitively 

func ParseGrafanaIDInsensitively(input string) (*GrafanaId, error)

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

func (*GrafanaId) FromParseResult added in v0.20231127.1171502 

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

func (GrafanaId) ID 

func (id GrafanaId) ID() string

ID returns the formatted Grafana ID

func (GrafanaId) Segments 

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

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

func (GrafanaId) String 

func (id GrafanaId) String() string

String returns a human-readable description of this Grafana ID

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ManagedPrivateEndpointModel
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedPrivateEndpointModel
}

type ManagedPrivateEndpointConnectionState 

type ManagedPrivateEndpointConnectionState struct {
	Description *string                                 `json:"description,omitempty"`
	Status      *ManagedPrivateEndpointConnectionStatus `json:"status,omitempty"`
}

type ManagedPrivateEndpointConnectionStatus 

type ManagedPrivateEndpointConnectionStatus string
const (
	ManagedPrivateEndpointConnectionStatusApproved     ManagedPrivateEndpointConnectionStatus = "Approved"
	ManagedPrivateEndpointConnectionStatusDisconnected ManagedPrivateEndpointConnectionStatus = "Disconnected"
	ManagedPrivateEndpointConnectionStatusPending      ManagedPrivateEndpointConnectionStatus = "Pending"
	ManagedPrivateEndpointConnectionStatusRejected     ManagedPrivateEndpointConnectionStatus = "Rejected"
)

func (*ManagedPrivateEndpointConnectionStatus) UnmarshalJSON 

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

type ManagedPrivateEndpointId 

type ManagedPrivateEndpointId struct {
	SubscriptionId             string
	ResourceGroupName          string
	GrafanaName                string
	ManagedPrivateEndpointName string
}

ManagedPrivateEndpointId is a struct representing the Resource ID for a Managed Private Endpoint

func NewManagedPrivateEndpointID 

func NewManagedPrivateEndpointID(subscriptionId string, resourceGroupName string, grafanaName string, managedPrivateEndpointName string) ManagedPrivateEndpointId

NewManagedPrivateEndpointID returns a new ManagedPrivateEndpointId struct

func ParseManagedPrivateEndpointID 

func ParseManagedPrivateEndpointID(input string) (*ManagedPrivateEndpointId, error)

ParseManagedPrivateEndpointID parses 'input' into a ManagedPrivateEndpointId

func ParseManagedPrivateEndpointIDInsensitively 

func ParseManagedPrivateEndpointIDInsensitively(input string) (*ManagedPrivateEndpointId, error)

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

func (*ManagedPrivateEndpointId) FromParseResult added in v0.20231127.1171502 

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

func (ManagedPrivateEndpointId) ID 

func (id ManagedPrivateEndpointId) ID() string

ID returns the formatted Managed Private Endpoint ID

func (ManagedPrivateEndpointId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Managed Private Endpoint ID

func (ManagedPrivateEndpointId) String 

func (id ManagedPrivateEndpointId) String() string

String returns a human-readable description of this Managed Private Endpoint ID

type ManagedPrivateEndpointModel 

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

type ManagedPrivateEndpointModelOperationPredicate 

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

func (ManagedPrivateEndpointModelOperationPredicate) Matches 

func (p ManagedPrivateEndpointModelOperationPredicate) Matches(input ManagedPrivateEndpointModel) bool

type ManagedPrivateEndpointModelProperties 

type ManagedPrivateEndpointModelProperties struct {
	ConnectionState             *ManagedPrivateEndpointConnectionState `json:"connectionState,omitempty"`
	GroupIds                    *[]string                              `json:"groupIds,omitempty"`
	PrivateLinkResourceId       *string                                `json:"privateLinkResourceId,omitempty"`
	PrivateLinkResourceRegion   *string                                `json:"privateLinkResourceRegion,omitempty"`
	PrivateLinkServicePrivateIP *string                                `json:"privateLinkServicePrivateIP,omitempty"`
	PrivateLinkServiceUrl       *string                                `json:"privateLinkServiceUrl,omitempty"`
	ProvisioningState           *ProvisioningState                     `json:"provisioningState,omitempty"`
	RequestMessage              *string                                `json:"requestMessage,omitempty"`
}

type ManagedPrivateEndpointUpdateParameters 

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

type ManagedPrivateEndpointsClient 

type ManagedPrivateEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewManagedPrivateEndpointsClientWithBaseURI 

func NewManagedPrivateEndpointsClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedPrivateEndpointsClient, error)

func (ManagedPrivateEndpointsClient) Create 

func (c ManagedPrivateEndpointsClient) Create(ctx context.Context, id ManagedPrivateEndpointId, input ManagedPrivateEndpointModel) (result CreateOperationResponse, err error)

Create ...

func (ManagedPrivateEndpointsClient) CreateThenPoll 

func (c ManagedPrivateEndpointsClient) CreateThenPoll(ctx context.Context, id ManagedPrivateEndpointId, input ManagedPrivateEndpointModel) error

CreateThenPoll performs Create then polls until it's completed

func (ManagedPrivateEndpointsClient) Delete 

func (c ManagedPrivateEndpointsClient) Delete(ctx context.Context, id ManagedPrivateEndpointId) (result DeleteOperationResponse, err error)

Delete ...

func (ManagedPrivateEndpointsClient) DeleteThenPoll 

func (c ManagedPrivateEndpointsClient) DeleteThenPoll(ctx context.Context, id ManagedPrivateEndpointId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ManagedPrivateEndpointsClient) Get 

func (c ManagedPrivateEndpointsClient) Get(ctx context.Context, id ManagedPrivateEndpointId) (result GetOperationResponse, err error)

Get ...

func (ManagedPrivateEndpointsClient) List 

func (c ManagedPrivateEndpointsClient) List(ctx context.Context, id GrafanaId) (result ListOperationResponse, err error)

List ...

func (ManagedPrivateEndpointsClient) ListComplete 

func (c ManagedPrivateEndpointsClient) ListComplete(ctx context.Context, id GrafanaId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ManagedPrivateEndpointsClient) ListCompleteMatchingPredicate 

func (c ManagedPrivateEndpointsClient) ListCompleteMatchingPredicate(ctx context.Context, id GrafanaId, predicate ManagedPrivateEndpointModelOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedPrivateEndpointsClient) Refresh 

func (c ManagedPrivateEndpointsClient) Refresh(ctx context.Context, id GrafanaId) (result RefreshOperationResponse, err error)

Refresh ...

func (ManagedPrivateEndpointsClient) RefreshThenPoll 

func (c ManagedPrivateEndpointsClient) RefreshThenPoll(ctx context.Context, id GrafanaId) error

RefreshThenPoll performs Refresh then polls until it's completed

func (ManagedPrivateEndpointsClient) Update 

func (c ManagedPrivateEndpointsClient) Update(ctx context.Context, id ManagedPrivateEndpointId, input ManagedPrivateEndpointUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

func (ManagedPrivateEndpointsClient) UpdateThenPoll 

func (c ManagedPrivateEndpointsClient) UpdateThenPoll(ctx context.Context, id ManagedPrivateEndpointId, input ManagedPrivateEndpointUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type RefreshOperationResponse 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedPrivateEndpointModel
}

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.