privatelinkserviceclient

Documentation

Overview

Package privatelinkserviceclient implements the client for PrivateLinkService.

Package privatelinkserviceclient implements the client for PrivateLinkService.

Index

• Constants
• type Client
  • func New(config *azclients.ClientConfig) *Client
  • func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, privateLinkServiceName string, ...) *retry.Error
  • func (c *Client) Delete(ctx context.Context, resourceGroupName string, privateLinkServiceName string) *retry.Error
  • func (c *Client) DeletePEConnection(ctx context.Context, resourceGroupName string, privateLinkServiceName string, ...) *retry.Error
  • func (c *Client) Get(ctx context.Context, resourceGroupName string, privateLinkServiceName string, ...) (network.PrivateLinkService, *retry.Error)
  • func (c *Client) List(ctx context.Context, resourceGroupName string) ([]network.PrivateLinkService, *retry.Error)
• type Interface
• type PrivateLinkServiceListResultPage
  • func (page *PrivateLinkServiceListResultPage) Next() error
  • func (page *PrivateLinkServiceListResultPage) NextWithContext(ctx context.Context) (err error)
  • func (page PrivateLinkServiceListResultPage) NotDone() bool
  • func (page PrivateLinkServiceListResultPage) Response() network.PrivateLinkServiceListResult
  • func (page PrivateLinkServiceListResultPage) Values() []network.PrivateLinkService

Constants

const (
	PLSResourceType    = "Microsoft.Network/privatelinkservices"
	PEConnResourceType = "privateEndpointConnections"
)

const (
	// APIVersion is the API version for network.
	APIVersion = "2021-08-01"
	// AzureStackCloudAPIVersion is the API version for Azure Stack
	AzureStackCloudAPIVersion = "2019-03-01"
	// AzureStackCloudName is the cloud name of Azure Stack
	AzureStackCloudName = "AZURESTACKCLOUD"
)

Types

type Client

type Client struct {

	// ARM throttling configures.
	RetryAfterReader time.Time
	RetryAfterWriter time.Time
	// contains filtered or unexported fields
}

Client implements privatelinkservice Interface.

func New

func New(config *azclients.ClientConfig) *Client

New creates a new private link service client.

func (*Client) CreateOrUpdate

func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, privateLinkServiceName string, privateLinkService network.PrivateLinkService, etag string) *retry.Error

CreateOrUpdate creates or updates a private link service .

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, resourceGroupName string, privateLinkServiceName string) *retry.Error

func (*Client) DeletePEConnection

func (c *Client) DeletePEConnection(ctx context.Context, resourceGroupName string, privateLinkServiceName string, privateEndpointConnectionName string) *retry.Error

func (*Client) Get

func (c *Client) Get(ctx context.Context, resourceGroupName string, privateLinkServiceName string, expand string) (network.PrivateLinkService, *retry.Error)

Get gets the private link service

func (*Client) List

func (c *Client) List(ctx context.Context, resourceGroupName string) ([]network.PrivateLinkService, *retry.Error)

/ List gets a list of PrivateLinkServices in the resource group.

type Interface

type Interface interface {

	// Get gets the private link service
	Get(ctx context.Context, resourceGroupName string, privateLinkServiceName string, expand string) (result network.PrivateLinkService, rerr *retry.Error)

	// List gets a list of PrivateLinkService in the resource group.
	List(ctx context.Context, resourceGroupName string) (result []network.PrivateLinkService, rerr *retry.Error)

	// CreateOrUpdate creates or updates a private link service.
	CreateOrUpdate(ctx context.Context, resourceGroupName string, privateLinkServiceName string, privateLinkService network.PrivateLinkService, etag string) *retry.Error

	// Delete deletes a private link service by name.
	Delete(ctx context.Context, resourceGroupName string, privateLinkServiceName string) *retry.Error

	// Delete deletes a private endpoint connection to the private link service by name
	DeletePEConnection(ctx context.Context, resourceGroupName string, privateLinkServiceName string, privateEndpointConnectionName string) *retry.Error
}

Interface is the client interface for Private Link Services. Don't forget to run "hack/update-mock-clients.sh" command to generate the mock client.

type PrivateLinkServiceListResultPage

type PrivateLinkServiceListResultPage struct {
	// contains filtered or unexported fields
}

PrivateLinkServiceListResultPage contains a page of PrivateLinkService values.

func (*PrivateLinkServiceListResultPage) Next

func (page *PrivateLinkServiceListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PrivateLinkServiceListResultPage) NextWithContext

func (page *PrivateLinkServiceListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (PrivateLinkServiceListResultPage) NotDone

func (page PrivateLinkServiceListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (PrivateLinkServiceListResultPage) Response

func (page PrivateLinkServiceListResultPage) Response() network.PrivateLinkServiceListResult

Response returns the raw server response from the last page request.

func (PrivateLinkServiceListResultPage) Values

func (page PrivateLinkServiceListResultPage) Values() []network.PrivateLinkService

Values returns the slice of values for the current page or nil if there are no values.