managedprivateendpoints

package
v0.20240903.1111904 Latest Latest
Warning

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

 Go to latest Published: Sep 3, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/kusto/2023-08-15/managedprivateendpoints Documentation

The managedprivateendpoints SDK allows for interaction with the Azure Resource Manager Service kusto (API Version 2023-08-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/kusto/2023-08-15/managedprivateendpoints"

Client Initialization

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

Example Usage: ManagedPrivateEndpointsClient.CheckNameAvailability

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

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


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

Example Usage: ManagedPrivateEndpointsClient.CreateOrUpdate

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

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


if err := client.CreateOrUpdateThenPoll(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", "clusterValue", "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", "clusterValue", "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 := commonids.NewKustoClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

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

Example Usage: ManagedPrivateEndpointsClient.Update

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

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


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 PossibleValuesForManagedPrivateEndpointsType 

func PossibleValuesForManagedPrivateEndpointsType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForReason 

func PossibleValuesForReason() []string

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 CheckNameAvailabilityOperationResponse 

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckNameResult
}

type CheckNameResult 

type CheckNameResult struct {
	Message       *string `json:"message,omitempty"`
	Name          *string `json:"name,omitempty"`
	NameAvailable *bool   `json:"nameAvailable,omitempty"`
	Reason        *Reason `json:"reason,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedPrivateEndpointListResult
}

type ManagedPrivateEndpoint 

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

type ManagedPrivateEndpointId 

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

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

func NewManagedPrivateEndpointID 

func NewManagedPrivateEndpointID(subscriptionId string, resourceGroupName string, clusterName 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 

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 ManagedPrivateEndpointListResult 

type ManagedPrivateEndpointListResult struct {
	Value *[]ManagedPrivateEndpoint `json:"value,omitempty"`
}

type ManagedPrivateEndpointProperties 

type ManagedPrivateEndpointProperties struct {
	GroupId                   string             `json:"groupId"`
	PrivateLinkResourceId     string             `json:"privateLinkResourceId"`
	PrivateLinkResourceRegion *string            `json:"privateLinkResourceRegion,omitempty"`
	ProvisioningState         *ProvisioningState `json:"provisioningState,omitempty"`
	RequestMessage            *string            `json:"requestMessage,omitempty"`
}

type ManagedPrivateEndpointsCheckNameRequest 

type ManagedPrivateEndpointsCheckNameRequest struct {
	Name string                      `json:"name"`
	Type ManagedPrivateEndpointsType `json:"type"`
}

type ManagedPrivateEndpointsClient 

type ManagedPrivateEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewManagedPrivateEndpointsClientWithBaseURI 

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

func (ManagedPrivateEndpointsClient) CheckNameAvailability 

func (c ManagedPrivateEndpointsClient) CheckNameAvailability(ctx context.Context, id commonids.KustoClusterId, input ManagedPrivateEndpointsCheckNameRequest) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (ManagedPrivateEndpointsClient) CreateOrUpdate 

func (c ManagedPrivateEndpointsClient) CreateOrUpdate(ctx context.Context, id ManagedPrivateEndpointId, input ManagedPrivateEndpoint) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ManagedPrivateEndpointsClient) CreateOrUpdateThenPoll 

func (c ManagedPrivateEndpointsClient) CreateOrUpdateThenPoll(ctx context.Context, id ManagedPrivateEndpointId, input ManagedPrivateEndpoint) error

CreateOrUpdateThenPoll performs CreateOrUpdate 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 commonids.KustoClusterId) (result ListOperationResponse, err error)

List ...

func (ManagedPrivateEndpointsClient) Update 

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

Update ...

func (ManagedPrivateEndpointsClient) UpdateThenPoll 

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

UpdateThenPoll performs Update then polls until it's completed

type ManagedPrivateEndpointsType 

type ManagedPrivateEndpointsType string
const (
	ManagedPrivateEndpointsTypeMicrosoftPointKustoClustersManagedPrivateEndpoints ManagedPrivateEndpointsType = "Microsoft.Kusto/clusters/managedPrivateEndpoints"
)

func (*ManagedPrivateEndpointsType) UnmarshalJSON 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateMoving    ProvisioningState = "Moving"
	ProvisioningStateRunning   ProvisioningState = "Running"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON 

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

type Reason 

type Reason string
const (
	ReasonAlreadyExists Reason = "AlreadyExists"
	ReasonInvalid       Reason = "Invalid"
)

func (*Reason) UnmarshalJSON 

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

type UpdateOperationResponse 

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

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.