jobprivateendpoints

package
v0.20240320.1143605 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-05-01-preview/jobprivateendpoints Documentation

The jobprivateendpoints SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-05-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/sql/2023-05-01-preview/jobprivateendpoints"

Client Initialization

client := jobprivateendpoints.NewJobPrivateEndpointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: JobPrivateEndpointsClient.CreateOrUpdate

ctx := context.TODO()
id := jobprivateendpoints.NewPrivateEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "jobAgentValue", "privateEndpointValue")

payload := jobprivateendpoints.JobPrivateEndpoint{
	// ...
}


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

Example Usage: JobPrivateEndpointsClient.Delete

ctx := context.TODO()
id := jobprivateendpoints.NewPrivateEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "jobAgentValue", "privateEndpointValue")

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

Example Usage: JobPrivateEndpointsClient.Get

ctx := context.TODO()
id := jobprivateendpoints.NewPrivateEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "jobAgentValue", "privateEndpointValue")

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: JobPrivateEndpointsClient.ListByAgent

ctx := context.TODO()
id := jobprivateendpoints.NewJobAgentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "jobAgentValue")

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

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

ValidateJobAgentID checks that 'input' can be parsed as a Job Agent ID

func ValidatePrivateEndpointID 

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

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

Types

type CreateOrUpdateOperationResponse 

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

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

type JobAgentId 

type JobAgentId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	JobAgentName      string
}

JobAgentId is a struct representing the Resource ID for a Job Agent

func NewJobAgentID 

func NewJobAgentID(subscriptionId string, resourceGroupName string, serverName string, jobAgentName string) JobAgentId

NewJobAgentID returns a new JobAgentId struct

func ParseJobAgentID 

func ParseJobAgentID(input string) (*JobAgentId, error)

ParseJobAgentID parses 'input' into a JobAgentId

func ParseJobAgentIDInsensitively 

func ParseJobAgentIDInsensitively(input string) (*JobAgentId, error)

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

func (*JobAgentId) FromParseResult 

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

func (JobAgentId) ID 

func (id JobAgentId) ID() string

ID returns the formatted Job Agent ID

func (JobAgentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Job Agent ID

func (JobAgentId) String 

func (id JobAgentId) String() string

String returns a human-readable description of this Job Agent ID

type JobPrivateEndpoint 

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

type JobPrivateEndpointOperationPredicate 

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

func (JobPrivateEndpointOperationPredicate) Matches 

func (p JobPrivateEndpointOperationPredicate) Matches(input JobPrivateEndpoint) bool

type JobPrivateEndpointProperties 

type JobPrivateEndpointProperties struct {
	PrivateEndpointId           *string `json:"privateEndpointId,omitempty"`
	TargetServerAzureResourceId string  `json:"targetServerAzureResourceId"`
}

type JobPrivateEndpointsClient 

type JobPrivateEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewJobPrivateEndpointsClientWithBaseURI 

func NewJobPrivateEndpointsClientWithBaseURI(sdkApi sdkEnv.Api) (*JobPrivateEndpointsClient, error)

func (JobPrivateEndpointsClient) CreateOrUpdate 

func (c JobPrivateEndpointsClient) CreateOrUpdate(ctx context.Context, id PrivateEndpointId, input JobPrivateEndpoint) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (JobPrivateEndpointsClient) CreateOrUpdateThenPoll 

func (c JobPrivateEndpointsClient) CreateOrUpdateThenPoll(ctx context.Context, id PrivateEndpointId, input JobPrivateEndpoint) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (JobPrivateEndpointsClient) Delete 

func (c JobPrivateEndpointsClient) Delete(ctx context.Context, id PrivateEndpointId) (result DeleteOperationResponse, err error)

Delete ...

func (JobPrivateEndpointsClient) DeleteThenPoll 

func (c JobPrivateEndpointsClient) DeleteThenPoll(ctx context.Context, id PrivateEndpointId) error

DeleteThenPoll performs Delete then polls until it's completed

func (JobPrivateEndpointsClient) Get 

func (c JobPrivateEndpointsClient) Get(ctx context.Context, id PrivateEndpointId) (result GetOperationResponse, err error)

Get ...

func (JobPrivateEndpointsClient) ListByAgent 

func (c JobPrivateEndpointsClient) ListByAgent(ctx context.Context, id JobAgentId) (result ListByAgentOperationResponse, err error)

ListByAgent ...

func (JobPrivateEndpointsClient) ListByAgentComplete 

func (c JobPrivateEndpointsClient) ListByAgentComplete(ctx context.Context, id JobAgentId) (ListByAgentCompleteResult, error)

ListByAgentComplete retrieves all the results into a single object

func (JobPrivateEndpointsClient) ListByAgentCompleteMatchingPredicate 

func (c JobPrivateEndpointsClient) ListByAgentCompleteMatchingPredicate(ctx context.Context, id JobAgentId, predicate JobPrivateEndpointOperationPredicate) (result ListByAgentCompleteResult, err error)

ListByAgentCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListByAgentCompleteResult 

type ListByAgentCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []JobPrivateEndpoint
}

type ListByAgentOperationResponse 

type ListByAgentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]JobPrivateEndpoint
}

type PrivateEndpointId 

type PrivateEndpointId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ServerName          string
	JobAgentName        string
	PrivateEndpointName string
}

PrivateEndpointId is a struct representing the Resource ID for a Private Endpoint

func NewPrivateEndpointID 

func NewPrivateEndpointID(subscriptionId string, resourceGroupName string, serverName string, jobAgentName string, privateEndpointName string) PrivateEndpointId

NewPrivateEndpointID returns a new PrivateEndpointId struct

func ParsePrivateEndpointID 

func ParsePrivateEndpointID(input string) (*PrivateEndpointId, error)

ParsePrivateEndpointID parses 'input' into a PrivateEndpointId

func ParsePrivateEndpointIDInsensitively 

func ParsePrivateEndpointIDInsensitively(input string) (*PrivateEndpointId, error)

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

func (*PrivateEndpointId) FromParseResult 

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

func (PrivateEndpointId) ID 

func (id PrivateEndpointId) ID() string

ID returns the formatted Private Endpoint ID

func (PrivateEndpointId) Segments 

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

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

func (PrivateEndpointId) String 

func (id PrivateEndpointId) String() string

String returns a human-readable description of this Private Endpoint 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.