package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# README

github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/integrationruntime Documentation

The integrationruntime SDK allows for interaction with the Azure Resource Manager Service synapse (API Version 2021-06-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/synapse/2021-06-01/integrationruntime"

Client Initialization

client := integrationruntime.NewIntegrationRuntimeClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IntegrationRuntimeClient.AuthKeysList

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

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

Example Usage: IntegrationRuntimeClient.AuthKeysRegenerate

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

payload := integrationruntime.IntegrationRuntimeRegenerateKeyParameters{
	// ...
}


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

Example Usage: IntegrationRuntimeClient.ConnectionInfosGet

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

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

Example Usage: IntegrationRuntimeClient.Create

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

payload := integrationruntime.IntegrationRuntimeResource{
	// ...
}


if err := client.CreateThenPoll(ctx, id, payload, integrationruntime.DefaultCreateOperationOptions()); err != nil {
	// handle the error
}

Example Usage: IntegrationRuntimeClient.CredentialsSync

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

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

Example Usage: IntegrationRuntimeClient.Delete

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: IntegrationRuntimeClient.DisableInteractiveQuery

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

if err := client.DisableInteractiveQueryThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: IntegrationRuntimeClient.EnableInteractiveQuery

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

if err := client.EnableInteractiveQueryThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: IntegrationRuntimeClient.Get

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

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

Example Usage: IntegrationRuntimeClient.ListByWorkspace

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

// alternatively `client.ListByWorkspace(ctx, id)` can be used to do batched pagination
items, err := client.ListByWorkspaceComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IntegrationRuntimeClient.MonitoringDataList

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

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

Example Usage: IntegrationRuntimeClient.NodeIPAddressGet

ctx := context.TODO()
id := integrationruntime.NewNodeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue", "nodeValue")

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

Example Usage: IntegrationRuntimeClient.NodesDelete

ctx := context.TODO()
id := integrationruntime.NewNodeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue", "nodeValue")

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

Example Usage: IntegrationRuntimeClient.NodesGet

ctx := context.TODO()
id := integrationruntime.NewNodeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue", "nodeValue")

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

Example Usage: IntegrationRuntimeClient.NodesUpdate

ctx := context.TODO()
id := integrationruntime.NewNodeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue", "nodeValue")

payload := integrationruntime.UpdateIntegrationRuntimeNodeRequest{
	// ...
}


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

Example Usage: IntegrationRuntimeClient.ObjectMetadataList

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

payload := integrationruntime.GetSsisObjectMetadataRequest{
	// ...
}


// alternatively `client.ObjectMetadataList(ctx, id, payload)` can be used to do batched pagination
items, err := client.ObjectMetadataListComplete(ctx, id, payload)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IntegrationRuntimeClient.ObjectMetadataRefresh

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

if err := client.ObjectMetadataRefreshThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: IntegrationRuntimeClient.Start

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

if err := client.StartThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: IntegrationRuntimeClient.StatusGet

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

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

Example Usage: IntegrationRuntimeClient.Stop

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

if err := client.StopThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: IntegrationRuntimeClient.Update

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

payload := integrationruntime.UpdateIntegrationRuntimeRequest{
	// ...
}


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

Example Usage: IntegrationRuntimeClient.Upgrade

ctx := context.TODO()
id := integrationruntime.NewIntegrationRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "integrationRuntimeValue")

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

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
NewIntegrationRuntimeID returns a new IntegrationRuntimeId struct.
NewNodeID returns a new NodeId struct.
NewWorkspaceID returns a new WorkspaceId struct.
ParseIntegrationRuntimeID parses 'input' into a IntegrationRuntimeId.
ParseIntegrationRuntimeIDInsensitively parses 'input' case-insensitively into a IntegrationRuntimeId note: this method should only be used for API response data and not user input.
ParseNodeID parses 'input' into a NodeId.
ParseNodeIDInsensitively parses 'input' case-insensitively into a NodeId note: this method should only be used for API response data and not user input.
ParseWorkspaceID parses 'input' into a WorkspaceId.
ParseWorkspaceIDInsensitively parses 'input' case-insensitively into a WorkspaceId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ValidateIntegrationRuntimeID checks that 'input' can be parsed as a Integration Runtime ID.
ValidateNodeID checks that 'input' can be parsed as a Node ID.
ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IntegrationRuntimeId is a struct representing the Resource ID for a Integration Runtime.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NodeId is a struct representing the Resource ID for a Node.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RawCustomSetupBaseImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g.
RawIntegrationRuntimeImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g.
RawIntegrationRuntimeStatusImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g.
RawLinkedIntegrationRuntimeTypeImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g.
RawSecretBaseImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g.
RawSsisObjectMetadataImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WorkspaceId is a struct representing the Resource ID for a Workspace.

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author