privatelinkresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagesync/2020-03-01/privatelinkresources Documentation

The privatelinkresources SDK allows for interaction with the Azure Resource Manager Service storagesync (API Version 2020-03-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/storagesync/2020-03-01/privatelinkresources"

Client Initialization

client := privatelinkresources.NewPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkResourcesClient.ListByStorageSyncService

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

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

Documentation

Index

• func ValidateStorageSyncServiceID(input interface{}, key string) (warnings []string, errors []error)
• type ListByStorageSyncServiceOperationResponse
• type PrivateLinkResource
• type PrivateLinkResourceListResult
• type PrivateLinkResourceProperties
• type PrivateLinkResourcesClient
  • func NewPrivateLinkResourcesClientWithBaseURI(api environments.Api) (*PrivateLinkResourcesClient, error)
  • func (c PrivateLinkResourcesClient) ListByStorageSyncService(ctx context.Context, id StorageSyncServiceId) (result ListByStorageSyncServiceOperationResponse, err error)
• type StorageSyncServiceId
  • func NewStorageSyncServiceID(subscriptionId string, resourceGroupName string, storageSyncServiceName string) StorageSyncServiceId
  • func ParseStorageSyncServiceID(input string) (*StorageSyncServiceId, error)
  • func ParseStorageSyncServiceIDInsensitively(input string) (*StorageSyncServiceId, error)
  • func (id StorageSyncServiceId) ID() string
  • func (id StorageSyncServiceId) Segments() []resourceids.Segment
  • func (id StorageSyncServiceId) String() string

Functions

func ValidateStorageSyncServiceID

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

ValidateStorageSyncServiceID checks that 'input' can be parsed as a Storage Sync Service ID

Types

type ListByStorageSyncServiceOperationResponse

type ListByStorageSyncServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkResourceListResult
}

type PrivateLinkResource

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

type PrivateLinkResourceListResult

type PrivateLinkResourceListResult struct {
	Value *[]PrivateLinkResource `json:"value,omitempty"`
}

type PrivateLinkResourceProperties

type PrivateLinkResourceProperties struct {
	GroupId           *string   `json:"groupId,omitempty"`
	RequiredMembers   *[]string `json:"requiredMembers,omitempty"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkResourcesClientWithBaseURI

func NewPrivateLinkResourcesClientWithBaseURI(api environments.Api) (*PrivateLinkResourcesClient, error)

func (PrivateLinkResourcesClient) ListByStorageSyncService

func (c PrivateLinkResourcesClient) ListByStorageSyncService(ctx context.Context, id StorageSyncServiceId) (result ListByStorageSyncServiceOperationResponse, err error)

ListByStorageSyncService ...

type StorageSyncServiceId

type StorageSyncServiceId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
}

StorageSyncServiceId is a struct representing the Resource ID for a Storage Sync Service

func NewStorageSyncServiceID

func NewStorageSyncServiceID(subscriptionId string, resourceGroupName string, storageSyncServiceName string) StorageSyncServiceId

NewStorageSyncServiceID returns a new StorageSyncServiceId struct

func ParseStorageSyncServiceID

func ParseStorageSyncServiceID(input string) (*StorageSyncServiceId, error)

ParseStorageSyncServiceID parses 'input' into a StorageSyncServiceId

func ParseStorageSyncServiceIDInsensitively

func ParseStorageSyncServiceIDInsensitively(input string) (*StorageSyncServiceId, error)

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

func (StorageSyncServiceId) ID

func (id StorageSyncServiceId) ID() string

ID returns the formatted Storage Sync Service ID

func (StorageSyncServiceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Storage Sync Service ID

func (StorageSyncServiceId) String

func (id StorageSyncServiceId) String() string

String returns a human-readable description of this Storage Sync Service ID