managedprivateendpoints

package
v0.20240122.1044832 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/datafactory/2018-06-01/managedprivateendpoints Documentation

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

Client Initialization

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

Example Usage: ManagedPrivateEndpointsClient.CreateOrUpdate

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

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


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

Example Usage: ManagedPrivateEndpointsClient.Delete

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

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

Example Usage: ManagedPrivateEndpointsClient.Get

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

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

Example Usage: ManagedPrivateEndpointsClient.ListByFactory

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

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

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

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

func ValidateManagedVirtualNetworkID 

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

ValidateManagedVirtualNetworkID checks that 'input' can be parsed as a Managed Virtual Network ID

Types

type ConnectionStateProperties 

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

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders added in v0.20230516.1215417 

func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers

func (CreateOrUpdateOperationOptions) ToOData added in v0.20230516.1215417 

func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query

func (CreateOrUpdateOperationOptions) ToQuery added in v0.20230516.1215417 

func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedPrivateEndpointResource
}

type DeleteOperationResponse 

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

type GetOperationOptions 

type GetOperationOptions struct {
	IfNoneMatch *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders added in v0.20230516.1215417 

func (o GetOperationOptions) ToHeaders() *client.Headers

func (GetOperationOptions) ToOData added in v0.20230516.1215417 

func (o GetOperationOptions) ToOData() *odata.Query

func (GetOperationOptions) ToQuery added in v0.20230516.1215417 

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse 

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

type ListByFactoryCompleteResult 

type ListByFactoryCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ManagedPrivateEndpointResource
}

type ListByFactoryOperationResponse 

type ListByFactoryOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedPrivateEndpointResource
}

type ManagedPrivateEndpoint 

type ManagedPrivateEndpoint struct {
	ConnectionState       *ConnectionStateProperties `json:"connectionState,omitempty"`
	Fqdns                 *[]string                  `json:"fqdns,omitempty"`
	GroupId               *string                    `json:"groupId,omitempty"`
	IsReserved            *bool                      `json:"isReserved,omitempty"`
	PrivateLinkResourceId *string                    `json:"privateLinkResourceId,omitempty"`
	ProvisioningState     *string                    `json:"provisioningState,omitempty"`
}

type ManagedPrivateEndpointId 

type ManagedPrivateEndpointId struct {
	SubscriptionId             string
	ResourceGroupName          string
	FactoryName                string
	ManagedVirtualNetworkName  string
	ManagedPrivateEndpointName string
}

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

func NewManagedPrivateEndpointID 

func NewManagedPrivateEndpointID(subscriptionId string, resourceGroupName string, factoryName string, managedVirtualNetworkName 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 ManagedPrivateEndpointResource 

type ManagedPrivateEndpointResource struct {
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties ManagedPrivateEndpoint `json:"properties"`
	Type       *string                `json:"type,omitempty"`
}

type ManagedPrivateEndpointResourceOperationPredicate 

type ManagedPrivateEndpointResourceOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (ManagedPrivateEndpointResourceOperationPredicate) Matches 

func (p ManagedPrivateEndpointResourceOperationPredicate) Matches(input ManagedPrivateEndpointResource) bool

type ManagedPrivateEndpointsClient 

type ManagedPrivateEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewManagedPrivateEndpointsClientWithBaseURI 

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

func (ManagedPrivateEndpointsClient) CreateOrUpdate 

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

CreateOrUpdate ...

func (ManagedPrivateEndpointsClient) Delete 

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

Delete ...

func (ManagedPrivateEndpointsClient) Get 

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

Get ...

func (ManagedPrivateEndpointsClient) ListByFactory 

func (c ManagedPrivateEndpointsClient) ListByFactory(ctx context.Context, id ManagedVirtualNetworkId) (result ListByFactoryOperationResponse, err error)

ListByFactory ...

func (ManagedPrivateEndpointsClient) ListByFactoryComplete 

func (c ManagedPrivateEndpointsClient) ListByFactoryComplete(ctx context.Context, id ManagedVirtualNetworkId) (ListByFactoryCompleteResult, error)

ListByFactoryComplete retrieves all the results into a single object

func (ManagedPrivateEndpointsClient) ListByFactoryCompleteMatchingPredicate 

func (c ManagedPrivateEndpointsClient) ListByFactoryCompleteMatchingPredicate(ctx context.Context, id ManagedVirtualNetworkId, predicate ManagedPrivateEndpointResourceOperationPredicate) (result ListByFactoryCompleteResult, err error)

ListByFactoryCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ManagedVirtualNetworkId 

type ManagedVirtualNetworkId struct {
	SubscriptionId            string
	ResourceGroupName         string
	FactoryName               string
	ManagedVirtualNetworkName string
}

ManagedVirtualNetworkId is a struct representing the Resource ID for a Managed Virtual Network

func NewManagedVirtualNetworkID 

func NewManagedVirtualNetworkID(subscriptionId string, resourceGroupName string, factoryName string, managedVirtualNetworkName string) ManagedVirtualNetworkId

NewManagedVirtualNetworkID returns a new ManagedVirtualNetworkId struct

func ParseManagedVirtualNetworkID 

func ParseManagedVirtualNetworkID(input string) (*ManagedVirtualNetworkId, error)

ParseManagedVirtualNetworkID parses 'input' into a ManagedVirtualNetworkId

func ParseManagedVirtualNetworkIDInsensitively 

func ParseManagedVirtualNetworkIDInsensitively(input string) (*ManagedVirtualNetworkId, error)

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

func (*ManagedVirtualNetworkId) FromParseResult added in v0.20231127.1171502 

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

func (ManagedVirtualNetworkId) ID 

func (id ManagedVirtualNetworkId) ID() string

ID returns the formatted Managed Virtual Network ID

func (ManagedVirtualNetworkId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Managed Virtual Network ID

func (ManagedVirtualNetworkId) String 

func (id ManagedVirtualNetworkId) String() string

String returns a human-readable description of this Managed Virtual Network ID

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.