linkedservices

README

github.com/hashicorp/go-azure-sdk/resource-manager/operationalinsights/2020-08-01/linkedservices Documentation

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

Client Initialization

client := linkedservices.NewLinkedServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
if err != nil {
	// handle the error
}

Example Usage: LinkedServicesClient.CreateOrUpdate

ctx := context.TODO()
id := linkedservices.NewLinkedServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "linkedServiceValue")

payload := linkedservices.LinkedService{
	// ...
}

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

Example Usage: LinkedServicesClient.Delete

ctx := context.TODO()
id := linkedservices.NewLinkedServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "linkedServiceValue")
future, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if err := future.Poller.PollUntilDone(); err != nil {
	// handle the error
}

Example Usage: LinkedServicesClient.Get

ctx := context.TODO()
id := linkedservices.NewLinkedServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "linkedServiceValue")
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: LinkedServicesClient.ListByWorkspace

ctx := context.TODO()
id := linkedservices.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue")
read, err := client.ListByWorkspace(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func PossibleValuesForLinkedServiceEntityStatus() []string
• func ValidateLinkedServiceID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type LinkedService
• type LinkedServiceEntityStatus
• type LinkedServiceId
  • func NewLinkedServiceID(subscriptionId string, resourceGroupName string, workspaceName string, ...) LinkedServiceId
  • func ParseLinkedServiceID(input string) (*LinkedServiceId, error)
  • func ParseLinkedServiceIDInsensitively(input string) (*LinkedServiceId, error)
  • func (id LinkedServiceId) ID() string
  • func (id LinkedServiceId) Segments() []resourceids.Segment
  • func (id LinkedServiceId) String() string
• type LinkedServiceListResult
• type LinkedServiceProperties
• type LinkedServicesClient
  • func NewLinkedServicesClientWithBaseURI(endpoint string) LinkedServicesClient
  • func (c LinkedServicesClient) CreateOrUpdate(ctx context.Context, id LinkedServiceId, input LinkedService) (result CreateOrUpdateOperationResponse, err error)
  • func (c LinkedServicesClient) CreateOrUpdateThenPoll(ctx context.Context, id LinkedServiceId, input LinkedService) error
  • func (c LinkedServicesClient) Delete(ctx context.Context, id LinkedServiceId) (result DeleteOperationResponse, err error)
  • func (c LinkedServicesClient) DeleteThenPoll(ctx context.Context, id LinkedServiceId) error
  • func (c LinkedServicesClient) Get(ctx context.Context, id LinkedServiceId) (result GetOperationResponse, err error)
  • func (c LinkedServicesClient) ListByWorkspace(ctx context.Context, id WorkspaceId) (result ListByWorkspaceOperationResponse, err error)
• type ListByWorkspaceOperationResponse
• type WorkspaceId
  • func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId
  • func ParseWorkspaceID(input string) (*WorkspaceId, error)
  • func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)
  • func (id WorkspaceId) ID() string
  • func (id WorkspaceId) Segments() []resourceids.Segment
  • func (id WorkspaceId) String() string

Functions

func PossibleValuesForLinkedServiceEntityStatus

func PossibleValuesForLinkedServiceEntityStatus() []string

func ValidateLinkedServiceID

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

ValidateLinkedServiceID checks that 'input' can be parsed as a Linked Service ID

func ValidateWorkspaceID

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *LinkedService
}

type LinkedService

type LinkedService struct {
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties LinkedServiceProperties `json:"properties"`
	Tags       *map[string]string      `json:"tags,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type LinkedServiceEntityStatus

type LinkedServiceEntityStatus string

const (
	LinkedServiceEntityStatusDeleting            LinkedServiceEntityStatus = "Deleting"
	LinkedServiceEntityStatusProvisioningAccount LinkedServiceEntityStatus = "ProvisioningAccount"
	LinkedServiceEntityStatusSucceeded           LinkedServiceEntityStatus = "Succeeded"
	LinkedServiceEntityStatusUpdating            LinkedServiceEntityStatus = "Updating"
)

type LinkedServiceId

type LinkedServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	LinkedServiceName string
}

LinkedServiceId is a struct representing the Resource ID for a Linked Service

func NewLinkedServiceID

func NewLinkedServiceID(subscriptionId string, resourceGroupName string, workspaceName string, linkedServiceName string) LinkedServiceId

NewLinkedServiceID returns a new LinkedServiceId struct

func ParseLinkedServiceID

func ParseLinkedServiceID(input string) (*LinkedServiceId, error)

ParseLinkedServiceID parses 'input' into a LinkedServiceId

func ParseLinkedServiceIDInsensitively

func ParseLinkedServiceIDInsensitively(input string) (*LinkedServiceId, error)

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

func (LinkedServiceId) ID

func (id LinkedServiceId) ID() string

ID returns the formatted Linked Service ID

func (LinkedServiceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Linked Service ID

func (LinkedServiceId) String

func (id LinkedServiceId) String() string

String returns a human-readable description of this Linked Service ID

type LinkedServiceListResult

type LinkedServiceListResult struct {
	Value *[]LinkedService `json:"value,omitempty"`
}

type LinkedServiceProperties

type LinkedServiceProperties struct {
	ProvisioningState     *LinkedServiceEntityStatus `json:"provisioningState,omitempty"`
	ResourceId            *string                    `json:"resourceId,omitempty"`
	WriteAccessResourceId *string                    `json:"writeAccessResourceId,omitempty"`
}

type LinkedServicesClient

type LinkedServicesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewLinkedServicesClientWithBaseURI

func NewLinkedServicesClientWithBaseURI(endpoint string) LinkedServicesClient

func (LinkedServicesClient) CreateOrUpdate

func (c LinkedServicesClient) CreateOrUpdate(ctx context.Context, id LinkedServiceId, input LinkedService) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (LinkedServicesClient) CreateOrUpdateThenPoll

func (c LinkedServicesClient) CreateOrUpdateThenPoll(ctx context.Context, id LinkedServiceId, input LinkedService) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (LinkedServicesClient) Delete

func (c LinkedServicesClient) Delete(ctx context.Context, id LinkedServiceId) (result DeleteOperationResponse, err error)

Delete ...

func (LinkedServicesClient) DeleteThenPoll

func (c LinkedServicesClient) DeleteThenPoll(ctx context.Context, id LinkedServiceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (LinkedServicesClient) Get

func (c LinkedServicesClient) Get(ctx context.Context, id LinkedServiceId) (result GetOperationResponse, err error)

Get ...

func (LinkedServicesClient) ListByWorkspace

func (c LinkedServicesClient) ListByWorkspace(ctx context.Context, id WorkspaceId) (result ListByWorkspaceOperationResponse, err error)

ListByWorkspace ...

type ListByWorkspaceOperationResponse

type ListByWorkspaceOperationResponse struct {
	HttpResponse *http.Response
	Model        *LinkedServiceListResult
}

type WorkspaceId

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (WorkspaceId) ID

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Workspace ID

func (WorkspaceId) String

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID