resourcemanagementprivatelink

README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2020-05-01/resourcemanagementprivatelink Documentation

The resourcemanagementprivatelink SDK allows for interaction with Azure Resource Manager resources (API Version 2020-05-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/resources/2020-05-01/resourcemanagementprivatelink"

Client Initialization

client := resourcemanagementprivatelink.NewResourceManagementPrivateLinkClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ResourceManagementPrivateLinkClient.Delete

ctx := context.TODO()
id := resourcemanagementprivatelink.NewResourceManagementPrivateLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "rmplName")

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: ResourceManagementPrivateLinkClient.Get

ctx := context.TODO()
id := resourcemanagementprivatelink.NewResourceManagementPrivateLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "rmplName")

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

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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: ResourceManagementPrivateLinkClient.ListByResourceGroup

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

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

Example Usage: ResourceManagementPrivateLinkClient.Put

ctx := context.TODO()
id := resourcemanagementprivatelink.NewResourceManagementPrivateLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "rmplName")

payload := resourcemanagementprivatelink.ResourceManagementPrivateLinkLocation{
	// ...
}


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

Documentation

Index

• func ValidateResourceManagementPrivateLinkID(input interface{}, key string) (warnings []string, errors []error)
• type DeleteOperationResponse
• type GetOperationResponse
• type ListByResourceGroupOperationResponse
• type ListOperationResponse
• type PutOperationResponse
• type ResourceManagementPrivateLink
• type ResourceManagementPrivateLinkClient
  • func NewResourceManagementPrivateLinkClientWithBaseURI(sdkApi sdkEnv.Api) (*ResourceManagementPrivateLinkClient, error)
  • func (c ResourceManagementPrivateLinkClient) Delete(ctx context.Context, id ResourceManagementPrivateLinkId) (result DeleteOperationResponse, err error)
  • func (c ResourceManagementPrivateLinkClient) Get(ctx context.Context, id ResourceManagementPrivateLinkId) (result GetOperationResponse, err error)
  • func (c ResourceManagementPrivateLinkClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c ResourceManagementPrivateLinkClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
  • func (c ResourceManagementPrivateLinkClient) Put(ctx context.Context, id ResourceManagementPrivateLinkId, ...) (result PutOperationResponse, err error)
• type ResourceManagementPrivateLinkEndpointConnections
• type ResourceManagementPrivateLinkId
  • func NewResourceManagementPrivateLinkID(subscriptionId string, resourceGroupName string, ...) ResourceManagementPrivateLinkId
  • func ParseResourceManagementPrivateLinkID(input string) (*ResourceManagementPrivateLinkId, error)
  • func ParseResourceManagementPrivateLinkIDInsensitively(input string) (*ResourceManagementPrivateLinkId, error)
  • func (id *ResourceManagementPrivateLinkId) FromParseResult(input resourceids.ParseResult) error
  • func (id ResourceManagementPrivateLinkId) ID() string
  • func (id ResourceManagementPrivateLinkId) Segments() []resourceids.Segment
  • func (id ResourceManagementPrivateLinkId) String() string
• type ResourceManagementPrivateLinkListResult
• type ResourceManagementPrivateLinkLocation

Functions

func ValidateResourceManagementPrivateLinkID

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

ValidateResourceManagementPrivateLinkID checks that 'input' can be parsed as a Resource Management Private Link ID

Types

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ResourceManagementPrivateLinkListResult
}

type ListOperationResponse

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

type PutOperationResponse

type PutOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ResourceManagementPrivateLink
}

type ResourceManagementPrivateLink

type ResourceManagementPrivateLink struct {
	Id         *string                                           `json:"id,omitempty"`
	Location   *string                                           `json:"location,omitempty"`
	Name       *string                                           `json:"name,omitempty"`
	Properties *ResourceManagementPrivateLinkEndpointConnections `json:"properties,omitempty"`
	Type       *string                                           `json:"type,omitempty"`
}

type ResourceManagementPrivateLinkClient

type ResourceManagementPrivateLinkClient struct {
	Client *resourcemanager.Client
}

func NewResourceManagementPrivateLinkClientWithBaseURI

func NewResourceManagementPrivateLinkClientWithBaseURI(sdkApi sdkEnv.Api) (*ResourceManagementPrivateLinkClient, error)

func (ResourceManagementPrivateLinkClient) Delete

func (c ResourceManagementPrivateLinkClient) Delete(ctx context.Context, id ResourceManagementPrivateLinkId) (result DeleteOperationResponse, err error)

Delete ...

func (ResourceManagementPrivateLinkClient) Get

func (c ResourceManagementPrivateLinkClient) Get(ctx context.Context, id ResourceManagementPrivateLinkId) (result GetOperationResponse, err error)

Get ...

func (ResourceManagementPrivateLinkClient) List

func (c ResourceManagementPrivateLinkClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (ResourceManagementPrivateLinkClient) ListByResourceGroup

func (c ResourceManagementPrivateLinkClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ResourceManagementPrivateLinkClient) Put

func (c ResourceManagementPrivateLinkClient) Put(ctx context.Context, id ResourceManagementPrivateLinkId, input ResourceManagementPrivateLinkLocation) (result PutOperationResponse, err error)

Put ...

type ResourceManagementPrivateLinkEndpointConnections

type ResourceManagementPrivateLinkEndpointConnections struct {
	PrivateEndpointConnections *[]string `json:"privateEndpointConnections,omitempty"`
}

type ResourceManagementPrivateLinkId

type ResourceManagementPrivateLinkId struct {
	SubscriptionId                    string
	ResourceGroupName                 string
	ResourceManagementPrivateLinkName string
}

ResourceManagementPrivateLinkId is a struct representing the Resource ID for a Resource Management Private Link

func NewResourceManagementPrivateLinkID

func NewResourceManagementPrivateLinkID(subscriptionId string, resourceGroupName string, resourceManagementPrivateLinkName string) ResourceManagementPrivateLinkId

NewResourceManagementPrivateLinkID returns a new ResourceManagementPrivateLinkId struct

func ParseResourceManagementPrivateLinkID

func ParseResourceManagementPrivateLinkID(input string) (*ResourceManagementPrivateLinkId, error)

ParseResourceManagementPrivateLinkID parses 'input' into a ResourceManagementPrivateLinkId

func ParseResourceManagementPrivateLinkIDInsensitively

func ParseResourceManagementPrivateLinkIDInsensitively(input string) (*ResourceManagementPrivateLinkId, error)

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

func (*ResourceManagementPrivateLinkId) FromParseResult

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

func (ResourceManagementPrivateLinkId) ID

func (id ResourceManagementPrivateLinkId) ID() string

ID returns the formatted Resource Management Private Link ID

func (ResourceManagementPrivateLinkId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Resource Management Private Link ID

func (ResourceManagementPrivateLinkId) String

func (id ResourceManagementPrivateLinkId) String() string

String returns a human-readable description of this Resource Management Private Link ID

type ResourceManagementPrivateLinkListResult

type ResourceManagementPrivateLinkListResult struct {
	Value *[]ResourceManagementPrivateLink `json:"value,omitempty"`
}

type ResourceManagementPrivateLinkLocation

type ResourceManagementPrivateLinkLocation struct {
	Location *string `json:"location,omitempty"`
}