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/bigdatapools Documentation

The bigdatapools 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/bigdatapools"

Client Initialization

client := bigdatapools.NewBigDataPoolsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BigDataPoolsClient.CreateOrUpdate

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

payload := bigdatapools.BigDataPoolResourceInfo{
	// ...
}


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

Example Usage: BigDataPoolsClient.Delete

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

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

Example Usage: BigDataPoolsClient.Get

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

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: BigDataPoolsClient.ListByWorkspace

ctx := context.TODO()
id := bigdatapools.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: BigDataPoolsClient.Update

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

payload := bigdatapools.BigDataPoolPatchInfo{
	// ...
}


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
}

# Functions

No description provided by the author
NewBigDataPoolID returns a new BigDataPoolId struct.
No description provided by the author
NewWorkspaceID returns a new WorkspaceId struct.
ParseBigDataPoolID parses 'input' into a BigDataPoolId.
ParseBigDataPoolIDInsensitively parses 'input' case-insensitively into a BigDataPoolId 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
ValidateBigDataPoolID checks that 'input' can be parsed as a Big Data Pool 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

# Structs

No description provided by the author
No description provided by the author
BigDataPoolId is a struct representing the Resource ID for a Big Data Pool.
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.

# Type aliases

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