linkedservices

package
v0.20231023.1063038 Latest Latest
Warning

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

Go to latest
Published: Oct 23, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

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

Example Usage: LinkedServicesClient.CreateOrUpdate

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

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


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); 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")

if err := client.DeleteThenPoll(ctx, id); 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

Constants

This section is empty.

Variables

This section is empty.

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       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

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        *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"
)

func (*LinkedServiceEntityStatus) UnmarshalJSON added in v0.20230825.1030756

func (s *LinkedServiceEntityStatus) UnmarshalJSON(bytes []byte) error

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 *resourcemanager.Client
}

func NewLinkedServicesClientWithBaseURI

func NewLinkedServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*LinkedServicesClient, error)

func (LinkedServicesClient) CreateOrUpdate

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

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

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
	OData        *odata.OData
	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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL