armsynapse

package module
v0.8.0 Latest Latest
Warning

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

 Go to latest Published: Nov 24, 2023 License: MIT Imports: 15 Imported by: 9

README

Azure Synapse Module for Go

PkgGoDev

The armsynapse module provides operations for working with Azure Synapse.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Synapse module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Synapse. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Synapse module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armsynapse.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armsynapse.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewKustoPoolDataConnectionsClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Synapse label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AADAdminProperties 

type AADAdminProperties struct {
	// Workspace active directory administrator type
	AdministratorType *string

	// Login of the workspace active directory administrator
	Login *string

	// Object ID of the workspace active directory administrator
	Sid *string

	// Tenant ID of the workspace active directory administrator
	TenantID *string
}

AADAdminProperties - Workspace active directory administrator properties

func (AADAdminProperties) MarshalJSON added in v0.6.0 

func (a AADAdminProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AADAdminProperties.

func (*AADAdminProperties) UnmarshalJSON added in v0.6.0 

func (a *AADAdminProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AADAdminProperties.

type ActualState added in v0.6.0 

type ActualState string

ActualState - Actual state 

const (
	ActualStateDisabled  ActualState = "Disabled"
	ActualStateDisabling ActualState = "Disabling"
	ActualStateEnabled   ActualState = "Enabled"
	ActualStateEnabling  ActualState = "Enabling"
	ActualStateUnknown   ActualState = "Unknown"
)

func PossibleActualStateValues added in v0.6.0 

func PossibleActualStateValues() []ActualState

PossibleActualStateValues returns the possible values for the ActualState const type.

type AttachedDatabaseConfiguration 

type AttachedDatabaseConfiguration struct {
	// Resource location.
	Location *string

	// The properties of the attached database configuration.
	Properties *AttachedDatabaseConfigurationProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

AttachedDatabaseConfiguration - Class representing an attached database configuration.

func (AttachedDatabaseConfiguration) MarshalJSON 

func (a AttachedDatabaseConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AttachedDatabaseConfiguration.

func (*AttachedDatabaseConfiguration) UnmarshalJSON 

func (a *AttachedDatabaseConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AttachedDatabaseConfiguration.

type AttachedDatabaseConfigurationListResult 

type AttachedDatabaseConfigurationListResult struct {
	// The list of attached database configurations.
	Value []*AttachedDatabaseConfiguration
}

AttachedDatabaseConfigurationListResult - The list attached database configurations operation response.

func (AttachedDatabaseConfigurationListResult) MarshalJSON 

func (a AttachedDatabaseConfigurationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AttachedDatabaseConfigurationListResult.

func (*AttachedDatabaseConfigurationListResult) UnmarshalJSON added in v0.6.0 

func (a *AttachedDatabaseConfigurationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AttachedDatabaseConfigurationListResult.

type AttachedDatabaseConfigurationProperties 

type AttachedDatabaseConfigurationProperties struct {
	// REQUIRED; The name of the database which you would like to attach, use * if you want to follow all current and future databases.
	DatabaseName *string

	// REQUIRED; The default principals modification kind
	DefaultPrincipalsModificationKind *DefaultPrincipalsModificationKind

	// REQUIRED; The resource id of the kusto pool where the databases you would like to attach reside.
	KustoPoolResourceID *string

	// Table level sharing specifications
	TableLevelSharingProperties *TableLevelSharingProperties

	// READ-ONLY; The list of databases from the clusterResourceId which are currently attached to the kusto pool.
	AttachedDatabaseNames []*string

	// READ-ONLY; The provisioned state of the resource.
	ProvisioningState *ResourceProvisioningState
}

AttachedDatabaseConfigurationProperties - Class representing the an attached database configuration properties of kind specific.

func (AttachedDatabaseConfigurationProperties) MarshalJSON 

func (a AttachedDatabaseConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AttachedDatabaseConfigurationProperties.

func (*AttachedDatabaseConfigurationProperties) UnmarshalJSON added in v0.6.0 

func (a *AttachedDatabaseConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AttachedDatabaseConfigurationProperties.

type AutoPauseProperties 

type AutoPauseProperties struct {
	// Number of minutes of idle time before the Big Data pool is automatically paused.
	DelayInMinutes *int32

	// Whether auto-pausing is enabled for the Big Data pool.
	Enabled *bool
}

AutoPauseProperties - Auto-pausing properties of a Big Data pool powered by Apache Spark

func (AutoPauseProperties) MarshalJSON added in v0.6.0 

func (a AutoPauseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AutoPauseProperties.

func (*AutoPauseProperties) UnmarshalJSON added in v0.6.0 

func (a *AutoPauseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AutoPauseProperties.

type AutoScaleProperties 

type AutoScaleProperties struct {
	// Whether automatic scaling is enabled for the Big Data pool.
	Enabled *bool

	// The maximum number of nodes the Big Data pool can support.
	MaxNodeCount *int32

	// The minimum number of nodes the Big Data pool can support.
	MinNodeCount *int32
}

AutoScaleProperties - Auto-scaling properties of a Big Data pool powered by Apache Spark

func (AutoScaleProperties) MarshalJSON added in v0.6.0 

func (a AutoScaleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AutoScaleProperties.

func (*AutoScaleProperties) UnmarshalJSON added in v0.6.0 

func (a *AutoScaleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AutoScaleProperties.

type AvailableRpOperation 

type AvailableRpOperation struct {
	// Display properties of the operation
	Display *AvailableRpOperationDisplayInfo

	// Whether this operation is a data action
	IsDataAction *string

	// Operation name
	Name *string

	// Operation origin
	Origin *string

	// Operation properties
	Properties *OperationMetaPropertyInfo
}

AvailableRpOperation - An operation that is available in this resource provider

func (AvailableRpOperation) MarshalJSON added in v0.6.0 

func (a AvailableRpOperation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableRpOperation.

func (*AvailableRpOperation) UnmarshalJSON added in v0.6.0 

func (a *AvailableRpOperation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableRpOperation.

type AvailableRpOperationDisplayInfo 

type AvailableRpOperationDisplayInfo struct {
	// Operation description
	Description *string

	// Operation name
	Operation *string

	// Resource provider name
	Provider *string

	// Resource type
	Resource *string
}

AvailableRpOperationDisplayInfo - Description of an available operation

func (AvailableRpOperationDisplayInfo) MarshalJSON added in v0.6.0 

func (a AvailableRpOperationDisplayInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableRpOperationDisplayInfo.

func (*AvailableRpOperationDisplayInfo) UnmarshalJSON added in v0.6.0 

func (a *AvailableRpOperationDisplayInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableRpOperationDisplayInfo.

type AzureADOnlyAuthentication 

type AzureADOnlyAuthentication struct {
	// azureADOnlyAuthentication resource properties
	Properties *AzureADOnlyAuthenticationProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

AzureADOnlyAuthentication - Azure Active Directory Only Authentication Info

func (AzureADOnlyAuthentication) MarshalJSON 

func (a AzureADOnlyAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureADOnlyAuthentication.

func (*AzureADOnlyAuthentication) UnmarshalJSON 

func (a *AzureADOnlyAuthentication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureADOnlyAuthentication.

type AzureADOnlyAuthenticationListResult 

type AzureADOnlyAuthenticationListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*AzureADOnlyAuthentication
}

AzureADOnlyAuthenticationListResult - A list of active directory only authentications.

func (AzureADOnlyAuthenticationListResult) MarshalJSON 

func (a AzureADOnlyAuthenticationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureADOnlyAuthenticationListResult.

func (*AzureADOnlyAuthenticationListResult) UnmarshalJSON added in v0.6.0 

func (a *AzureADOnlyAuthenticationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureADOnlyAuthenticationListResult.

type AzureADOnlyAuthenticationName 

type AzureADOnlyAuthenticationName string
const (
	AzureADOnlyAuthenticationNameDefault AzureADOnlyAuthenticationName = "default"
)

func PossibleAzureADOnlyAuthenticationNameValues 

func PossibleAzureADOnlyAuthenticationNameValues() []AzureADOnlyAuthenticationName

PossibleAzureADOnlyAuthenticationNameValues returns the possible values for the AzureADOnlyAuthenticationName const type.

type AzureADOnlyAuthenticationProperties 

type AzureADOnlyAuthenticationProperties struct {
	// REQUIRED; Azure Active Directory only Authentication enabled.
	AzureADOnlyAuthentication *bool

	// READ-ONLY; property configuration date
	CreationDate *time.Time

	// READ-ONLY; property configuration state
	State *StateValue
}

AzureADOnlyAuthenticationProperties - Properties of a active directory only authentication.

func (AzureADOnlyAuthenticationProperties) MarshalJSON 

func (a AzureADOnlyAuthenticationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureADOnlyAuthenticationProperties.

func (*AzureADOnlyAuthenticationProperties) UnmarshalJSON 

func (a *AzureADOnlyAuthenticationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureADOnlyAuthenticationProperties.

type AzureADOnlyAuthenticationsClient 

type AzureADOnlyAuthenticationsClient struct {
	// contains filtered or unexported fields
}

AzureADOnlyAuthenticationsClient contains the methods for the AzureADOnlyAuthentications group. Don't use this type directly, use NewAzureADOnlyAuthenticationsClient() instead.

func NewAzureADOnlyAuthenticationsClient 

func NewAzureADOnlyAuthenticationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AzureADOnlyAuthenticationsClient, error)

NewAzureADOnlyAuthenticationsClient creates a new instance of AzureADOnlyAuthenticationsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*AzureADOnlyAuthenticationsClient) BeginCreate 

func (client *AzureADOnlyAuthenticationsClient) BeginCreate(ctx context.Context, resourceGroupName string, workspaceName string, azureADOnlyAuthenticationName AzureADOnlyAuthenticationName, azureADOnlyAuthenticationInfo AzureADOnlyAuthentication, options *AzureADOnlyAuthenticationsClientBeginCreateOptions) (*runtime.Poller[AzureADOnlyAuthenticationsClientCreateResponse], error)

BeginCreate - Create or Update a Azure Active Directory only authentication property for the workspaces If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • azureADOnlyAuthenticationName - name of the property
  • azureADOnlyAuthenticationInfo - Azure Active Directory Property
  • options - AzureADOnlyAuthenticationsClientBeginCreateOptions contains the optional parameters for the AzureADOnlyAuthenticationsClient.BeginCreate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateAzureADOnlyAuthentication.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAzureADOnlyAuthenticationsClient().BeginCreate(ctx, "workspace-6852", "workspace-2080", armsynapse.AzureADOnlyAuthenticationNameDefault, armsynapse.AzureADOnlyAuthentication{
		Properties: &armsynapse.AzureADOnlyAuthenticationProperties{
			AzureADOnlyAuthentication: to.Ptr(true),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AzureADOnlyAuthentication = armsynapse.AzureADOnlyAuthentication{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/azureADOnlyAuthentications"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/azureADOnlyAuthentications/default"),
	// 	Properties: &armsynapse.AzureADOnlyAuthenticationProperties{
	// 		AzureADOnlyAuthentication: to.Ptr(true),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:56:19.200Z"); return t}()),
	// 		State: to.Ptr(armsynapse.StateValueConsistent),
	// 	},
	// }
}

Output:

func (*AzureADOnlyAuthenticationsClient) Get 

func (client *AzureADOnlyAuthenticationsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, azureADOnlyAuthenticationName AzureADOnlyAuthenticationName, options *AzureADOnlyAuthenticationsClientGetOptions) (AzureADOnlyAuthenticationsClientGetResponse, error)

Get - Gets a Azure Active Directory only authentication property If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • azureADOnlyAuthenticationName - name of the property
  • options - AzureADOnlyAuthenticationsClientGetOptions contains the optional parameters for the AzureADOnlyAuthenticationsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetAzureADOnlyAuthentication.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAzureADOnlyAuthenticationsClient().Get(ctx, "workspace-6852", "workspace-2080", armsynapse.AzureADOnlyAuthenticationNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AzureADOnlyAuthentication = armsynapse.AzureADOnlyAuthentication{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/azureADOnlyAuthentications"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/azureADOnlyAuthentications/default"),
	// 	Properties: &armsynapse.AzureADOnlyAuthenticationProperties{
	// 		AzureADOnlyAuthentication: to.Ptr(true),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:56:19.200Z"); return t}()),
	// 		State: to.Ptr(armsynapse.StateValueConsistent),
	// 	},
	// }
}

Output:

func (*AzureADOnlyAuthenticationsClient) NewListPager added in v0.4.0 

func (client *AzureADOnlyAuthenticationsClient) NewListPager(resourceGroupName string, workspaceName string, options *AzureADOnlyAuthenticationsClientListOptions) *runtime.Pager[AzureADOnlyAuthenticationsClientListResponse]

NewListPager - Gets a list of Azure Active Directory only authentication property for a workspace

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - AzureADOnlyAuthenticationsClientListOptions contains the optional parameters for the AzureADOnlyAuthenticationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListAzureADOnlyAuthentication.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAzureADOnlyAuthenticationsClient().NewListPager("workspace-6852", "workspace-2080", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AzureADOnlyAuthenticationListResult = armsynapse.AzureADOnlyAuthenticationListResult{
		// 	Value: []*armsynapse.AzureADOnlyAuthentication{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/azureADOnlyAuthentications"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/azureADOnlyAuthentications/default"),
		// 			Properties: &armsynapse.AzureADOnlyAuthenticationProperties{
		// 				AzureADOnlyAuthentication: to.Ptr(true),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:56:19.200Z"); return t}()),
		// 				State: to.Ptr(armsynapse.StateValueConsistent),
		// 			},
		// 	}},
		// }
	}
}

Output:

type AzureADOnlyAuthenticationsClientBeginCreateOptions added in v0.2.0 

type AzureADOnlyAuthenticationsClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AzureADOnlyAuthenticationsClientBeginCreateOptions contains the optional parameters for the AzureADOnlyAuthenticationsClient.BeginCreate method.

type AzureADOnlyAuthenticationsClientCreateResponse added in v0.2.0 

type AzureADOnlyAuthenticationsClientCreateResponse struct {
	// Azure Active Directory Only Authentication Info
	AzureADOnlyAuthentication
}

AzureADOnlyAuthenticationsClientCreateResponse contains the response from method AzureADOnlyAuthenticationsClient.BeginCreate.

type AzureADOnlyAuthenticationsClientGetOptions added in v0.2.0 

type AzureADOnlyAuthenticationsClientGetOptions struct {
}

AzureADOnlyAuthenticationsClientGetOptions contains the optional parameters for the AzureADOnlyAuthenticationsClient.Get method.

type AzureADOnlyAuthenticationsClientGetResponse added in v0.2.0 

type AzureADOnlyAuthenticationsClientGetResponse struct {
	// Azure Active Directory Only Authentication Info
	AzureADOnlyAuthentication
}

AzureADOnlyAuthenticationsClientGetResponse contains the response from method AzureADOnlyAuthenticationsClient.Get.

type AzureADOnlyAuthenticationsClientListOptions added in v0.2.0 

type AzureADOnlyAuthenticationsClientListOptions struct {
}

AzureADOnlyAuthenticationsClientListOptions contains the optional parameters for the AzureADOnlyAuthenticationsClient.NewListPager method.

type AzureADOnlyAuthenticationsClientListResponse added in v0.2.0 

type AzureADOnlyAuthenticationsClientListResponse struct {
	// A list of active directory only authentications.
	AzureADOnlyAuthenticationListResult
}

AzureADOnlyAuthenticationsClientListResponse contains the response from method AzureADOnlyAuthenticationsClient.NewListPager.

type AzureCapacity 

type AzureCapacity struct {
	// REQUIRED; The default capacity that would be used.
	Default *int32

	// REQUIRED; Maximum allowed capacity.
	Maximum *int32

	// REQUIRED; Minimum allowed capacity.
	Minimum *int32

	// REQUIRED; Scale type.
	ScaleType *AzureScaleType
}

AzureCapacity - Azure capacity definition.

func (AzureCapacity) MarshalJSON added in v0.6.0 

func (a AzureCapacity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureCapacity.

func (*AzureCapacity) UnmarshalJSON added in v0.6.0 

func (a *AzureCapacity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCapacity.

type AzureEntityResource 

type AzureEntityResource struct {
	// READ-ONLY; Resource Etag.
	Etag *string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

AzureEntityResource - The resource model definition for an Azure Resource Manager resource with an etag.

func (AzureEntityResource) MarshalJSON 

func (a AzureEntityResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureEntityResource.

func (*AzureEntityResource) UnmarshalJSON 

func (a *AzureEntityResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureEntityResource.

type AzureResourceSKU 

type AzureResourceSKU struct {
	// The number of instances of the cluster.
	Capacity *AzureCapacity

	// Resource Namespace and Type.
	ResourceType *string

	// The SKU details.
	SKU *AzureSKU
}

AzureResourceSKU - Azure resource SKU definition.

func (AzureResourceSKU) MarshalJSON added in v0.6.0 

func (a AzureResourceSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureResourceSKU.

func (*AzureResourceSKU) UnmarshalJSON added in v0.6.0 

func (a *AzureResourceSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureResourceSKU.

type AzureSKU 

type AzureSKU struct {
	// REQUIRED; SKU name.
	Name *SKUName

	// REQUIRED; SKU size.
	Size *SKUSize

	// The number of instances of the cluster.
	Capacity *int32
}

AzureSKU - Azure SKU definition.

func (AzureSKU) MarshalJSON added in v0.6.0 

func (a AzureSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureSKU.

func (*AzureSKU) UnmarshalJSON added in v0.6.0 

func (a *AzureSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureSKU.

type AzureScaleType 

type AzureScaleType string

AzureScaleType - Scale type. 

const (
	AzureScaleTypeAutomatic AzureScaleType = "automatic"
	AzureScaleTypeManual    AzureScaleType = "manual"
	AzureScaleTypeNone      AzureScaleType = "none"
)

func PossibleAzureScaleTypeValues 

func PossibleAzureScaleTypeValues() []AzureScaleType

PossibleAzureScaleTypeValues returns the possible values for the AzureScaleType const type.

type BigDataPoolPatchInfo 

type BigDataPoolPatchInfo struct {
	// Updated tags for the Big Data pool
	Tags map[string]*string
}

BigDataPoolPatchInfo - Properties patch for a Big Data pool

func (BigDataPoolPatchInfo) MarshalJSON 

func (b BigDataPoolPatchInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BigDataPoolPatchInfo.

func (*BigDataPoolPatchInfo) UnmarshalJSON added in v0.6.0 

func (b *BigDataPoolPatchInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BigDataPoolPatchInfo.

type BigDataPoolResourceInfo 

type BigDataPoolResourceInfo struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Big Data pool properties
	Properties *BigDataPoolResourceProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

BigDataPoolResourceInfo - A Big Data pool

func (BigDataPoolResourceInfo) MarshalJSON 

func (b BigDataPoolResourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BigDataPoolResourceInfo.

func (*BigDataPoolResourceInfo) UnmarshalJSON 

func (b *BigDataPoolResourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BigDataPoolResourceInfo.

type BigDataPoolResourceInfoListResult 

type BigDataPoolResourceInfoListResult struct {
	// Link to the next page of results
	NextLink *string

	// List of Big Data pools
	Value []*BigDataPoolResourceInfo
}

BigDataPoolResourceInfoListResult - Collection of Big Data pool information

func (BigDataPoolResourceInfoListResult) MarshalJSON 

func (b BigDataPoolResourceInfoListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BigDataPoolResourceInfoListResult.

func (*BigDataPoolResourceInfoListResult) UnmarshalJSON added in v0.6.0 

func (b *BigDataPoolResourceInfoListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BigDataPoolResourceInfoListResult.

type BigDataPoolResourceProperties 

type BigDataPoolResourceProperties struct {
	// Auto-pausing properties
	AutoPause *AutoPauseProperties

	// Auto-scaling properties
	AutoScale *AutoScaleProperties

	// The cache size
	CacheSize *int32

	// List of custom libraries/packages associated with the spark pool.
	CustomLibraries []*LibraryInfo

	// The default folder where Spark logs will be written.
	DefaultSparkLogFolder *string

	// Dynamic Executor Allocation
	DynamicExecutorAllocation *DynamicExecutorAllocation

	// Whether autotune is required or not.
	IsAutotuneEnabled *bool

	// Whether compute isolation is required or not.
	IsComputeIsolationEnabled *bool

	// Library version requirements
	LibraryRequirements *LibraryRequirements

	// The number of nodes in the Big Data pool.
	NodeCount *int32

	// The level of compute power that each node in the Big Data pool has.
	NodeSize *NodeSize

	// The kind of nodes that the Big Data pool provides.
	NodeSizeFamily *NodeSizeFamily

	// The state of the Big Data pool.
	ProvisioningState *string

	// Whether session level packages enabled.
	SessionLevelPackagesEnabled *bool

	// Spark configuration file to specify additional properties
	SparkConfigProperties *SparkConfigProperties

	// The Spark events folder
	SparkEventsFolder *string

	// The Apache Spark version.
	SparkVersion *string

	// READ-ONLY; The time when the Big Data pool was created.
	CreationDate *time.Time

	// READ-ONLY; The time when the Big Data pool was updated successfully.
	LastSucceededTimestamp *time.Time
}

BigDataPoolResourceProperties - Properties of a Big Data pool powered by Apache Spark

func (BigDataPoolResourceProperties) MarshalJSON 

func (b BigDataPoolResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BigDataPoolResourceProperties.

func (*BigDataPoolResourceProperties) UnmarshalJSON 

func (b *BigDataPoolResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BigDataPoolResourceProperties.

type BigDataPoolsClient 

type BigDataPoolsClient struct {
	// contains filtered or unexported fields
}

BigDataPoolsClient contains the methods for the BigDataPools group. Don't use this type directly, use NewBigDataPoolsClient() instead.

func NewBigDataPoolsClient 

func NewBigDataPoolsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BigDataPoolsClient, error)

NewBigDataPoolsClient creates a new instance of BigDataPoolsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*BigDataPoolsClient) BeginCreateOrUpdate 

func (client *BigDataPoolsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, bigDataPoolName string, bigDataPoolInfo BigDataPoolResourceInfo, options *BigDataPoolsClientBeginCreateOrUpdateOptions) (*runtime.Poller[BigDataPoolsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a new Big Data pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • bigDataPoolName - Big Data pool name
  • bigDataPoolInfo - The Big Data pool to create.
  • options - BigDataPoolsClientBeginCreateOrUpdateOptions contains the optional parameters for the BigDataPoolsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/CreateOrUpdateBigDataPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBigDataPoolsClient().BeginCreateOrUpdate(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExamplePool", armsynapse.BigDataPoolResourceInfo{
		Location: to.Ptr("West US 2"),
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
		Properties: &armsynapse.BigDataPoolResourceProperties{
			AutoPause: &armsynapse.AutoPauseProperties{
				DelayInMinutes: to.Ptr[int32](15),
				Enabled:        to.Ptr(true),
			},
			AutoScale: &armsynapse.AutoScaleProperties{
				Enabled:      to.Ptr(true),
				MaxNodeCount: to.Ptr[int32](50),
				MinNodeCount: to.Ptr[int32](3),
			},
			DefaultSparkLogFolder: to.Ptr("/logs"),
			IsAutotuneEnabled:     to.Ptr(false),
			LibraryRequirements: &armsynapse.LibraryRequirements{
				Content:  to.Ptr(""),
				Filename: to.Ptr("requirements.txt"),
			},
			NodeCount:         to.Ptr[int32](4),
			NodeSize:          to.Ptr(armsynapse.NodeSizeMedium),
			NodeSizeFamily:    to.Ptr(armsynapse.NodeSizeFamilyMemoryOptimized),
			SparkEventsFolder: to.Ptr("/events"),
			SparkVersion:      to.Ptr("3.3"),
		},
	}, &armsynapse.BigDataPoolsClientBeginCreateOrUpdateOptions{Force: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BigDataPoolResourceInfo = armsynapse.BigDataPoolResourceInfo{
	// 	Name: to.Ptr("ExamplePool"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool"),
	// 	Location: to.Ptr("West US 2"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armsynapse.BigDataPoolResourceProperties{
	// 		AutoPause: &armsynapse.AutoPauseProperties{
	// 			DelayInMinutes: to.Ptr[int32](15),
	// 			Enabled: to.Ptr(true),
	// 		},
	// 		AutoScale: &armsynapse.AutoScaleProperties{
	// 			Enabled: to.Ptr(true),
	// 			MaxNodeCount: to.Ptr[int32](50),
	// 			MinNodeCount: to.Ptr[int32](3),
	// 		},
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		DefaultSparkLogFolder: to.Ptr("/logs"),
	// 		IsAutotuneEnabled: to.Ptr(false),
	// 		LastSucceededTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T10:00:00.000Z"); return t}()),
	// 		LibraryRequirements: &armsynapse.LibraryRequirements{
	// 			Content: to.Ptr(""),
	// 			Filename: to.Ptr("requirements.txt"),
	// 			Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		},
	// 		NodeCount: to.Ptr[int32](4),
	// 		NodeSize: to.Ptr(armsynapse.NodeSizeMedium),
	// 		NodeSizeFamily: to.Ptr(armsynapse.NodeSizeFamilyMemoryOptimized),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SparkEventsFolder: to.Ptr("/events"),
	// 		SparkVersion: to.Ptr("3.3"),
	// 	},
	// }
}

Output:

func (*BigDataPoolsClient) BeginDelete 

func (client *BigDataPoolsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, bigDataPoolName string, options *BigDataPoolsClientBeginDeleteOptions) (*runtime.Poller[BigDataPoolsClientDeleteResponse], error)

BeginDelete - Delete a Big Data pool from the workspace. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • bigDataPoolName - Big Data pool name
  • options - BigDataPoolsClientBeginDeleteOptions contains the optional parameters for the BigDataPoolsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/DeleteBigDataPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBigDataPoolsClient().BeginDelete(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExamplePool", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BigDataPoolResourceInfo = armsynapse.BigDataPoolResourceInfo{
	// 	Name: to.Ptr("ExamplePool"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool"),
	// 	Location: to.Ptr("West US 2"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armsynapse.BigDataPoolResourceProperties{
	// 		AutoPause: &armsynapse.AutoPauseProperties{
	// 			DelayInMinutes: to.Ptr[int32](15),
	// 			Enabled: to.Ptr(true),
	// 		},
	// 		AutoScale: &armsynapse.AutoScaleProperties{
	// 			Enabled: to.Ptr(true),
	// 			MaxNodeCount: to.Ptr[int32](50),
	// 			MinNodeCount: to.Ptr[int32](3),
	// 		},
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		DefaultSparkLogFolder: to.Ptr("/logs"),
	// 		IsAutotuneEnabled: to.Ptr(false),
	// 		LibraryRequirements: &armsynapse.LibraryRequirements{
	// 			Content: to.Ptr(""),
	// 			Filename: to.Ptr("requirements.txt"),
	// 			Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		},
	// 		NodeCount: to.Ptr[int32](4),
	// 		NodeSize: to.Ptr(armsynapse.NodeSizeMedium),
	// 		NodeSizeFamily: to.Ptr(armsynapse.NodeSizeFamilyMemoryOptimized),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SparkEventsFolder: to.Ptr("/events"),
	// 		SparkVersion: to.Ptr("3.3"),
	// 	},
	// }
}

Output:

func (*BigDataPoolsClient) Get 

func (client *BigDataPoolsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, bigDataPoolName string, options *BigDataPoolsClientGetOptions) (BigDataPoolsClientGetResponse, error)

Get - Get a Big Data pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • bigDataPoolName - Big Data pool name
  • options - BigDataPoolsClientGetOptions contains the optional parameters for the BigDataPoolsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/GetBigDataPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBigDataPoolsClient().Get(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExamplePool", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BigDataPoolResourceInfo = armsynapse.BigDataPoolResourceInfo{
	// 	Name: to.Ptr("ExamplePool"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool"),
	// 	Location: to.Ptr("West US 2"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armsynapse.BigDataPoolResourceProperties{
	// 		AutoPause: &armsynapse.AutoPauseProperties{
	// 			DelayInMinutes: to.Ptr[int32](15),
	// 			Enabled: to.Ptr(true),
	// 		},
	// 		AutoScale: &armsynapse.AutoScaleProperties{
	// 			Enabled: to.Ptr(true),
	// 			MaxNodeCount: to.Ptr[int32](50),
	// 			MinNodeCount: to.Ptr[int32](3),
	// 		},
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		DefaultSparkLogFolder: to.Ptr("/logs"),
	// 		IsAutotuneEnabled: to.Ptr(false),
	// 		LibraryRequirements: &armsynapse.LibraryRequirements{
	// 			Content: to.Ptr(""),
	// 			Filename: to.Ptr("requirements.txt"),
	// 			Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		},
	// 		NodeCount: to.Ptr[int32](4),
	// 		NodeSize: to.Ptr(armsynapse.NodeSizeMedium),
	// 		NodeSizeFamily: to.Ptr(armsynapse.NodeSizeFamilyMemoryOptimized),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SparkEventsFolder: to.Ptr("/events"),
	// 		SparkVersion: to.Ptr("3.3"),
	// 	},
	// }
}

Output:

func (*BigDataPoolsClient) NewListByWorkspacePager added in v0.4.0 

func (client *BigDataPoolsClient) NewListByWorkspacePager(resourceGroupName string, workspaceName string, options *BigDataPoolsClientListByWorkspaceOptions) *runtime.Pager[BigDataPoolsClientListByWorkspaceResponse]

NewListByWorkspacePager - List Big Data pools in a workspace.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - BigDataPoolsClientListByWorkspaceOptions contains the optional parameters for the BigDataPoolsClient.NewListByWorkspacePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/ListBigDataPoolsInWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBigDataPoolsClient().NewListByWorkspacePager("ExampleResourceGroup", "ExampleWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.BigDataPoolResourceInfoListResult = armsynapse.BigDataPoolResourceInfoListResult{
		// 	Value: []*armsynapse.BigDataPoolResourceInfo{
		// 		{
		// 			Name: to.Ptr("ExamplePool"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools"),
		// 			ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool"),
		// 			Location: to.Ptr("West US 2"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armsynapse.BigDataPoolResourceProperties{
		// 				AutoPause: &armsynapse.AutoPauseProperties{
		// 					DelayInMinutes: to.Ptr[int32](15),
		// 					Enabled: to.Ptr(true),
		// 				},
		// 				AutoScale: &armsynapse.AutoScaleProperties{
		// 					Enabled: to.Ptr(true),
		// 					MaxNodeCount: to.Ptr[int32](50),
		// 					MinNodeCount: to.Ptr[int32](3),
		// 				},
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 				DefaultSparkLogFolder: to.Ptr("/logs"),
		// 				IsAutotuneEnabled: to.Ptr(false),
		// 				LibraryRequirements: &armsynapse.LibraryRequirements{
		// 					Content: to.Ptr(""),
		// 					Filename: to.Ptr("requirements.txt"),
		// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 				},
		// 				NodeCount: to.Ptr[int32](4),
		// 				NodeSize: to.Ptr(armsynapse.NodeSizeMedium),
		// 				NodeSizeFamily: to.Ptr(armsynapse.NodeSizeFamilyMemoryOptimized),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SparkEventsFolder: to.Ptr("/events"),
		// 				SparkVersion: to.Ptr("3.3"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("ExamplePool2"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools"),
		// 			ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool2"),
		// 			Location: to.Ptr("West US 2"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armsynapse.BigDataPoolResourceProperties{
		// 				AutoPause: &armsynapse.AutoPauseProperties{
		// 					DelayInMinutes: to.Ptr[int32](15),
		// 					Enabled: to.Ptr(true),
		// 				},
		// 				AutoScale: &armsynapse.AutoScaleProperties{
		// 					Enabled: to.Ptr(true),
		// 					MaxNodeCount: to.Ptr[int32](50),
		// 					MinNodeCount: to.Ptr[int32](3),
		// 				},
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 				DefaultSparkLogFolder: to.Ptr("/logs"),
		// 				IsAutotuneEnabled: to.Ptr(false),
		// 				LibraryRequirements: &armsynapse.LibraryRequirements{
		// 					Content: to.Ptr(""),
		// 					Filename: to.Ptr("requirements.txt"),
		// 					Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 				},
		// 				NodeCount: to.Ptr[int32](4),
		// 				NodeSize: to.Ptr(armsynapse.NodeSizeMedium),
		// 				NodeSizeFamily: to.Ptr(armsynapse.NodeSizeFamilyMemoryOptimized),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SparkEventsFolder: to.Ptr("/events"),
		// 				SparkVersion: to.Ptr("3.3"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*BigDataPoolsClient) Update 

func (client *BigDataPoolsClient) Update(ctx context.Context, resourceGroupName string, workspaceName string, bigDataPoolName string, bigDataPoolPatchInfo BigDataPoolPatchInfo, options *BigDataPoolsClientUpdateOptions) (BigDataPoolsClientUpdateResponse, error)

Update - Patch a Big Data pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • bigDataPoolName - Big Data pool name
  • bigDataPoolPatchInfo - The updated Big Data pool properties
  • options - BigDataPoolsClientUpdateOptions contains the optional parameters for the BigDataPoolsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/UpdateBigDataPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBigDataPoolsClient().Update(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExamplePool", armsynapse.BigDataPoolPatchInfo{
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BigDataPoolResourceInfo = armsynapse.BigDataPoolResourceInfo{
	// 	Name: to.Ptr("ExamplePool"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool"),
	// 	Location: to.Ptr("West US 2"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armsynapse.BigDataPoolResourceProperties{
	// 		AutoPause: &armsynapse.AutoPauseProperties{
	// 			DelayInMinutes: to.Ptr[int32](15),
	// 			Enabled: to.Ptr(true),
	// 		},
	// 		AutoScale: &armsynapse.AutoScaleProperties{
	// 			Enabled: to.Ptr(true),
	// 			MaxNodeCount: to.Ptr[int32](50),
	// 			MinNodeCount: to.Ptr[int32](3),
	// 		},
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		DefaultSparkLogFolder: to.Ptr("/logs"),
	// 		IsAutotuneEnabled: to.Ptr(false),
	// 		LibraryRequirements: &armsynapse.LibraryRequirements{
	// 			Content: to.Ptr(""),
	// 			Filename: to.Ptr("requirements.txt"),
	// 			Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		},
	// 		NodeCount: to.Ptr[int32](4),
	// 		NodeSize: to.Ptr(armsynapse.NodeSizeMedium),
	// 		NodeSizeFamily: to.Ptr(armsynapse.NodeSizeFamilyMemoryOptimized),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SparkEventsFolder: to.Ptr("/events"),
	// 		SparkVersion: to.Ptr("3.3"),
	// 	},
	// }
}

Output:

type BigDataPoolsClientBeginCreateOrUpdateOptions added in v0.2.0 

type BigDataPoolsClientBeginCreateOrUpdateOptions struct {
	// Whether to stop any running jobs in the Big Data pool
	Force *bool

	// Resumes the LRO from the provided token.
	ResumeToken string
}

BigDataPoolsClientBeginCreateOrUpdateOptions contains the optional parameters for the BigDataPoolsClient.BeginCreateOrUpdate method.

type BigDataPoolsClientBeginDeleteOptions added in v0.2.0 

type BigDataPoolsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BigDataPoolsClientBeginDeleteOptions contains the optional parameters for the BigDataPoolsClient.BeginDelete method.

type BigDataPoolsClientCreateOrUpdateResponse added in v0.2.0 

type BigDataPoolsClientCreateOrUpdateResponse struct {
	// A Big Data pool
	BigDataPoolResourceInfo
}

BigDataPoolsClientCreateOrUpdateResponse contains the response from method BigDataPoolsClient.BeginCreateOrUpdate.

type BigDataPoolsClientDeleteResponse added in v0.2.0 

type BigDataPoolsClientDeleteResponse struct {
	// A Big Data pool
	BigDataPoolResourceInfo
}

BigDataPoolsClientDeleteResponse contains the response from method BigDataPoolsClient.BeginDelete.

type BigDataPoolsClientGetOptions added in v0.2.0 

type BigDataPoolsClientGetOptions struct {
}

BigDataPoolsClientGetOptions contains the optional parameters for the BigDataPoolsClient.Get method.

type BigDataPoolsClientGetResponse added in v0.2.0 

type BigDataPoolsClientGetResponse struct {
	// A Big Data pool
	BigDataPoolResourceInfo
}

BigDataPoolsClientGetResponse contains the response from method BigDataPoolsClient.Get.

type BigDataPoolsClientListByWorkspaceOptions added in v0.2.0 

type BigDataPoolsClientListByWorkspaceOptions struct {
}

BigDataPoolsClientListByWorkspaceOptions contains the optional parameters for the BigDataPoolsClient.NewListByWorkspacePager method.

type BigDataPoolsClientListByWorkspaceResponse added in v0.2.0 

type BigDataPoolsClientListByWorkspaceResponse struct {
	// Collection of Big Data pool information
	BigDataPoolResourceInfoListResult
}

BigDataPoolsClientListByWorkspaceResponse contains the response from method BigDataPoolsClient.NewListByWorkspacePager.

type BigDataPoolsClientUpdateOptions added in v0.2.0 

type BigDataPoolsClientUpdateOptions struct {
}

BigDataPoolsClientUpdateOptions contains the optional parameters for the BigDataPoolsClient.Update method.

type BigDataPoolsClientUpdateResponse added in v0.2.0 

type BigDataPoolsClientUpdateResponse struct {
	// A Big Data pool
	BigDataPoolResourceInfo
}

BigDataPoolsClientUpdateResponse contains the response from method BigDataPoolsClient.Update.

type BlobAuditingPolicyName 

type BlobAuditingPolicyName string
const (
	BlobAuditingPolicyNameDefault BlobAuditingPolicyName = "default"
)

func PossibleBlobAuditingPolicyNameValues 

func PossibleBlobAuditingPolicyNameValues() []BlobAuditingPolicyName

PossibleBlobAuditingPolicyNameValues returns the possible values for the BlobAuditingPolicyName const type.

type BlobAuditingPolicyState 

type BlobAuditingPolicyState string

BlobAuditingPolicyState - Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. 

const (
	BlobAuditingPolicyStateDisabled BlobAuditingPolicyState = "Disabled"
	BlobAuditingPolicyStateEnabled  BlobAuditingPolicyState = "Enabled"
)

func PossibleBlobAuditingPolicyStateValues 

func PossibleBlobAuditingPolicyStateValues() []BlobAuditingPolicyState

PossibleBlobAuditingPolicyStateValues returns the possible values for the BlobAuditingPolicyState const type.

type BlobStorageEventType 

type BlobStorageEventType string

BlobStorageEventType - The name of blob storage event type to process. 

const (
	BlobStorageEventTypeMicrosoftStorageBlobCreated BlobStorageEventType = "Microsoft.Storage.BlobCreated"
	BlobStorageEventTypeMicrosoftStorageBlobRenamed BlobStorageEventType = "Microsoft.Storage.BlobRenamed"
)

func PossibleBlobStorageEventTypeValues 

func PossibleBlobStorageEventTypeValues() []BlobStorageEventType

PossibleBlobStorageEventTypeValues returns the possible values for the BlobStorageEventType const type.

type CheckNameAvailabilityRequest 

type CheckNameAvailabilityRequest struct {
	// Workspace name
	Name *string

	// Type: workspace
	Type *string
}

CheckNameAvailabilityRequest - A request about whether a workspace name is available

func (CheckNameAvailabilityRequest) MarshalJSON added in v0.6.0 

func (c CheckNameAvailabilityRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityRequest.

func (*CheckNameAvailabilityRequest) UnmarshalJSON added in v0.6.0 

func (c *CheckNameAvailabilityRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilityRequest.

type CheckNameAvailabilityResponse 

type CheckNameAvailabilityResponse struct {
	// Whether the workspace name is available
	Available *bool

	// Validation message
	Message *string

	// Workspace name
	Name *string

	// Reason the workspace name is or is not available
	Reason *string
}

CheckNameAvailabilityResponse - A response saying whether the workspace name is available

func (CheckNameAvailabilityResponse) MarshalJSON added in v0.6.0 

func (c CheckNameAvailabilityResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityResponse.

func (*CheckNameAvailabilityResponse) UnmarshalJSON added in v0.6.0 

func (c *CheckNameAvailabilityResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilityResponse.

type CheckNameResult 

type CheckNameResult struct {
	// Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
	Message *string

	// The name that was checked.
	Name *string

	// Specifies a Boolean value that indicates if the name is available.
	NameAvailable *bool

	// Message providing the reason why the given name is invalid.
	Reason *Reason
}

CheckNameResult - The result returned from a check name availability request.

func (CheckNameResult) MarshalJSON added in v0.6.0 

func (c CheckNameResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckNameResult.

func (*CheckNameResult) UnmarshalJSON added in v0.6.0 

func (c *CheckNameResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameResult.

type ClientFactory added in v0.7.0 

type ClientFactory struct {
	// contains filtered or unexported fields
}

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory added in v0.7.0 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewAzureADOnlyAuthenticationsClient added in v0.7.0 

func (c *ClientFactory) NewAzureADOnlyAuthenticationsClient() *AzureADOnlyAuthenticationsClient

NewAzureADOnlyAuthenticationsClient creates a new instance of AzureADOnlyAuthenticationsClient.

func (*ClientFactory) NewBigDataPoolsClient added in v0.7.0 

func (c *ClientFactory) NewBigDataPoolsClient() *BigDataPoolsClient

NewBigDataPoolsClient creates a new instance of BigDataPoolsClient.

func (*ClientFactory) NewDataMaskingPoliciesClient added in v0.7.0 

func (c *ClientFactory) NewDataMaskingPoliciesClient() *DataMaskingPoliciesClient

NewDataMaskingPoliciesClient creates a new instance of DataMaskingPoliciesClient.

func (*ClientFactory) NewDataMaskingRulesClient added in v0.7.0 

func (c *ClientFactory) NewDataMaskingRulesClient() *DataMaskingRulesClient

NewDataMaskingRulesClient creates a new instance of DataMaskingRulesClient.

func (*ClientFactory) NewExtendedSQLPoolBlobAuditingPoliciesClient added in v0.7.0 

func (c *ClientFactory) NewExtendedSQLPoolBlobAuditingPoliciesClient() *ExtendedSQLPoolBlobAuditingPoliciesClient

NewExtendedSQLPoolBlobAuditingPoliciesClient creates a new instance of ExtendedSQLPoolBlobAuditingPoliciesClient.

func (*ClientFactory) NewGetClient added in v0.7.0 

func (c *ClientFactory) NewGetClient() *GetClient

NewGetClient creates a new instance of GetClient.

func (*ClientFactory) NewIPFirewallRulesClient added in v0.7.0 

func (c *ClientFactory) NewIPFirewallRulesClient() *IPFirewallRulesClient

NewIPFirewallRulesClient creates a new instance of IPFirewallRulesClient.

func (*ClientFactory) NewIntegrationRuntimeAuthKeysClient added in v0.7.0 

func (c *ClientFactory) NewIntegrationRuntimeAuthKeysClient() *IntegrationRuntimeAuthKeysClient

NewIntegrationRuntimeAuthKeysClient creates a new instance of IntegrationRuntimeAuthKeysClient.

func (*ClientFactory) NewIntegrationRuntimeConnectionInfosClient added in v0.7.0 

func (c *ClientFactory) NewIntegrationRuntimeConnectionInfosClient() *IntegrationRuntimeConnectionInfosClient

NewIntegrationRuntimeConnectionInfosClient creates a new instance of IntegrationRuntimeConnectionInfosClient.

func (*ClientFactory) NewIntegrationRuntimeCredentialsClient added in v0.7.0 

func (c *ClientFactory) NewIntegrationRuntimeCredentialsClient() *IntegrationRuntimeCredentialsClient

NewIntegrationRuntimeCredentialsClient creates a new instance of IntegrationRuntimeCredentialsClient.

func (*ClientFactory) NewIntegrationRuntimeMonitoringDataClient added in v0.7.0 

func (c *ClientFactory) NewIntegrationRuntimeMonitoringDataClient() *IntegrationRuntimeMonitoringDataClient

NewIntegrationRuntimeMonitoringDataClient creates a new instance of IntegrationRuntimeMonitoringDataClient.

func (*ClientFactory) NewIntegrationRuntimeNodeIPAddressClient added in v0.7.0 

func (c *ClientFactory) NewIntegrationRuntimeNodeIPAddressClient() *IntegrationRuntimeNodeIPAddressClient

NewIntegrationRuntimeNodeIPAddressClient creates a new instance of IntegrationRuntimeNodeIPAddressClient.

func (*ClientFactory) NewIntegrationRuntimeNodesClient added in v0.7.0 

func (c *ClientFactory) NewIntegrationRuntimeNodesClient() *IntegrationRuntimeNodesClient

NewIntegrationRuntimeNodesClient creates a new instance of IntegrationRuntimeNodesClient.

func (*ClientFactory) NewIntegrationRuntimeObjectMetadataClient added in v0.7.0 

func (c *ClientFactory) NewIntegrationRuntimeObjectMetadataClient() *IntegrationRuntimeObjectMetadataClient

NewIntegrationRuntimeObjectMetadataClient creates a new instance of IntegrationRuntimeObjectMetadataClient.

func (*ClientFactory) NewIntegrationRuntimeStatusClient added in v0.7.0 

func (c *ClientFactory) NewIntegrationRuntimeStatusClient() *IntegrationRuntimeStatusClient

NewIntegrationRuntimeStatusClient creates a new instance of IntegrationRuntimeStatusClient.

func (*ClientFactory) NewIntegrationRuntimesClient added in v0.7.0 

func (c *ClientFactory) NewIntegrationRuntimesClient() *IntegrationRuntimesClient

NewIntegrationRuntimesClient creates a new instance of IntegrationRuntimesClient.

func (*ClientFactory) NewKeysClient added in v0.7.0 

func (c *ClientFactory) NewKeysClient() *KeysClient

NewKeysClient creates a new instance of KeysClient.

func (*ClientFactory) NewKustoOperationsClient added in v0.7.0 

func (c *ClientFactory) NewKustoOperationsClient() *KustoOperationsClient

NewKustoOperationsClient creates a new instance of KustoOperationsClient.

func (*ClientFactory) NewKustoPoolAttachedDatabaseConfigurationsClient added in v0.7.0 

func (c *ClientFactory) NewKustoPoolAttachedDatabaseConfigurationsClient() *KustoPoolAttachedDatabaseConfigurationsClient

NewKustoPoolAttachedDatabaseConfigurationsClient creates a new instance of KustoPoolAttachedDatabaseConfigurationsClient.

func (*ClientFactory) NewKustoPoolChildResourceClient added in v0.7.0 

func (c *ClientFactory) NewKustoPoolChildResourceClient() *KustoPoolChildResourceClient

NewKustoPoolChildResourceClient creates a new instance of KustoPoolChildResourceClient.

func (*ClientFactory) NewKustoPoolDataConnectionsClient added in v0.7.0 

func (c *ClientFactory) NewKustoPoolDataConnectionsClient() *KustoPoolDataConnectionsClient

NewKustoPoolDataConnectionsClient creates a new instance of KustoPoolDataConnectionsClient.

func (*ClientFactory) NewKustoPoolDatabasePrincipalAssignmentsClient added in v0.7.0 

func (c *ClientFactory) NewKustoPoolDatabasePrincipalAssignmentsClient() *KustoPoolDatabasePrincipalAssignmentsClient

NewKustoPoolDatabasePrincipalAssignmentsClient creates a new instance of KustoPoolDatabasePrincipalAssignmentsClient.

func (*ClientFactory) NewKustoPoolDatabasesClient added in v0.7.0 

func (c *ClientFactory) NewKustoPoolDatabasesClient() *KustoPoolDatabasesClient

NewKustoPoolDatabasesClient creates a new instance of KustoPoolDatabasesClient.

func (*ClientFactory) NewKustoPoolPrincipalAssignmentsClient added in v0.7.0 

func (c *ClientFactory) NewKustoPoolPrincipalAssignmentsClient() *KustoPoolPrincipalAssignmentsClient

NewKustoPoolPrincipalAssignmentsClient creates a new instance of KustoPoolPrincipalAssignmentsClient.

func (*ClientFactory) NewKustoPoolPrivateLinkResourcesClient added in v0.7.0 

func (c *ClientFactory) NewKustoPoolPrivateLinkResourcesClient() *KustoPoolPrivateLinkResourcesClient

NewKustoPoolPrivateLinkResourcesClient creates a new instance of KustoPoolPrivateLinkResourcesClient.

func (*ClientFactory) NewKustoPoolsClient added in v0.7.0 

func (c *ClientFactory) NewKustoPoolsClient() *KustoPoolsClient

NewKustoPoolsClient creates a new instance of KustoPoolsClient.

func (*ClientFactory) NewLibrariesClient added in v0.7.0 

func (c *ClientFactory) NewLibrariesClient() *LibrariesClient

NewLibrariesClient creates a new instance of LibrariesClient.

func (*ClientFactory) NewLibraryClient added in v0.7.0 

func (c *ClientFactory) NewLibraryClient() *LibraryClient

NewLibraryClient creates a new instance of LibraryClient.

func (*ClientFactory) NewOperationsClient added in v0.7.0 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewPrivateEndpointConnectionsClient added in v0.7.0 

func (c *ClientFactory) NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient.

func (*ClientFactory) NewPrivateEndpointConnectionsPrivateLinkHubClient added in v0.7.0 

func (c *ClientFactory) NewPrivateEndpointConnectionsPrivateLinkHubClient() *PrivateEndpointConnectionsPrivateLinkHubClient

NewPrivateEndpointConnectionsPrivateLinkHubClient creates a new instance of PrivateEndpointConnectionsPrivateLinkHubClient.

func (*ClientFactory) NewPrivateLinkHubPrivateLinkResourcesClient added in v0.7.0 

func (c *ClientFactory) NewPrivateLinkHubPrivateLinkResourcesClient() *PrivateLinkHubPrivateLinkResourcesClient

NewPrivateLinkHubPrivateLinkResourcesClient creates a new instance of PrivateLinkHubPrivateLinkResourcesClient.

func (*ClientFactory) NewPrivateLinkHubsClient added in v0.7.0 

func (c *ClientFactory) NewPrivateLinkHubsClient() *PrivateLinkHubsClient

NewPrivateLinkHubsClient creates a new instance of PrivateLinkHubsClient.

func (*ClientFactory) NewPrivateLinkResourcesClient added in v0.7.0 

func (c *ClientFactory) NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient.

func (*ClientFactory) NewRestorableDroppedSQLPoolsClient added in v0.7.0 

func (c *ClientFactory) NewRestorableDroppedSQLPoolsClient() *RestorableDroppedSQLPoolsClient

NewRestorableDroppedSQLPoolsClient creates a new instance of RestorableDroppedSQLPoolsClient.

func (*ClientFactory) NewSQLPoolBlobAuditingPoliciesClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolBlobAuditingPoliciesClient() *SQLPoolBlobAuditingPoliciesClient

NewSQLPoolBlobAuditingPoliciesClient creates a new instance of SQLPoolBlobAuditingPoliciesClient.

func (*ClientFactory) NewSQLPoolColumnsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolColumnsClient() *SQLPoolColumnsClient

NewSQLPoolColumnsClient creates a new instance of SQLPoolColumnsClient.

func (*ClientFactory) NewSQLPoolConnectionPoliciesClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolConnectionPoliciesClient() *SQLPoolConnectionPoliciesClient

NewSQLPoolConnectionPoliciesClient creates a new instance of SQLPoolConnectionPoliciesClient.

func (*ClientFactory) NewSQLPoolDataWarehouseUserActivitiesClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolDataWarehouseUserActivitiesClient() *SQLPoolDataWarehouseUserActivitiesClient

NewSQLPoolDataWarehouseUserActivitiesClient creates a new instance of SQLPoolDataWarehouseUserActivitiesClient.

func (*ClientFactory) NewSQLPoolGeoBackupPoliciesClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolGeoBackupPoliciesClient() *SQLPoolGeoBackupPoliciesClient

NewSQLPoolGeoBackupPoliciesClient creates a new instance of SQLPoolGeoBackupPoliciesClient.

func (*ClientFactory) NewSQLPoolMaintenanceWindowOptionsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolMaintenanceWindowOptionsClient() *SQLPoolMaintenanceWindowOptionsClient

NewSQLPoolMaintenanceWindowOptionsClient creates a new instance of SQLPoolMaintenanceWindowOptionsClient.

func (*ClientFactory) NewSQLPoolMaintenanceWindowsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolMaintenanceWindowsClient() *SQLPoolMaintenanceWindowsClient

NewSQLPoolMaintenanceWindowsClient creates a new instance of SQLPoolMaintenanceWindowsClient.

func (*ClientFactory) NewSQLPoolMetadataSyncConfigsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolMetadataSyncConfigsClient() *SQLPoolMetadataSyncConfigsClient

NewSQLPoolMetadataSyncConfigsClient creates a new instance of SQLPoolMetadataSyncConfigsClient.

func (*ClientFactory) NewSQLPoolOperationResultsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolOperationResultsClient() *SQLPoolOperationResultsClient

NewSQLPoolOperationResultsClient creates a new instance of SQLPoolOperationResultsClient.

func (*ClientFactory) NewSQLPoolOperationsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolOperationsClient() *SQLPoolOperationsClient

NewSQLPoolOperationsClient creates a new instance of SQLPoolOperationsClient.

func (*ClientFactory) NewSQLPoolRecommendedSensitivityLabelsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolRecommendedSensitivityLabelsClient() *SQLPoolRecommendedSensitivityLabelsClient

NewSQLPoolRecommendedSensitivityLabelsClient creates a new instance of SQLPoolRecommendedSensitivityLabelsClient.

func (*ClientFactory) NewSQLPoolReplicationLinksClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolReplicationLinksClient() *SQLPoolReplicationLinksClient

NewSQLPoolReplicationLinksClient creates a new instance of SQLPoolReplicationLinksClient.

func (*ClientFactory) NewSQLPoolRestorePointsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolRestorePointsClient() *SQLPoolRestorePointsClient

NewSQLPoolRestorePointsClient creates a new instance of SQLPoolRestorePointsClient.

func (*ClientFactory) NewSQLPoolSchemasClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolSchemasClient() *SQLPoolSchemasClient

NewSQLPoolSchemasClient creates a new instance of SQLPoolSchemasClient.

func (*ClientFactory) NewSQLPoolSecurityAlertPoliciesClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolSecurityAlertPoliciesClient() *SQLPoolSecurityAlertPoliciesClient

NewSQLPoolSecurityAlertPoliciesClient creates a new instance of SQLPoolSecurityAlertPoliciesClient.

func (*ClientFactory) NewSQLPoolSensitivityLabelsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolSensitivityLabelsClient() *SQLPoolSensitivityLabelsClient

NewSQLPoolSensitivityLabelsClient creates a new instance of SQLPoolSensitivityLabelsClient.

func (*ClientFactory) NewSQLPoolTableColumnsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolTableColumnsClient() *SQLPoolTableColumnsClient

NewSQLPoolTableColumnsClient creates a new instance of SQLPoolTableColumnsClient.

func (*ClientFactory) NewSQLPoolTablesClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolTablesClient() *SQLPoolTablesClient

NewSQLPoolTablesClient creates a new instance of SQLPoolTablesClient.

func (*ClientFactory) NewSQLPoolTransparentDataEncryptionsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolTransparentDataEncryptionsClient() *SQLPoolTransparentDataEncryptionsClient

NewSQLPoolTransparentDataEncryptionsClient creates a new instance of SQLPoolTransparentDataEncryptionsClient.

func (*ClientFactory) NewSQLPoolUsagesClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolUsagesClient() *SQLPoolUsagesClient

NewSQLPoolUsagesClient creates a new instance of SQLPoolUsagesClient.

func (*ClientFactory) NewSQLPoolVulnerabilityAssessmentRuleBaselinesClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolVulnerabilityAssessmentRuleBaselinesClient() *SQLPoolVulnerabilityAssessmentRuleBaselinesClient

NewSQLPoolVulnerabilityAssessmentRuleBaselinesClient creates a new instance of SQLPoolVulnerabilityAssessmentRuleBaselinesClient.

func (*ClientFactory) NewSQLPoolVulnerabilityAssessmentScansClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolVulnerabilityAssessmentScansClient() *SQLPoolVulnerabilityAssessmentScansClient

NewSQLPoolVulnerabilityAssessmentScansClient creates a new instance of SQLPoolVulnerabilityAssessmentScansClient.

func (*ClientFactory) NewSQLPoolVulnerabilityAssessmentsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolVulnerabilityAssessmentsClient() *SQLPoolVulnerabilityAssessmentsClient

NewSQLPoolVulnerabilityAssessmentsClient creates a new instance of SQLPoolVulnerabilityAssessmentsClient.

func (*ClientFactory) NewSQLPoolWorkloadClassifierClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolWorkloadClassifierClient() *SQLPoolWorkloadClassifierClient

NewSQLPoolWorkloadClassifierClient creates a new instance of SQLPoolWorkloadClassifierClient.

func (*ClientFactory) NewSQLPoolWorkloadGroupClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolWorkloadGroupClient() *SQLPoolWorkloadGroupClient

NewSQLPoolWorkloadGroupClient creates a new instance of SQLPoolWorkloadGroupClient.

func (*ClientFactory) NewSQLPoolsClient added in v0.7.0 

func (c *ClientFactory) NewSQLPoolsClient() *SQLPoolsClient

NewSQLPoolsClient creates a new instance of SQLPoolsClient.

func (*ClientFactory) NewSparkConfigurationClient added in v0.7.0 

func (c *ClientFactory) NewSparkConfigurationClient() *SparkConfigurationClient

NewSparkConfigurationClient creates a new instance of SparkConfigurationClient.

func (*ClientFactory) NewSparkConfigurationsClient added in v0.7.0 

func (c *ClientFactory) NewSparkConfigurationsClient() *SparkConfigurationsClient

NewSparkConfigurationsClient creates a new instance of SparkConfigurationsClient.

func (*ClientFactory) NewWorkspaceAADAdminsClient added in v0.7.0 

func (c *ClientFactory) NewWorkspaceAADAdminsClient() *WorkspaceAADAdminsClient

NewWorkspaceAADAdminsClient creates a new instance of WorkspaceAADAdminsClient.

func (*ClientFactory) NewWorkspaceManagedIdentitySQLControlSettingsClient added in v0.7.0 

func (c *ClientFactory) NewWorkspaceManagedIdentitySQLControlSettingsClient() *WorkspaceManagedIdentitySQLControlSettingsClient

NewWorkspaceManagedIdentitySQLControlSettingsClient creates a new instance of WorkspaceManagedIdentitySQLControlSettingsClient.

func (*ClientFactory) NewWorkspaceManagedSQLServerBlobAuditingPoliciesClient added in v0.7.0 

func (c *ClientFactory) NewWorkspaceManagedSQLServerBlobAuditingPoliciesClient() *WorkspaceManagedSQLServerBlobAuditingPoliciesClient

NewWorkspaceManagedSQLServerBlobAuditingPoliciesClient creates a new instance of WorkspaceManagedSQLServerBlobAuditingPoliciesClient.

func (*ClientFactory) NewWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient added in v0.7.0 

func (c *ClientFactory) NewWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient() *WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient

NewWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient creates a new instance of WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient.

func (*ClientFactory) NewWorkspaceManagedSQLServerEncryptionProtectorClient added in v0.7.0 

func (c *ClientFactory) NewWorkspaceManagedSQLServerEncryptionProtectorClient() *WorkspaceManagedSQLServerEncryptionProtectorClient

NewWorkspaceManagedSQLServerEncryptionProtectorClient creates a new instance of WorkspaceManagedSQLServerEncryptionProtectorClient.

func (*ClientFactory) NewWorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient added in v0.7.0 

func (c *ClientFactory) NewWorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient() *WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient

NewWorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient creates a new instance of WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient.

func (*ClientFactory) NewWorkspaceManagedSQLServerRecoverableSQLPoolsClient added in v0.7.0 

func (c *ClientFactory) NewWorkspaceManagedSQLServerRecoverableSQLPoolsClient() *WorkspaceManagedSQLServerRecoverableSQLPoolsClient

NewWorkspaceManagedSQLServerRecoverableSQLPoolsClient creates a new instance of WorkspaceManagedSQLServerRecoverableSQLPoolsClient.

func (*ClientFactory) NewWorkspaceManagedSQLServerSecurityAlertPolicyClient added in v0.7.0 

func (c *ClientFactory) NewWorkspaceManagedSQLServerSecurityAlertPolicyClient() *WorkspaceManagedSQLServerSecurityAlertPolicyClient

NewWorkspaceManagedSQLServerSecurityAlertPolicyClient creates a new instance of WorkspaceManagedSQLServerSecurityAlertPolicyClient.

func (*ClientFactory) NewWorkspaceManagedSQLServerUsagesClient added in v0.7.0 

func (c *ClientFactory) NewWorkspaceManagedSQLServerUsagesClient() *WorkspaceManagedSQLServerUsagesClient

NewWorkspaceManagedSQLServerUsagesClient creates a new instance of WorkspaceManagedSQLServerUsagesClient.

func (*ClientFactory) NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient added in v0.7.0 

func (c *ClientFactory) NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient() *WorkspaceManagedSQLServerVulnerabilityAssessmentsClient

NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient creates a new instance of WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.

func (*ClientFactory) NewWorkspaceSQLAADAdminsClient added in v0.7.0 

func (c *ClientFactory) NewWorkspaceSQLAADAdminsClient() *WorkspaceSQLAADAdminsClient

NewWorkspaceSQLAADAdminsClient creates a new instance of WorkspaceSQLAADAdminsClient.

func (*ClientFactory) NewWorkspacesClient added in v0.7.0 

func (c *ClientFactory) NewWorkspacesClient() *WorkspacesClient

NewWorkspacesClient creates a new instance of WorkspacesClient.

type ClusterPrincipalAssignment 

type ClusterPrincipalAssignment struct {
	// The cluster principal.
	Properties *ClusterPrincipalProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ClusterPrincipalAssignment - Class representing a cluster principal assignment.

func (ClusterPrincipalAssignment) MarshalJSON 

func (c ClusterPrincipalAssignment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterPrincipalAssignment.

func (*ClusterPrincipalAssignment) UnmarshalJSON 

func (c *ClusterPrincipalAssignment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterPrincipalAssignment.

type ClusterPrincipalAssignmentCheckNameRequest 

type ClusterPrincipalAssignmentCheckNameRequest struct {
	// REQUIRED; Principal Assignment resource name.
	Name *string

	// CONSTANT; The type of resource, Microsoft.Synapse/workspaces/kustoPools/principalAssignments.
	// Field has constant value "Microsoft.Synapse/workspaces/kustoPools/principalAssignments", any specified value is ignored.
	Type *string
}

ClusterPrincipalAssignmentCheckNameRequest - A principal assignment check name availability request.

func (ClusterPrincipalAssignmentCheckNameRequest) MarshalJSON added in v0.6.0 

func (c ClusterPrincipalAssignmentCheckNameRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterPrincipalAssignmentCheckNameRequest.

func (*ClusterPrincipalAssignmentCheckNameRequest) UnmarshalJSON added in v0.6.0 

func (c *ClusterPrincipalAssignmentCheckNameRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterPrincipalAssignmentCheckNameRequest.

type ClusterPrincipalAssignmentListResult 

type ClusterPrincipalAssignmentListResult struct {
	// The list of Kusto cluster principal assignments.
	Value []*ClusterPrincipalAssignment
}

ClusterPrincipalAssignmentListResult - The list Kusto cluster principal assignments operation response.

func (ClusterPrincipalAssignmentListResult) MarshalJSON 

func (c ClusterPrincipalAssignmentListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterPrincipalAssignmentListResult.

func (*ClusterPrincipalAssignmentListResult) UnmarshalJSON added in v0.6.0 

func (c *ClusterPrincipalAssignmentListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterPrincipalAssignmentListResult.

type ClusterPrincipalProperties 

type ClusterPrincipalProperties struct {
	// REQUIRED; The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group
	// name.
	PrincipalID *string

	// REQUIRED; Principal type.
	PrincipalType *PrincipalType

	// REQUIRED; Cluster principal role.
	Role *ClusterPrincipalRole

	// The tenant id of the principal
	TenantID *string

	// READ-ONLY; The service principal object id in AAD (Azure active directory)
	AADObjectID *string

	// READ-ONLY; The principal name
	PrincipalName *string

	// READ-ONLY; The provisioned state of the resource.
	ProvisioningState *ResourceProvisioningState

	// READ-ONLY; The tenant name of the principal
	TenantName *string
}

ClusterPrincipalProperties - A class representing cluster principal property.

func (ClusterPrincipalProperties) MarshalJSON added in v0.6.0 

func (c ClusterPrincipalProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterPrincipalProperties.

func (*ClusterPrincipalProperties) UnmarshalJSON added in v0.6.0 

func (c *ClusterPrincipalProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterPrincipalProperties.

type ClusterPrincipalRole 

type ClusterPrincipalRole string

ClusterPrincipalRole - Cluster principal role. 

const (
	ClusterPrincipalRoleAllDatabasesAdmin  ClusterPrincipalRole = "AllDatabasesAdmin"
	ClusterPrincipalRoleAllDatabasesViewer ClusterPrincipalRole = "AllDatabasesViewer"
)

func PossibleClusterPrincipalRoleValues 

func PossibleClusterPrincipalRoleValues() []ClusterPrincipalRole

PossibleClusterPrincipalRoleValues returns the possible values for the ClusterPrincipalRole const type.

type CmdkeySetup 

type CmdkeySetup struct {
	// REQUIRED; The type of custom setup.
	Type *string

	// REQUIRED; Cmdkey command custom setup type properties.
	TypeProperties *CmdkeySetupTypeProperties
}

CmdkeySetup - The custom setup of running cmdkey commands.

func (*CmdkeySetup) GetCustomSetupBase added in v0.2.0 

func (c *CmdkeySetup) GetCustomSetupBase() *CustomSetupBase

GetCustomSetupBase implements the CustomSetupBaseClassification interface for type CmdkeySetup.

func (CmdkeySetup) MarshalJSON 

func (c CmdkeySetup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CmdkeySetup.

func (*CmdkeySetup) UnmarshalJSON 

func (c *CmdkeySetup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CmdkeySetup.

type CmdkeySetupTypeProperties 

type CmdkeySetupTypeProperties struct {
	// REQUIRED; The password of data source access.
	Password SecretBaseClassification

	// REQUIRED; The server name of data source access.
	TargetName any

	// REQUIRED; The user name of data source access.
	UserName any
}

CmdkeySetupTypeProperties - Cmdkey command custom setup type properties.

func (CmdkeySetupTypeProperties) MarshalJSON 

func (c CmdkeySetupTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CmdkeySetupTypeProperties.

func (*CmdkeySetupTypeProperties) UnmarshalJSON 

func (c *CmdkeySetupTypeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CmdkeySetupTypeProperties.

type ColumnDataType 

type ColumnDataType string

ColumnDataType - The column data type. 

const (
	ColumnDataTypeBigint           ColumnDataType = "bigint"
	ColumnDataTypeBinary           ColumnDataType = "binary"
	ColumnDataTypeBit              ColumnDataType = "bit"
	ColumnDataTypeChar             ColumnDataType = "char"
	ColumnDataTypeDate             ColumnDataType = "date"
	ColumnDataTypeDatetime         ColumnDataType = "datetime"
	ColumnDataTypeDatetime2        ColumnDataType = "datetime2"
	ColumnDataTypeDatetimeoffset   ColumnDataType = "datetimeoffset"
	ColumnDataTypeDecimal          ColumnDataType = "decimal"
	ColumnDataTypeFloat            ColumnDataType = "float"
	ColumnDataTypeGeography        ColumnDataType = "geography"
	ColumnDataTypeGeometry         ColumnDataType = "geometry"
	ColumnDataTypeHierarchyid      ColumnDataType = "hierarchyid"
	ColumnDataTypeImage            ColumnDataType = "image"
	ColumnDataTypeInt              ColumnDataType = "int"
	ColumnDataTypeMoney            ColumnDataType = "money"
	ColumnDataTypeNchar            ColumnDataType = "nchar"
	ColumnDataTypeNtext            ColumnDataType = "ntext"
	ColumnDataTypeNumeric          ColumnDataType = "numeric"
	ColumnDataTypeNvarchar         ColumnDataType = "nvarchar"
	ColumnDataTypeReal             ColumnDataType = "real"
	ColumnDataTypeSQLVariant       ColumnDataType = "sql_variant"
	ColumnDataTypeSmalldatetime    ColumnDataType = "smalldatetime"
	ColumnDataTypeSmallint         ColumnDataType = "smallint"
	ColumnDataTypeSmallmoney       ColumnDataType = "smallmoney"
	ColumnDataTypeSysname          ColumnDataType = "sysname"
	ColumnDataTypeText             ColumnDataType = "text"
	ColumnDataTypeTime             ColumnDataType = "time"
	ColumnDataTypeTimestamp        ColumnDataType = "timestamp"
	ColumnDataTypeTinyint          ColumnDataType = "tinyint"
	ColumnDataTypeUniqueidentifier ColumnDataType = "uniqueidentifier"
	ColumnDataTypeVarbinary        ColumnDataType = "varbinary"
	ColumnDataTypeVarchar          ColumnDataType = "varchar"
	ColumnDataTypeXML              ColumnDataType = "xml"
)

func PossibleColumnDataTypeValues 

func PossibleColumnDataTypeValues() []ColumnDataType

PossibleColumnDataTypeValues returns the possible values for the ColumnDataType const type.

type ComponentSetup 

type ComponentSetup struct {
	// REQUIRED; The type of custom setup.
	Type *string

	// REQUIRED; Install 3rd party component type properties.
	TypeProperties *LicensedComponentSetupTypeProperties
}

ComponentSetup - The custom setup of installing 3rd party components.

func (*ComponentSetup) GetCustomSetupBase added in v0.2.0 

func (c *ComponentSetup) GetCustomSetupBase() *CustomSetupBase

GetCustomSetupBase implements the CustomSetupBaseClassification interface for type ComponentSetup.

func (ComponentSetup) MarshalJSON 

func (c ComponentSetup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComponentSetup.

func (*ComponentSetup) UnmarshalJSON 

func (c *ComponentSetup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComponentSetup.

type Compression 

type Compression string

Compression - The compression type 

const (
	CompressionGZip Compression = "GZip"
	CompressionNone Compression = "None"
)

func PossibleCompressionValues 

func PossibleCompressionValues() []Compression

PossibleCompressionValues returns the possible values for the Compression const type.

type ConfigurationType 

type ConfigurationType string

ConfigurationType - The type of the spark config properties file. 

const (
	ConfigurationTypeArtifact ConfigurationType = "Artifact"
	ConfigurationTypeFile     ConfigurationType = "File"
)

func PossibleConfigurationTypeValues 

func PossibleConfigurationTypeValues() []ConfigurationType

PossibleConfigurationTypeValues returns the possible values for the ConfigurationType const type.

type ConnectionPolicyName 

type ConnectionPolicyName string
const (
	ConnectionPolicyNameDefault ConnectionPolicyName = "default"
)

func PossibleConnectionPolicyNameValues 

func PossibleConnectionPolicyNameValues() []ConnectionPolicyName

PossibleConnectionPolicyNameValues returns the possible values for the ConnectionPolicyName const type.

type CreateMode 

type CreateMode string

CreateMode - Specifies the mode of sql pool creation. Default: regular sql pool creation. PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified. Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified. 

const (
	CreateModeDefault            CreateMode = "Default"
	CreateModePointInTimeRestore CreateMode = "PointInTimeRestore"
	CreateModeRecovery           CreateMode = "Recovery"
	CreateModeRestore            CreateMode = "Restore"
)

func PossibleCreateModeValues 

func PossibleCreateModeValues() []CreateMode

PossibleCreateModeValues returns the possible values for the CreateMode const type.

type CreateSQLPoolRestorePointDefinition 

type CreateSQLPoolRestorePointDefinition struct {
	// REQUIRED; The restore point label to apply
	RestorePointLabel *string
}

CreateSQLPoolRestorePointDefinition - Contains the information necessary to perform a create Sql pool restore point operation.

func (CreateSQLPoolRestorePointDefinition) MarshalJSON added in v0.6.0 

func (c CreateSQLPoolRestorePointDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CreateSQLPoolRestorePointDefinition.

func (*CreateSQLPoolRestorePointDefinition) UnmarshalJSON added in v0.6.0 

func (c *CreateSQLPoolRestorePointDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CreateSQLPoolRestorePointDefinition.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type CspWorkspaceAdminProperties 

type CspWorkspaceAdminProperties struct {
	// AAD object ID of initial workspace admin
	InitialWorkspaceAdminObjectID *string
}

CspWorkspaceAdminProperties - Initial workspace AAD admin properties for a CSP subscription

func (CspWorkspaceAdminProperties) MarshalJSON added in v0.6.0 

func (c CspWorkspaceAdminProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CspWorkspaceAdminProperties.

func (*CspWorkspaceAdminProperties) UnmarshalJSON added in v0.6.0 

func (c *CspWorkspaceAdminProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CspWorkspaceAdminProperties.

type CustomSetupBase 

type CustomSetupBase struct {
	// REQUIRED; The type of custom setup.
	Type *string
}

CustomSetupBase - The base definition of the custom setup.

func (*CustomSetupBase) GetCustomSetupBase 

func (c *CustomSetupBase) GetCustomSetupBase() *CustomSetupBase

GetCustomSetupBase implements the CustomSetupBaseClassification interface for type CustomSetupBase.

func (CustomSetupBase) MarshalJSON added in v0.6.0 

func (c CustomSetupBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomSetupBase.

func (*CustomSetupBase) UnmarshalJSON 

func (c *CustomSetupBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomSetupBase.

type CustomSetupBaseClassification 

type CustomSetupBaseClassification interface {
	// GetCustomSetupBase returns the CustomSetupBase content of the underlying type.
	GetCustomSetupBase() *CustomSetupBase
}

CustomSetupBaseClassification provides polymorphic access to related types. Call the interface's GetCustomSetupBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CmdkeySetup, *ComponentSetup, *CustomSetupBase, *EnvironmentVariableSetup

type CustomerManagedKeyDetails 

type CustomerManagedKeyDetails struct {
	// Key encryption key
	KekIdentity *KekIdentityProperties

	// The key object of the workspace
	Key *WorkspaceKeyDetails

	// READ-ONLY; The customer managed key status on the workspace
	Status *string
}

CustomerManagedKeyDetails - Details of the customer managed key associated with the workspace

func (CustomerManagedKeyDetails) MarshalJSON added in v0.6.0 

func (c CustomerManagedKeyDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomerManagedKeyDetails.

func (*CustomerManagedKeyDetails) UnmarshalJSON added in v0.6.0 

func (c *CustomerManagedKeyDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomerManagedKeyDetails.

type DataConnection 

type DataConnection struct {
	// REQUIRED; Kind of the endpoint for the data connection
	Kind *DataConnectionKind

	// Resource location.
	Location *string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DataConnection - Class representing a data connection.

func (*DataConnection) GetDataConnection 

func (d *DataConnection) GetDataConnection() *DataConnection

GetDataConnection implements the DataConnectionClassification interface for type DataConnection.

func (DataConnection) MarshalJSON added in v0.2.0 

func (d DataConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataConnection.

func (*DataConnection) UnmarshalJSON 

func (d *DataConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataConnection.

type DataConnectionCheckNameRequest 

type DataConnectionCheckNameRequest struct {
	// REQUIRED; Data Connection name.
	Name *string

	// CONSTANT; The type of resource, Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections.
	// Field has constant value "Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections", any specified value is ignored.
	Type *string
}

DataConnectionCheckNameRequest - A data connection check name availability request.

func (DataConnectionCheckNameRequest) MarshalJSON added in v0.6.0 

func (d DataConnectionCheckNameRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataConnectionCheckNameRequest.

func (*DataConnectionCheckNameRequest) UnmarshalJSON added in v0.6.0 

func (d *DataConnectionCheckNameRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataConnectionCheckNameRequest.

type DataConnectionClassification 

type DataConnectionClassification interface {
	// GetDataConnection returns the DataConnection content of the underlying type.
	GetDataConnection() *DataConnection
}

DataConnectionClassification provides polymorphic access to related types. Call the interface's GetDataConnection() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *DataConnection, *EventGridDataConnection, *EventHubDataConnection, *IotHubDataConnection

type DataConnectionKind 

type DataConnectionKind string

DataConnectionKind - Kind of the endpoint for the data connection 

const (
	DataConnectionKindEventGrid DataConnectionKind = "EventGrid"
	DataConnectionKindEventHub  DataConnectionKind = "EventHub"
	DataConnectionKindIotHub    DataConnectionKind = "IotHub"
)

func PossibleDataConnectionKindValues 

func PossibleDataConnectionKindValues() []DataConnectionKind

PossibleDataConnectionKindValues returns the possible values for the DataConnectionKind const type.

type DataConnectionListResult 

type DataConnectionListResult struct {
	// The list of Kusto data connections.
	Value []DataConnectionClassification
}

DataConnectionListResult - The list Kusto data connections operation response.

func (DataConnectionListResult) MarshalJSON 

func (d DataConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataConnectionListResult.

func (*DataConnectionListResult) UnmarshalJSON 

func (d *DataConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataConnectionListResult.

type DataConnectionValidation 

type DataConnectionValidation struct {
	// The name of the data connection.
	DataConnectionName *string

	// The data connection properties to validate.
	Properties DataConnectionClassification
}

DataConnectionValidation - Class representing an data connection validation.

func (DataConnectionValidation) MarshalJSON 

func (d DataConnectionValidation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataConnectionValidation.

func (*DataConnectionValidation) UnmarshalJSON 

func (d *DataConnectionValidation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataConnectionValidation.

type DataConnectionValidationListResult 

type DataConnectionValidationListResult struct {
	// The list of Kusto data connection validation errors.
	Value []*DataConnectionValidationResult
}

DataConnectionValidationListResult - The list Kusto data connection validation result.

func (DataConnectionValidationListResult) MarshalJSON 

func (d DataConnectionValidationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataConnectionValidationListResult.

func (*DataConnectionValidationListResult) UnmarshalJSON added in v0.6.0 

func (d *DataConnectionValidationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataConnectionValidationListResult.

type DataConnectionValidationResult 

type DataConnectionValidationResult struct {
	// A message which indicates a problem in data connection validation.
	ErrorMessage *string
}

DataConnectionValidationResult - The result returned from a data connection validation request.

func (DataConnectionValidationResult) MarshalJSON added in v0.6.0 

func (d DataConnectionValidationResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataConnectionValidationResult.

func (*DataConnectionValidationResult) UnmarshalJSON added in v0.6.0 

func (d *DataConnectionValidationResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataConnectionValidationResult.

type DataFlowComputeType 

type DataFlowComputeType string

DataFlowComputeType - Compute type of the cluster which will execute data flow job. 

const (
	DataFlowComputeTypeComputeOptimized DataFlowComputeType = "ComputeOptimized"
	DataFlowComputeTypeGeneral          DataFlowComputeType = "General"
	DataFlowComputeTypeMemoryOptimized  DataFlowComputeType = "MemoryOptimized"
)

func PossibleDataFlowComputeTypeValues 

func PossibleDataFlowComputeTypeValues() []DataFlowComputeType

PossibleDataFlowComputeTypeValues returns the possible values for the DataFlowComputeType const type.

type DataLakeStorageAccountDetails 

type DataLakeStorageAccountDetails struct {
	// Account URL
	AccountURL *string

	// Create managed private endpoint to this storage account or not
	CreateManagedPrivateEndpoint *bool

	// Filesystem name
	Filesystem *string

	// ARM resource Id of this storage account
	ResourceID *string
}

DataLakeStorageAccountDetails - Details of the data lake storage account associated with the workspace

func (DataLakeStorageAccountDetails) MarshalJSON added in v0.6.0 

func (d DataLakeStorageAccountDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataLakeStorageAccountDetails.

func (*DataLakeStorageAccountDetails) UnmarshalJSON added in v0.6.0 

func (d *DataLakeStorageAccountDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataLakeStorageAccountDetails.

type DataMaskingFunction 

type DataMaskingFunction string

DataMaskingFunction - The masking function that is used for the data masking rule. 

const (
	DataMaskingFunctionCCN     DataMaskingFunction = "CCN"
	DataMaskingFunctionDefault DataMaskingFunction = "Default"
	DataMaskingFunctionEmail   DataMaskingFunction = "Email"
	DataMaskingFunctionNumber  DataMaskingFunction = "Number"
	DataMaskingFunctionSSN     DataMaskingFunction = "SSN"
	DataMaskingFunctionText    DataMaskingFunction = "Text"
)

func PossibleDataMaskingFunctionValues 

func PossibleDataMaskingFunctionValues() []DataMaskingFunction

PossibleDataMaskingFunctionValues returns the possible values for the DataMaskingFunction const type.

type DataMaskingPoliciesClient 

type DataMaskingPoliciesClient struct {
	// contains filtered or unexported fields
}

DataMaskingPoliciesClient contains the methods for the DataMaskingPolicies group. Don't use this type directly, use NewDataMaskingPoliciesClient() instead.

func NewDataMaskingPoliciesClient 

func NewDataMaskingPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DataMaskingPoliciesClient, error)

NewDataMaskingPoliciesClient creates a new instance of DataMaskingPoliciesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DataMaskingPoliciesClient) CreateOrUpdate 

func (client *DataMaskingPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, parameters DataMaskingPolicy, options *DataMaskingPoliciesClientCreateOrUpdateOptions) (DataMaskingPoliciesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a Sql pool data masking policy If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • parameters - Parameters for creating or updating a data masking policy.
  • options - DataMaskingPoliciesClientCreateOrUpdateOptions contains the optional parameters for the DataMaskingPoliciesClient.CreateOrUpdate method.
Example (CreateOrUpdateDataMaskingPolicyMax)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DataMaskingPolicyCreateOrUpdateMax.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataMaskingPoliciesClient().CreateOrUpdate(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", armsynapse.DataMaskingPolicy{
		Properties: &armsynapse.DataMaskingPolicyProperties{
			DataMaskingState: to.Ptr(armsynapse.DataMaskingStateEnabled),
			ExemptPrincipals: to.Ptr("testuser;"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataMaskingPolicy = armsynapse.DataMaskingPolicy{
	// 	Name: to.Ptr("Default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default"),
	// 	Location: to.Ptr("Central US"),
	// 	ManagedBy: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331"),
	// 	Properties: &armsynapse.DataMaskingPolicyProperties{
	// 		ApplicationPrincipals: to.Ptr(""),
	// 		DataMaskingState: to.Ptr(armsynapse.DataMaskingStateEnabled),
	// 		ExemptPrincipals: to.Ptr("testuser;"),
	// 		MaskingLevel: to.Ptr(""),
	// 	},
	// }
}

Output:
Example (CreateOrUpdateDataMaskingPolicyMin)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DataMaskingPolicyCreateOrUpdateMin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataMaskingPoliciesClient().CreateOrUpdate(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", armsynapse.DataMaskingPolicy{
		Properties: &armsynapse.DataMaskingPolicyProperties{
			DataMaskingState: to.Ptr(armsynapse.DataMaskingStateEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataMaskingPolicy = armsynapse.DataMaskingPolicy{
	// 	Name: to.Ptr("Default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default"),
	// 	Location: to.Ptr("Central US"),
	// 	ManagedBy: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331"),
	// 	Properties: &armsynapse.DataMaskingPolicyProperties{
	// 		ApplicationPrincipals: to.Ptr(""),
	// 		DataMaskingState: to.Ptr(armsynapse.DataMaskingStateEnabled),
	// 		ExemptPrincipals: to.Ptr(""),
	// 		MaskingLevel: to.Ptr(""),
	// 	},
	// }
}

Output:

func (*DataMaskingPoliciesClient) Get 

func (client *DataMaskingPoliciesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, options *DataMaskingPoliciesClientGetOptions) (DataMaskingPoliciesClientGetResponse, error)

Get - Gets a Sql pool data masking policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - DataMaskingPoliciesClientGetOptions contains the optional parameters for the DataMaskingPoliciesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DataMaskingPolicyGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataMaskingPoliciesClient().Get(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataMaskingPolicy = armsynapse.DataMaskingPolicy{
	// 	Name: to.Ptr("Default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default"),
	// 	Location: to.Ptr("Central US"),
	// 	ManagedBy: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331"),
	// 	Properties: &armsynapse.DataMaskingPolicyProperties{
	// 		ApplicationPrincipals: to.Ptr(""),
	// 		DataMaskingState: to.Ptr(armsynapse.DataMaskingStateEnabled),
	// 		ExemptPrincipals: to.Ptr(""),
	// 		MaskingLevel: to.Ptr(""),
	// 	},
	// }
}

Output:

type DataMaskingPoliciesClientCreateOrUpdateOptions added in v0.2.0 

type DataMaskingPoliciesClientCreateOrUpdateOptions struct {
}

DataMaskingPoliciesClientCreateOrUpdateOptions contains the optional parameters for the DataMaskingPoliciesClient.CreateOrUpdate method.

type DataMaskingPoliciesClientCreateOrUpdateResponse added in v0.2.0 

type DataMaskingPoliciesClientCreateOrUpdateResponse struct {
	DataMaskingPolicy
}

DataMaskingPoliciesClientCreateOrUpdateResponse contains the response from method DataMaskingPoliciesClient.CreateOrUpdate.

type DataMaskingPoliciesClientGetOptions added in v0.2.0 

type DataMaskingPoliciesClientGetOptions struct {
}

DataMaskingPoliciesClientGetOptions contains the optional parameters for the DataMaskingPoliciesClient.Get method.

type DataMaskingPoliciesClientGetResponse added in v0.2.0 

type DataMaskingPoliciesClientGetResponse struct {
	DataMaskingPolicy
}

DataMaskingPoliciesClientGetResponse contains the response from method DataMaskingPoliciesClient.Get.

type DataMaskingPolicy 

type DataMaskingPolicy struct {
	// The properties of the data masking policy.
	Properties *DataMaskingPolicyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The kind of data masking policy. Metadata, used for Azure portal.
	Kind *string

	// READ-ONLY; The location of the data masking policy.
	Location *string

	// READ-ONLY; Fully qualified resource ID of the sql pool
	ManagedBy *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

func (DataMaskingPolicy) MarshalJSON 

func (d DataMaskingPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataMaskingPolicy.

func (*DataMaskingPolicy) UnmarshalJSON 

func (d *DataMaskingPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataMaskingPolicy.

type DataMaskingPolicyProperties 

type DataMaskingPolicyProperties struct {
	// REQUIRED; The state of the data masking policy.
	DataMaskingState *DataMaskingState

	// The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking
	// policy does not apply. The specified users receive data results without masking
	// for all of the database queries.
	ExemptPrincipals *string

	// READ-ONLY; The list of the application principals. This is a legacy parameter and is no longer used.
	ApplicationPrincipals *string

	// READ-ONLY; The masking level. This is a legacy parameter and is no longer used.
	MaskingLevel *string
}

DataMaskingPolicyProperties - The properties of a database data masking policy.

func (DataMaskingPolicyProperties) MarshalJSON added in v0.6.0 

func (d DataMaskingPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataMaskingPolicyProperties.

func (*DataMaskingPolicyProperties) UnmarshalJSON added in v0.6.0 

func (d *DataMaskingPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataMaskingPolicyProperties.

type DataMaskingRule 

type DataMaskingRule struct {
	// The properties of the resource.
	Properties *DataMaskingRuleProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The kind of Data Masking Rule. Metadata, used for Azure portal.
	Kind *string

	// READ-ONLY; The location of the data masking rule.
	Location *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DataMaskingRule - Represents a Sql pool data masking rule.

func (DataMaskingRule) MarshalJSON 

func (d DataMaskingRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataMaskingRule.

func (*DataMaskingRule) UnmarshalJSON 

func (d *DataMaskingRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataMaskingRule.

type DataMaskingRuleListResult 

type DataMaskingRuleListResult struct {
	// The list of Sql pool data masking rules.
	Value []*DataMaskingRule
}

DataMaskingRuleListResult - The response to a list data masking rules request.

func (DataMaskingRuleListResult) MarshalJSON 

func (d DataMaskingRuleListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataMaskingRuleListResult.

func (*DataMaskingRuleListResult) UnmarshalJSON added in v0.6.0 

func (d *DataMaskingRuleListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataMaskingRuleListResult.

type DataMaskingRuleProperties 

type DataMaskingRuleProperties struct {
	// REQUIRED; The column name on which the data masking rule is applied.
	ColumnName *string

	// REQUIRED; The masking function that is used for the data masking rule.
	MaskingFunction *DataMaskingFunction

	// REQUIRED; The schema name on which the data masking rule is applied.
	SchemaName *string

	// REQUIRED; The table name on which the data masking rule is applied.
	TableName *string

	// The alias name. This is a legacy parameter and is no longer used.
	AliasName *string

	// The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will
	// be ignored.
	NumberFrom *string

	// The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter
	// will be ignored.
	NumberTo *string

	// If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise,
	// this parameter will be ignored.
	PrefixSize *string

	// If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter
	// will be ignored.
	ReplacementString *string

	// The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction,
	// and specify ruleState as disabled. However, if the rule doesn't
	// already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState.
	RuleState *DataMaskingRuleState

	// If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this
	// parameter will be ignored.
	SuffixSize *string

	// READ-ONLY; The rule Id.
	ID *string
}

DataMaskingRuleProperties - The properties of a Sql pool data masking rule.

func (DataMaskingRuleProperties) MarshalJSON added in v0.6.0 

func (d DataMaskingRuleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataMaskingRuleProperties.

func (*DataMaskingRuleProperties) UnmarshalJSON added in v0.6.0 

func (d *DataMaskingRuleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataMaskingRuleProperties.

type DataMaskingRuleState 

type DataMaskingRuleState string

DataMaskingRuleState - The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. 

const (
	DataMaskingRuleStateDisabled DataMaskingRuleState = "Disabled"
	DataMaskingRuleStateEnabled  DataMaskingRuleState = "Enabled"
)

func PossibleDataMaskingRuleStateValues 

func PossibleDataMaskingRuleStateValues() []DataMaskingRuleState

PossibleDataMaskingRuleStateValues returns the possible values for the DataMaskingRuleState const type.

type DataMaskingRulesClient 

type DataMaskingRulesClient struct {
	// contains filtered or unexported fields
}

DataMaskingRulesClient contains the methods for the DataMaskingRules group. Don't use this type directly, use NewDataMaskingRulesClient() instead.

func NewDataMaskingRulesClient 

func NewDataMaskingRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DataMaskingRulesClient, error)

NewDataMaskingRulesClient creates a new instance of DataMaskingRulesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DataMaskingRulesClient) CreateOrUpdate 

func (client *DataMaskingRulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, dataMaskingRuleName string, parameters DataMaskingRule, options *DataMaskingRulesClientCreateOrUpdateOptions) (DataMaskingRulesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a Sql pool data masking rule. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • dataMaskingRuleName - The name of the data masking rule.
  • parameters - The required parameters for creating or updating a data masking rule.
  • options - DataMaskingRulesClientCreateOrUpdateOptions contains the optional parameters for the DataMaskingRulesClient.CreateOrUpdate method.
Example (CreateUpdateDataMaskingRuleForDefaultMax)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DataMaskingRuleCreateOrUpdateDefaultMax.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataMaskingRulesClient().CreateOrUpdate(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", "rule1", armsynapse.DataMaskingRule{
		Properties: &armsynapse.DataMaskingRuleProperties{
			AliasName:       to.Ptr("nickname"),
			ColumnName:      to.Ptr("test1"),
			MaskingFunction: to.Ptr(armsynapse.DataMaskingFunctionDefault),
			RuleState:       to.Ptr(armsynapse.DataMaskingRuleStateEnabled),
			SchemaName:      to.Ptr("dbo"),
			TableName:       to.Ptr("Table_1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataMaskingRule = armsynapse.DataMaskingRule{
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/"),
	// 	Location: to.Ptr("Central US"),
	// 	Properties: &armsynapse.DataMaskingRuleProperties{
	// 		AliasName: to.Ptr("nickname"),
	// 		ColumnName: to.Ptr("test1"),
	// 		ID: to.Ptr("dbo_Table_1_test1"),
	// 		MaskingFunction: to.Ptr(armsynapse.DataMaskingFunctionDefault),
	// 		RuleState: to.Ptr(armsynapse.DataMaskingRuleStateEnabled),
	// 		SchemaName: to.Ptr("dbo"),
	// 		TableName: to.Ptr("Table_1"),
	// 	},
	// }
}

Output:
Example (CreateUpdateDataMaskingRuleForDefaultMin)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DataMaskingRuleCreateOrUpdateDefaultMin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataMaskingRulesClient().CreateOrUpdate(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", "rule1", armsynapse.DataMaskingRule{
		Properties: &armsynapse.DataMaskingRuleProperties{
			ColumnName:      to.Ptr("test1"),
			MaskingFunction: to.Ptr(armsynapse.DataMaskingFunctionDefault),
			SchemaName:      to.Ptr("dbo"),
			TableName:       to.Ptr("Table_1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataMaskingRule = armsynapse.DataMaskingRule{
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/"),
	// 	Location: to.Ptr("Central US"),
	// 	Properties: &armsynapse.DataMaskingRuleProperties{
	// 		ColumnName: to.Ptr("test1"),
	// 		ID: to.Ptr("dbo_Table_1_test1"),
	// 		MaskingFunction: to.Ptr(armsynapse.DataMaskingFunctionDefault),
	// 		RuleState: to.Ptr(armsynapse.DataMaskingRuleStateEnabled),
	// 		SchemaName: to.Ptr("dbo"),
	// 		TableName: to.Ptr("Table_1"),
	// 	},
	// }
}

Output:
Example (CreateUpdateDataMaskingRuleForNumbers)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DataMaskingRuleCreateOrUpdateNumber.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataMaskingRulesClient().CreateOrUpdate(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", "rule1", armsynapse.DataMaskingRule{
		Properties: &armsynapse.DataMaskingRuleProperties{
			ColumnName:      to.Ptr("test1"),
			MaskingFunction: to.Ptr(armsynapse.DataMaskingFunctionNumber),
			NumberFrom:      to.Ptr("0"),
			NumberTo:        to.Ptr("2"),
			SchemaName:      to.Ptr("dbo"),
			TableName:       to.Ptr("Table_1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataMaskingRule = armsynapse.DataMaskingRule{
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/"),
	// 	Location: to.Ptr("Central US"),
	// 	Properties: &armsynapse.DataMaskingRuleProperties{
	// 		ColumnName: to.Ptr("test1"),
	// 		ID: to.Ptr("dbo_Table_1_test1"),
	// 		MaskingFunction: to.Ptr(armsynapse.DataMaskingFunctionNumber),
	// 		NumberFrom: to.Ptr("0"),
	// 		NumberTo: to.Ptr("2"),
	// 		RuleState: to.Ptr(armsynapse.DataMaskingRuleStateEnabled),
	// 		SchemaName: to.Ptr("dbo"),
	// 		TableName: to.Ptr("Table_1"),
	// 	},
	// }
}

Output:
Example (CreateUpdateDataMaskingRuleForText)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DataMaskingRuleCreateOrUpdateText.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataMaskingRulesClient().CreateOrUpdate(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", "rule1", armsynapse.DataMaskingRule{
		Properties: &armsynapse.DataMaskingRuleProperties{
			ColumnName:        to.Ptr("test1"),
			MaskingFunction:   to.Ptr(armsynapse.DataMaskingFunctionText),
			PrefixSize:        to.Ptr("1"),
			ReplacementString: to.Ptr("asdf"),
			SchemaName:        to.Ptr("dbo"),
			SuffixSize:        to.Ptr("0"),
			TableName:         to.Ptr("Table_1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataMaskingRule = armsynapse.DataMaskingRule{
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/"),
	// 	Location: to.Ptr("Central US"),
	// 	Properties: &armsynapse.DataMaskingRuleProperties{
	// 		ColumnName: to.Ptr("test1"),
	// 		ID: to.Ptr("dbo_Table_1_test1"),
	// 		MaskingFunction: to.Ptr(armsynapse.DataMaskingFunctionText),
	// 		PrefixSize: to.Ptr("1"),
	// 		ReplacementString: to.Ptr("asdf"),
	// 		RuleState: to.Ptr(armsynapse.DataMaskingRuleStateEnabled),
	// 		SchemaName: to.Ptr("dbo"),
	// 		SuffixSize: to.Ptr("0"),
	// 		TableName: to.Ptr("Table_1"),
	// 	},
	// }
}

Output:

func (*DataMaskingRulesClient) Get 

func (client *DataMaskingRulesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, dataMaskingRuleName string, options *DataMaskingRulesClientGetOptions) (DataMaskingRulesClientGetResponse, error)

Get - Gets the specific Sql pool data masking rule. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • dataMaskingRuleName - The name of the data masking rule.
  • options - DataMaskingRulesClientGetOptions contains the optional parameters for the DataMaskingRulesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DataMaskingRuleGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataMaskingRulesClient().Get(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", "rule1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataMaskingRule = armsynapse.DataMaskingRule{
	// 	Name: to.Ptr("rule1"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/"),
	// 	Location: to.Ptr("Central US"),
	// 	Properties: &armsynapse.DataMaskingRuleProperties{
	// 		ColumnName: to.Ptr("test1"),
	// 		ID: to.Ptr("dbo_Table_1_test1"),
	// 		MaskingFunction: to.Ptr(armsynapse.DataMaskingFunctionText),
	// 		PrefixSize: to.Ptr("1"),
	// 		ReplacementString: to.Ptr("asdf"),
	// 		RuleState: to.Ptr(armsynapse.DataMaskingRuleStateEnabled),
	// 		SchemaName: to.Ptr("dbo"),
	// 		SuffixSize: to.Ptr("0"),
	// 		TableName: to.Ptr("Table_1"),
	// 	},
	// }
}

Output:

func (*DataMaskingRulesClient) NewListBySQLPoolPager added in v0.4.0 

func (client *DataMaskingRulesClient) NewListBySQLPoolPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *DataMaskingRulesClientListBySQLPoolOptions) *runtime.Pager[DataMaskingRulesClientListBySQLPoolResponse]

NewListBySQLPoolPager - Gets a list of Sql pool data masking rules.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - DataMaskingRulesClientListBySQLPoolOptions contains the optional parameters for the DataMaskingRulesClient.NewListBySQLPoolPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DataMaskingRuleList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDataMaskingRulesClient().NewListBySQLPoolPager("sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DataMaskingRuleListResult = armsynapse.DataMaskingRuleListResult{
		// 	Value: []*armsynapse.DataMaskingRule{
		// 		{
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/"),
		// 			Location: to.Ptr("Central US"),
		// 			Properties: &armsynapse.DataMaskingRuleProperties{
		// 				ColumnName: to.Ptr("test1"),
		// 				ID: to.Ptr("dbo_Table_1_test1"),
		// 				MaskingFunction: to.Ptr(armsynapse.DataMaskingFunctionText),
		// 				PrefixSize: to.Ptr("1"),
		// 				ReplacementString: to.Ptr("asdf"),
		// 				RuleState: to.Ptr(armsynapse.DataMaskingRuleStateEnabled),
		// 				SchemaName: to.Ptr("dbo"),
		// 				SuffixSize: to.Ptr("0"),
		// 				TableName: to.Ptr("Table_1"),
		// 			},
		// 		},
		// 		{
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/"),
		// 			Location: to.Ptr("Central US"),
		// 			Properties: &armsynapse.DataMaskingRuleProperties{
		// 				ColumnName: to.Ptr("test1"),
		// 				ID: to.Ptr("dbo_Table_1_test1"),
		// 				MaskingFunction: to.Ptr(armsynapse.DataMaskingFunctionNumber),
		// 				NumberFrom: to.Ptr("0"),
		// 				NumberTo: to.Ptr("2"),
		// 				RuleState: to.Ptr(armsynapse.DataMaskingRuleStateEnabled),
		// 				SchemaName: to.Ptr("dbo"),
		// 				TableName: to.Ptr("Table_1"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type DataMaskingRulesClientCreateOrUpdateOptions added in v0.2.0 

type DataMaskingRulesClientCreateOrUpdateOptions struct {
}

DataMaskingRulesClientCreateOrUpdateOptions contains the optional parameters for the DataMaskingRulesClient.CreateOrUpdate method.

type DataMaskingRulesClientCreateOrUpdateResponse added in v0.2.0 

type DataMaskingRulesClientCreateOrUpdateResponse struct {
	// Represents a Sql pool data masking rule.
	DataMaskingRule
}

DataMaskingRulesClientCreateOrUpdateResponse contains the response from method DataMaskingRulesClient.CreateOrUpdate.

type DataMaskingRulesClientGetOptions added in v0.2.0 

type DataMaskingRulesClientGetOptions struct {
}

DataMaskingRulesClientGetOptions contains the optional parameters for the DataMaskingRulesClient.Get method.

type DataMaskingRulesClientGetResponse added in v0.2.0 

type DataMaskingRulesClientGetResponse struct {
	// Represents a Sql pool data masking rule.
	DataMaskingRule
}

DataMaskingRulesClientGetResponse contains the response from method DataMaskingRulesClient.Get.

type DataMaskingRulesClientListBySQLPoolOptions added in v0.2.0 

type DataMaskingRulesClientListBySQLPoolOptions struct {
}

DataMaskingRulesClientListBySQLPoolOptions contains the optional parameters for the DataMaskingRulesClient.NewListBySQLPoolPager method.

type DataMaskingRulesClientListBySQLPoolResponse added in v0.2.0 

type DataMaskingRulesClientListBySQLPoolResponse struct {
	// The response to a list data masking rules request.
	DataMaskingRuleListResult
}

DataMaskingRulesClientListBySQLPoolResponse contains the response from method DataMaskingRulesClient.NewListBySQLPoolPager.

type DataMaskingState 

type DataMaskingState string

DataMaskingState - The state of the data masking policy. 

const (
	DataMaskingStateDisabled DataMaskingState = "Disabled"
	DataMaskingStateEnabled  DataMaskingState = "Enabled"
)

func PossibleDataMaskingStateValues 

func PossibleDataMaskingStateValues() []DataMaskingState

PossibleDataMaskingStateValues returns the possible values for the DataMaskingState const type.

type DataWarehouseUserActivities 

type DataWarehouseUserActivities struct {
	// Resource properties.
	Properties *DataWarehouseUserActivitiesProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DataWarehouseUserActivities - User activities of a data warehouse

func (DataWarehouseUserActivities) MarshalJSON 

func (d DataWarehouseUserActivities) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataWarehouseUserActivities.

func (*DataWarehouseUserActivities) UnmarshalJSON 

func (d *DataWarehouseUserActivities) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataWarehouseUserActivities.

type DataWarehouseUserActivitiesProperties 

type DataWarehouseUserActivitiesProperties struct {
	// READ-ONLY; Count of running and suspended queries.
	ActiveQueriesCount *int32
}

DataWarehouseUserActivitiesProperties - User activities of a data warehouse. This currently includes the count of running or suspended queries. For more information, please view the sys.dmpdwexec_requests dynamic management view (DMV).

func (DataWarehouseUserActivitiesProperties) MarshalJSON added in v0.6.0 

func (d DataWarehouseUserActivitiesProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataWarehouseUserActivitiesProperties.

func (*DataWarehouseUserActivitiesProperties) UnmarshalJSON added in v0.6.0 

func (d *DataWarehouseUserActivitiesProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataWarehouseUserActivitiesProperties.

type DataWarehouseUserActivityName 

type DataWarehouseUserActivityName string
const (
	DataWarehouseUserActivityNameCurrent DataWarehouseUserActivityName = "current"
)

func PossibleDataWarehouseUserActivityNameValues 

func PossibleDataWarehouseUserActivityNameValues() []DataWarehouseUserActivityName

PossibleDataWarehouseUserActivityNameValues returns the possible values for the DataWarehouseUserActivityName const type.

type Database 

type Database struct {
	// REQUIRED; Kind of the database
	Kind *Kind

	// Resource location.
	Location *string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Database - Class representing a Kusto database.

func (*Database) GetDatabase 

func (d *Database) GetDatabase() *Database

GetDatabase implements the DatabaseClassification interface for type Database.

func (Database) MarshalJSON added in v0.2.0 

func (d Database) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Database.

func (*Database) UnmarshalJSON 

func (d *Database) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Database.

type DatabaseCheckNameRequest 

type DatabaseCheckNameRequest struct {
	// REQUIRED; Resource name.
	Name *string

	// REQUIRED; The type of resource, for instance Microsoft.Synapse/workspaces/kustoPools/databases.
	Type *Type
}

DatabaseCheckNameRequest - The result returned from a database check name availability request.

func (DatabaseCheckNameRequest) MarshalJSON added in v0.6.0 

func (d DatabaseCheckNameRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatabaseCheckNameRequest.

func (*DatabaseCheckNameRequest) UnmarshalJSON added in v0.6.0 

func (d *DatabaseCheckNameRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatabaseCheckNameRequest.

type DatabaseClassification 

type DatabaseClassification interface {
	// GetDatabase returns the Database content of the underlying type.
	GetDatabase() *Database
}

DatabaseClassification provides polymorphic access to related types. Call the interface's GetDatabase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *Database, *ReadOnlyFollowingDatabase, *ReadWriteDatabase

type DatabaseListResult 

type DatabaseListResult struct {
	// The list of Kusto databases.
	Value []DatabaseClassification
}

DatabaseListResult - The list Kusto databases operation response.

func (DatabaseListResult) MarshalJSON 

func (d DatabaseListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatabaseListResult.

func (*DatabaseListResult) UnmarshalJSON 

func (d *DatabaseListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatabaseListResult.

type DatabasePrincipalAssignment 

type DatabasePrincipalAssignment struct {
	// The database principal.
	Properties *DatabasePrincipalProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DatabasePrincipalAssignment - Class representing a database principal assignment.

func (DatabasePrincipalAssignment) MarshalJSON 

func (d DatabasePrincipalAssignment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatabasePrincipalAssignment.

func (*DatabasePrincipalAssignment) UnmarshalJSON 

func (d *DatabasePrincipalAssignment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatabasePrincipalAssignment.

type DatabasePrincipalAssignmentCheckNameRequest 

type DatabasePrincipalAssignmentCheckNameRequest struct {
	// REQUIRED; Principal Assignment resource name.
	Name *string

	// CONSTANT; The type of resource, Microsoft.Synapse/workspaces/kustoPools/databases/principalAssignments.
	// Field has constant value "Microsoft.Synapse/workspaces/kustoPools/databases/principalAssignments", any specified value
	// is ignored.
	Type *string
}

DatabasePrincipalAssignmentCheckNameRequest - A principal assignment check name availability request.

func (DatabasePrincipalAssignmentCheckNameRequest) MarshalJSON added in v0.6.0 

func (d DatabasePrincipalAssignmentCheckNameRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatabasePrincipalAssignmentCheckNameRequest.

func (*DatabasePrincipalAssignmentCheckNameRequest) UnmarshalJSON added in v0.6.0 

func (d *DatabasePrincipalAssignmentCheckNameRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatabasePrincipalAssignmentCheckNameRequest.

type DatabasePrincipalAssignmentListResult 

type DatabasePrincipalAssignmentListResult struct {
	// The list of Kusto database principal assignments.
	Value []*DatabasePrincipalAssignment
}

DatabasePrincipalAssignmentListResult - The list Kusto database principal assignments operation response.

func (DatabasePrincipalAssignmentListResult) MarshalJSON 

func (d DatabasePrincipalAssignmentListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatabasePrincipalAssignmentListResult.

func (*DatabasePrincipalAssignmentListResult) UnmarshalJSON added in v0.6.0 

func (d *DatabasePrincipalAssignmentListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatabasePrincipalAssignmentListResult.

type DatabasePrincipalProperties 

type DatabasePrincipalProperties struct {
	// REQUIRED; The principal ID assigned to the database principal. It can be a user email, application ID, or security group
	// name.
	PrincipalID *string

	// REQUIRED; Principal type.
	PrincipalType *PrincipalType

	// REQUIRED; Database principal role.
	Role *DatabasePrincipalRole

	// The tenant id of the principal
	TenantID *string

	// READ-ONLY; The service principal object id in AAD (Azure active directory)
	AADObjectID *string

	// READ-ONLY; The principal name
	PrincipalName *string

	// READ-ONLY; The provisioned state of the resource.
	ProvisioningState *ResourceProvisioningState

	// READ-ONLY; The tenant name of the principal
	TenantName *string
}

DatabasePrincipalProperties - A class representing database principal property.

func (DatabasePrincipalProperties) MarshalJSON added in v0.6.0 

func (d DatabasePrincipalProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatabasePrincipalProperties.

func (*DatabasePrincipalProperties) UnmarshalJSON added in v0.6.0 

func (d *DatabasePrincipalProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatabasePrincipalProperties.

type DatabasePrincipalRole 

type DatabasePrincipalRole string

DatabasePrincipalRole - Database principal role. 

const (
	DatabasePrincipalRoleAdmin              DatabasePrincipalRole = "Admin"
	DatabasePrincipalRoleIngestor           DatabasePrincipalRole = "Ingestor"
	DatabasePrincipalRoleMonitor            DatabasePrincipalRole = "Monitor"
	DatabasePrincipalRoleUnrestrictedViewer DatabasePrincipalRole = "UnrestrictedViewer"
	DatabasePrincipalRoleUser               DatabasePrincipalRole = "User"
	DatabasePrincipalRoleViewer             DatabasePrincipalRole = "Viewer"
)

func PossibleDatabasePrincipalRoleValues 

func PossibleDatabasePrincipalRoleValues() []DatabasePrincipalRole

PossibleDatabasePrincipalRoleValues returns the possible values for the DatabasePrincipalRole const type.

type DatabaseStatistics 

type DatabaseStatistics struct {
	// The database size - the total size of compressed data and index in bytes.
	Size *float32
}

DatabaseStatistics - A class that contains database statistics information.

func (DatabaseStatistics) MarshalJSON added in v0.6.0 

func (d DatabaseStatistics) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatabaseStatistics.

func (*DatabaseStatistics) UnmarshalJSON added in v0.6.0 

func (d *DatabaseStatistics) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatabaseStatistics.

type DayOfWeek 

type DayOfWeek string

DayOfWeek - Day of maintenance window. 

const (
	DayOfWeekFriday    DayOfWeek = "Friday"
	DayOfWeekMonday    DayOfWeek = "Monday"
	DayOfWeekSaturday  DayOfWeek = "Saturday"
	DayOfWeekSunday    DayOfWeek = "Sunday"
	DayOfWeekThursday  DayOfWeek = "Thursday"
	DayOfWeekTuesday   DayOfWeek = "Tuesday"
	DayOfWeekWednesday DayOfWeek = "Wednesday"
)

func PossibleDayOfWeekValues 

func PossibleDayOfWeekValues() []DayOfWeek

PossibleDayOfWeekValues returns the possible values for the DayOfWeek const type.

type DedicatedSQLMinimalTLSSettingsName added in v0.3.0 

type DedicatedSQLMinimalTLSSettingsName string
const (
	DedicatedSQLMinimalTLSSettingsNameDefault DedicatedSQLMinimalTLSSettingsName = "default"
)

func PossibleDedicatedSQLMinimalTLSSettingsNameValues added in v0.3.0 

func PossibleDedicatedSQLMinimalTLSSettingsNameValues() []DedicatedSQLMinimalTLSSettingsName

PossibleDedicatedSQLMinimalTLSSettingsNameValues returns the possible values for the DedicatedSQLMinimalTLSSettingsName const type.

type DedicatedSQLminimalTLSSettings added in v0.3.0 

type DedicatedSQLminimalTLSSettings struct {
	// Resource properties.
	Properties *DedicatedSQLminimalTLSSettingsProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; Resource location.
	Location *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DedicatedSQLminimalTLSSettings - Dedicated Sql Minimal Tls Settings Info

func (DedicatedSQLminimalTLSSettings) MarshalJSON added in v0.6.0 

func (d DedicatedSQLminimalTLSSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DedicatedSQLminimalTLSSettings.

func (*DedicatedSQLminimalTLSSettings) UnmarshalJSON added in v0.6.0 

func (d *DedicatedSQLminimalTLSSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DedicatedSQLminimalTLSSettings.

type DedicatedSQLminimalTLSSettingsListResult added in v0.3.0 

type DedicatedSQLminimalTLSSettingsListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*DedicatedSQLminimalTLSSettings
}

DedicatedSQLminimalTLSSettingsListResult - A list of the server's dedicated sql minimal tls settings.

func (DedicatedSQLminimalTLSSettingsListResult) MarshalJSON added in v0.3.0 

func (d DedicatedSQLminimalTLSSettingsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DedicatedSQLminimalTLSSettingsListResult.

func (*DedicatedSQLminimalTLSSettingsListResult) UnmarshalJSON added in v0.6.0 

func (d *DedicatedSQLminimalTLSSettingsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DedicatedSQLminimalTLSSettingsListResult.

type DedicatedSQLminimalTLSSettingsPatchInfo added in v0.3.0 

type DedicatedSQLminimalTLSSettingsPatchInfo struct {
	// minimal tls version
	MinimalTLSVersion *string
}

DedicatedSQLminimalTLSSettingsPatchInfo - Dedicated SQL minimal tls settings patch info

func (DedicatedSQLminimalTLSSettingsPatchInfo) MarshalJSON added in v0.6.0 

func (d DedicatedSQLminimalTLSSettingsPatchInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DedicatedSQLminimalTLSSettingsPatchInfo.

func (*DedicatedSQLminimalTLSSettingsPatchInfo) UnmarshalJSON added in v0.6.0 

func (d *DedicatedSQLminimalTLSSettingsPatchInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DedicatedSQLminimalTLSSettingsPatchInfo.

type DedicatedSQLminimalTLSSettingsProperties added in v0.3.0 

type DedicatedSQLminimalTLSSettingsProperties struct {
	// The minimal tls version of the sql server.
	MinimalTLSVersion *string
}

DedicatedSQLminimalTLSSettingsProperties - Properties of a dedicated sql minimal tls settings.

func (DedicatedSQLminimalTLSSettingsProperties) MarshalJSON added in v0.6.0 

func (d DedicatedSQLminimalTLSSettingsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DedicatedSQLminimalTLSSettingsProperties.

func (*DedicatedSQLminimalTLSSettingsProperties) UnmarshalJSON added in v0.6.0 

func (d *DedicatedSQLminimalTLSSettingsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DedicatedSQLminimalTLSSettingsProperties.

type DefaultPrincipalsModificationKind 

type DefaultPrincipalsModificationKind string

DefaultPrincipalsModificationKind - The default principals modification kind 

const (
	DefaultPrincipalsModificationKindNone    DefaultPrincipalsModificationKind = "None"
	DefaultPrincipalsModificationKindReplace DefaultPrincipalsModificationKind = "Replace"
	DefaultPrincipalsModificationKindUnion   DefaultPrincipalsModificationKind = "Union"
)

func PossibleDefaultPrincipalsModificationKindValues 

func PossibleDefaultPrincipalsModificationKindValues() []DefaultPrincipalsModificationKind

PossibleDefaultPrincipalsModificationKindValues returns the possible values for the DefaultPrincipalsModificationKind const type.

type DesiredState added in v0.6.0 

type DesiredState string

DesiredState - Desired state 

const (
	DesiredStateDisabled DesiredState = "Disabled"
	DesiredStateEnabled  DesiredState = "Enabled"
)

func PossibleDesiredStateValues added in v0.6.0 

func PossibleDesiredStateValues() []DesiredState

PossibleDesiredStateValues returns the possible values for the DesiredState const type.

type DynamicExecutorAllocation 

type DynamicExecutorAllocation struct {
	// Indicates whether Dynamic Executor Allocation is enabled or not.
	Enabled *bool

	// The maximum number of executors alloted
	MaxExecutors *int32

	// The minimum number of executors alloted
	MinExecutors *int32
}

DynamicExecutorAllocation - Dynamic Executor Allocation Properties

func (DynamicExecutorAllocation) MarshalJSON added in v0.6.0 

func (d DynamicExecutorAllocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DynamicExecutorAllocation.

func (*DynamicExecutorAllocation) UnmarshalJSON added in v0.6.0 

func (d *DynamicExecutorAllocation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DynamicExecutorAllocation.

type EncryptionDetails 

type EncryptionDetails struct {
	// Customer Managed Key Details
	Cmk *CustomerManagedKeyDetails

	// READ-ONLY; Double Encryption enabled
	DoubleEncryptionEnabled *bool
}

EncryptionDetails - Details of the encryption associated with the workspace

func (EncryptionDetails) MarshalJSON added in v0.6.0 

func (e EncryptionDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EncryptionDetails.

func (*EncryptionDetails) UnmarshalJSON added in v0.6.0 

func (e *EncryptionDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EncryptionDetails.

type EncryptionProtector 

type EncryptionProtector struct {
	// Resource properties.
	Properties *EncryptionProtectorProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; Kind of encryption protector. This is metadata used for the Azure portal experience.
	Kind *string

	// READ-ONLY; Resource location.
	Location *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

EncryptionProtector - The server encryption protector.

func (EncryptionProtector) MarshalJSON 

func (e EncryptionProtector) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EncryptionProtector.

func (*EncryptionProtector) UnmarshalJSON 

func (e *EncryptionProtector) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EncryptionProtector.

type EncryptionProtectorListResult 

type EncryptionProtectorListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*EncryptionProtector
}

EncryptionProtectorListResult - A list of server encryption protectors.

func (EncryptionProtectorListResult) MarshalJSON 

func (e EncryptionProtectorListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EncryptionProtectorListResult.

func (*EncryptionProtectorListResult) UnmarshalJSON added in v0.6.0 

func (e *EncryptionProtectorListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EncryptionProtectorListResult.

type EncryptionProtectorName 

type EncryptionProtectorName string
const (
	EncryptionProtectorNameCurrent EncryptionProtectorName = "current"
)

func PossibleEncryptionProtectorNameValues 

func PossibleEncryptionProtectorNameValues() []EncryptionProtectorName

PossibleEncryptionProtectorNameValues returns the possible values for the EncryptionProtectorName const type.

type EncryptionProtectorProperties 

type EncryptionProtectorProperties struct {
	// REQUIRED; The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.
	ServerKeyType *ServerKeyType

	// The name of the server key.
	ServerKeyName *string

	// READ-ONLY; Subregion of the encryption protector.
	Subregion *string

	// READ-ONLY; Thumbprint of the server key.
	Thumbprint *string

	// READ-ONLY; The URI of the server key.
	URI *string
}

EncryptionProtectorProperties - Properties for an encryption protector execution.

func (EncryptionProtectorProperties) MarshalJSON added in v0.6.0 

func (e EncryptionProtectorProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EncryptionProtectorProperties.

func (*EncryptionProtectorProperties) UnmarshalJSON added in v0.6.0 

func (e *EncryptionProtectorProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EncryptionProtectorProperties.

type EntityReference 

type EntityReference struct {
	// The name of this referenced entity.
	ReferenceName *string

	// The type of this referenced entity.
	Type *IntegrationRuntimeEntityReferenceType
}

EntityReference - The entity reference.

func (EntityReference) MarshalJSON added in v0.6.0 

func (e EntityReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EntityReference.

func (*EntityReference) UnmarshalJSON added in v0.6.0 

func (e *EntityReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EntityReference.

type EnvironmentVariableSetup 

type EnvironmentVariableSetup struct {
	// REQUIRED; The type of custom setup.
	Type *string

	// REQUIRED; Add environment variable type properties.
	TypeProperties *EnvironmentVariableSetupTypeProperties
}

EnvironmentVariableSetup - The custom setup of setting environment variable.

func (*EnvironmentVariableSetup) GetCustomSetupBase added in v0.2.0 

func (e *EnvironmentVariableSetup) GetCustomSetupBase() *CustomSetupBase

GetCustomSetupBase implements the CustomSetupBaseClassification interface for type EnvironmentVariableSetup.

func (EnvironmentVariableSetup) MarshalJSON 

func (e EnvironmentVariableSetup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentVariableSetup.

func (*EnvironmentVariableSetup) UnmarshalJSON 

func (e *EnvironmentVariableSetup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentVariableSetup.

type EnvironmentVariableSetupTypeProperties 

type EnvironmentVariableSetupTypeProperties struct {
	// REQUIRED; The name of the environment variable.
	VariableName *string

	// REQUIRED; The value of the environment variable.
	VariableValue *string
}

EnvironmentVariableSetupTypeProperties - Environment variable custom setup type properties.

func (EnvironmentVariableSetupTypeProperties) MarshalJSON added in v0.6.0 

func (e EnvironmentVariableSetupTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentVariableSetupTypeProperties.

func (*EnvironmentVariableSetupTypeProperties) UnmarshalJSON added in v0.6.0 

func (e *EnvironmentVariableSetupTypeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentVariableSetupTypeProperties.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON added in v0.6.0 

func (e ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON added in v0.6.0 

func (e *ErrorAdditionalInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorDetail

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON 

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON added in v0.6.0 

func (e *ErrorDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

func (ErrorResponse) MarshalJSON added in v0.6.0 

func (e ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON added in v0.6.0 

func (e *ErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type ErrorResponseAutoGenerated added in v0.6.0 

type ErrorResponseAutoGenerated struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorResponseAutoGenerated

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorResponseAutoGenerated - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

func (ErrorResponseAutoGenerated) MarshalJSON added in v0.6.0 

func (e ErrorResponseAutoGenerated) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponseAutoGenerated.

func (*ErrorResponseAutoGenerated) UnmarshalJSON added in v0.6.0 

func (e *ErrorResponseAutoGenerated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponseAutoGenerated.

type EventGridConnectionProperties 

type EventGridConnectionProperties struct {
	// REQUIRED; The event hub consumer group.
	ConsumerGroup *string

	// REQUIRED; The resource ID where the event grid is configured to send events.
	EventHubResourceID *string

	// REQUIRED; The resource ID of the storage account where the data resides.
	StorageAccountResourceID *string

	// The name of blob storage event type to process.
	BlobStorageEventType *BlobStorageEventType

	// The data format of the message. Optionally the data format can be added to each message.
	DataFormat *EventGridDataFormat

	// A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file
	IgnoreFirstRecord *bool

	// The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
	MappingRuleName *string

	// The table where the data should be ingested. Optionally the table information can be added to each message.
	TableName *string

	// READ-ONLY; The provisioned state of the resource.
	ProvisioningState *ResourceProvisioningState
}

EventGridConnectionProperties - Class representing the Kusto event grid connection properties.

func (EventGridConnectionProperties) MarshalJSON added in v0.6.0 

func (e EventGridConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventGridConnectionProperties.

func (*EventGridConnectionProperties) UnmarshalJSON added in v0.6.0 

func (e *EventGridConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventGridConnectionProperties.

type EventGridDataConnection 

type EventGridDataConnection struct {
	// REQUIRED; Kind of the endpoint for the data connection
	Kind *DataConnectionKind

	// Resource location.
	Location *string

	// The properties of the Event Grid data connection.
	Properties *EventGridConnectionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

EventGridDataConnection - Class representing an Event Grid data connection.

func (*EventGridDataConnection) GetDataConnection added in v0.2.0 

func (e *EventGridDataConnection) GetDataConnection() *DataConnection

GetDataConnection implements the DataConnectionClassification interface for type EventGridDataConnection.

func (EventGridDataConnection) MarshalJSON 

func (e EventGridDataConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventGridDataConnection.

func (*EventGridDataConnection) UnmarshalJSON 

func (e *EventGridDataConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventGridDataConnection.

type EventGridDataFormat 

type EventGridDataFormat string

EventGridDataFormat - The data format of the message. Optionally the data format can be added to each message. 

const (
	EventGridDataFormatAPACHEAVRO EventGridDataFormat = "APACHEAVRO"
	EventGridDataFormatAVRO       EventGridDataFormat = "AVRO"
	EventGridDataFormatCSV        EventGridDataFormat = "CSV"
	EventGridDataFormatJSON       EventGridDataFormat = "JSON"
	EventGridDataFormatMULTIJSON  EventGridDataFormat = "MULTIJSON"
	EventGridDataFormatORC        EventGridDataFormat = "ORC"
	EventGridDataFormatPARQUET    EventGridDataFormat = "PARQUET"
	EventGridDataFormatPSV        EventGridDataFormat = "PSV"
	EventGridDataFormatRAW        EventGridDataFormat = "RAW"
	EventGridDataFormatSCSV       EventGridDataFormat = "SCSV"
	EventGridDataFormatSINGLEJSON EventGridDataFormat = "SINGLEJSON"
	EventGridDataFormatSOHSV      EventGridDataFormat = "SOHSV"
	EventGridDataFormatTSV        EventGridDataFormat = "TSV"
	EventGridDataFormatTSVE       EventGridDataFormat = "TSVE"
	EventGridDataFormatTXT        EventGridDataFormat = "TXT"
	EventGridDataFormatW3CLOGFILE EventGridDataFormat = "W3CLOGFILE"
)

func PossibleEventGridDataFormatValues 

func PossibleEventGridDataFormatValues() []EventGridDataFormat

PossibleEventGridDataFormatValues returns the possible values for the EventGridDataFormat const type.

type EventHubConnectionProperties 

type EventHubConnectionProperties struct {
	// REQUIRED; The event hub consumer group.
	ConsumerGroup *string

	// REQUIRED; The resource ID of the event hub to be used to create a data connection.
	EventHubResourceID *string

	// The event hub messages compression type
	Compression *Compression

	// The data format of the message. Optionally the data format can be added to each message.
	DataFormat *EventHubDataFormat

	// System properties of the event hub
	EventSystemProperties []*string

	// The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.
	ManagedIdentityResourceID *string

	// The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
	MappingRuleName *string

	// The table where the data should be ingested. Optionally the table information can be added to each message.
	TableName *string

	// READ-ONLY; The provisioned state of the resource.
	ProvisioningState *ResourceProvisioningState
}

EventHubConnectionProperties - Class representing the Kusto event hub connection properties.

func (EventHubConnectionProperties) MarshalJSON 

func (e EventHubConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventHubConnectionProperties.

func (*EventHubConnectionProperties) UnmarshalJSON added in v0.6.0 

func (e *EventHubConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventHubConnectionProperties.

type EventHubDataConnection 

type EventHubDataConnection struct {
	// REQUIRED; Kind of the endpoint for the data connection
	Kind *DataConnectionKind

	// Resource location.
	Location *string

	// The Event Hub data connection properties to validate.
	Properties *EventHubConnectionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

EventHubDataConnection - Class representing an event hub data connection.

func (*EventHubDataConnection) GetDataConnection added in v0.2.0 

func (e *EventHubDataConnection) GetDataConnection() *DataConnection

GetDataConnection implements the DataConnectionClassification interface for type EventHubDataConnection.

func (EventHubDataConnection) MarshalJSON 

func (e EventHubDataConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EventHubDataConnection.

func (*EventHubDataConnection) UnmarshalJSON 

func (e *EventHubDataConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EventHubDataConnection.

type EventHubDataFormat 

type EventHubDataFormat string

EventHubDataFormat - The data format of the message. Optionally the data format can be added to each message. 

const (
	EventHubDataFormatAPACHEAVRO EventHubDataFormat = "APACHEAVRO"
	EventHubDataFormatAVRO       EventHubDataFormat = "AVRO"
	EventHubDataFormatCSV        EventHubDataFormat = "CSV"
	EventHubDataFormatJSON       EventHubDataFormat = "JSON"
	EventHubDataFormatMULTIJSON  EventHubDataFormat = "MULTIJSON"
	EventHubDataFormatORC        EventHubDataFormat = "ORC"
	EventHubDataFormatPARQUET    EventHubDataFormat = "PARQUET"
	EventHubDataFormatPSV        EventHubDataFormat = "PSV"
	EventHubDataFormatRAW        EventHubDataFormat = "RAW"
	EventHubDataFormatSCSV       EventHubDataFormat = "SCSV"
	EventHubDataFormatSINGLEJSON EventHubDataFormat = "SINGLEJSON"
	EventHubDataFormatSOHSV      EventHubDataFormat = "SOHSV"
	EventHubDataFormatTSV        EventHubDataFormat = "TSV"
	EventHubDataFormatTSVE       EventHubDataFormat = "TSVE"
	EventHubDataFormatTXT        EventHubDataFormat = "TXT"
	EventHubDataFormatW3CLOGFILE EventHubDataFormat = "W3CLOGFILE"
)

func PossibleEventHubDataFormatValues 

func PossibleEventHubDataFormatValues() []EventHubDataFormat

PossibleEventHubDataFormatValues returns the possible values for the EventHubDataFormat const type.

type ExtendedSQLPoolBlobAuditingPoliciesClient 

type ExtendedSQLPoolBlobAuditingPoliciesClient struct {
	// contains filtered or unexported fields
}

ExtendedSQLPoolBlobAuditingPoliciesClient contains the methods for the ExtendedSQLPoolBlobAuditingPolicies group. Don't use this type directly, use NewExtendedSQLPoolBlobAuditingPoliciesClient() instead.

func NewExtendedSQLPoolBlobAuditingPoliciesClient 

func NewExtendedSQLPoolBlobAuditingPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ExtendedSQLPoolBlobAuditingPoliciesClient, error)

NewExtendedSQLPoolBlobAuditingPoliciesClient creates a new instance of ExtendedSQLPoolBlobAuditingPoliciesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ExtendedSQLPoolBlobAuditingPoliciesClient) CreateOrUpdate 

func (client *ExtendedSQLPoolBlobAuditingPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, parameters ExtendedSQLPoolBlobAuditingPolicy, options *ExtendedSQLPoolBlobAuditingPoliciesClientCreateOrUpdateOptions) (ExtendedSQLPoolBlobAuditingPoliciesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates an extended Sql pool's blob auditing policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • parameters - The extended Sql pool blob auditing policy.
  • options - ExtendedSQLPoolBlobAuditingPoliciesClientCreateOrUpdateOptions contains the optional parameters for the ExtendedSQLPoolBlobAuditingPoliciesClient.CreateOrUpdate method.
Example (CreateOrUpdateAnExtendedSqlPoolsAzureMonitorAuditingPolicyWithMinimalParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ExtendedSqlPoolAzureMonitorAuditingCreateMin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewExtendedSQLPoolBlobAuditingPoliciesClient().CreateOrUpdate(ctx, "blobauditingtest-4799", "blobauditingtest-6440", "testdb", armsynapse.ExtendedSQLPoolBlobAuditingPolicy{
		Properties: &armsynapse.ExtendedSQLPoolBlobAuditingPolicyProperties{
			IsAzureMonitorTargetEnabled: to.Ptr(true),
			State:                       to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExtendedSQLPoolBlobAuditingPolicy = armsynapse.ExtendedSQLPoolBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb"),
	// 	Properties: &armsynapse.ExtendedSQLPoolBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 			to.Ptr("SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("FAILED_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("BATCH_COMPLETED_GROUP")},
	// 			IsAzureMonitorTargetEnabled: to.Ptr(true),
	// 			IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 			RetentionDays: to.Ptr[int32](0),
	// 			State: to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
	// 			StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		},
	// 	}
}

Output:
Example (CreateOrUpdateAnExtendedSqlPoolsBlobAuditingPolicyWithAllParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ExtendedSqlPoolBlobAuditingCreateMax.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewExtendedSQLPoolBlobAuditingPoliciesClient().CreateOrUpdate(ctx, "blobauditingtest-4799", "blobauditingtest-6440", "testdb", armsynapse.ExtendedSQLPoolBlobAuditingPolicy{
		Properties: &armsynapse.ExtendedSQLPoolBlobAuditingPolicyProperties{
			AuditActionsAndGroups: []*string{
				to.Ptr("DATABASE_LOGOUT_GROUP"),
				to.Ptr("DATABASE_ROLE_MEMBER_CHANGE_GROUP"),
				to.Ptr("UPDATE on database::TestDatabaseName by public")},
			IsAzureMonitorTargetEnabled:  to.Ptr(true),
			IsStorageSecondaryKeyInUse:   to.Ptr(false),
			PredicateExpression:          to.Ptr("statement = 'select 1'"),
			RetentionDays:                to.Ptr[int32](6),
			State:                        to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
			StorageAccountAccessKey:      to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageAccountSubscriptionID: to.Ptr("00000000-1234-0000-5678-000000000000"),
			StorageEndpoint:              to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExtendedSQLPoolBlobAuditingPolicy = armsynapse.ExtendedSQLPoolBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb"),
	// 	Properties: &armsynapse.ExtendedSQLPoolBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 			to.Ptr("DATABASE_LOGOUT_GROUP"),
	// 			to.Ptr("DATABASE_ROLE_MEMBER_CHANGE_GROUP"),
	// 			to.Ptr("UPDATE on database::TestDatabaseName by public")},
	// 			IsAzureMonitorTargetEnabled: to.Ptr(true),
	// 			IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 			PredicateExpression: to.Ptr("statement = 'select 1'"),
	// 			RetentionDays: to.Ptr[int32](0),
	// 			State: to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
	// 			StorageAccountSubscriptionID: to.Ptr("00000000-1234-0000-5678-000000000000"),
	// 			StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 		},
	// 	}
}

Output:
Example (CreateOrUpdateAnExtendedSqlPoolsBlobAuditingPolicyWithMinimalParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ExtendedSqlPoolBlobAuditingCreateMin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewExtendedSQLPoolBlobAuditingPoliciesClient().CreateOrUpdate(ctx, "blobauditingtest-4799", "blobauditingtest-6440", "testdb", armsynapse.ExtendedSQLPoolBlobAuditingPolicy{
		Properties: &armsynapse.ExtendedSQLPoolBlobAuditingPolicyProperties{
			State:                   to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
			StorageAccountAccessKey: to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageEndpoint:         to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExtendedSQLPoolBlobAuditingPolicy = armsynapse.ExtendedSQLPoolBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb"),
	// 	Properties: &armsynapse.ExtendedSQLPoolBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 			to.Ptr("SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("FAILED_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("BATCH_COMPLETED_GROUP")},
	// 			IsAzureMonitorTargetEnabled: to.Ptr(false),
	// 			IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 			RetentionDays: to.Ptr[int32](0),
	// 			State: to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
	// 			StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 			StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 		},
	// 	}
}

Output:

func (*ExtendedSQLPoolBlobAuditingPoliciesClient) Get 

func (client *ExtendedSQLPoolBlobAuditingPoliciesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, options *ExtendedSQLPoolBlobAuditingPoliciesClientGetOptions) (ExtendedSQLPoolBlobAuditingPoliciesClientGetResponse, error)

Get - Gets an extended Sql pool's blob auditing policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - ExtendedSQLPoolBlobAuditingPoliciesClientGetOptions contains the optional parameters for the ExtendedSQLPoolBlobAuditingPoliciesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ExtendedSqlPoolBlobAuditingGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewExtendedSQLPoolBlobAuditingPoliciesClient().Get(ctx, "blobauditingtest-6852", "blobauditingtest-2080", "testdb", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExtendedSQLPoolBlobAuditingPolicy = armsynapse.ExtendedSQLPoolBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb"),
	// 	Properties: &armsynapse.ExtendedSQLPoolBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 		},
	// 		IsAzureMonitorTargetEnabled: to.Ptr(false),
	// 		IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 		PredicateExpression: to.Ptr("statement = 'select 1'"),
	// 		RetentionDays: to.Ptr[int32](0),
	// 		State: to.Ptr(armsynapse.BlobAuditingPolicyStateDisabled),
	// 		StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		StorageEndpoint: to.Ptr(""),
	// 	},
	// }
}

Output:

func (*ExtendedSQLPoolBlobAuditingPoliciesClient) NewListBySQLPoolPager added in v0.4.0 

func (client *ExtendedSQLPoolBlobAuditingPoliciesClient) NewListBySQLPoolPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *ExtendedSQLPoolBlobAuditingPoliciesClientListBySQLPoolOptions) *runtime.Pager[ExtendedSQLPoolBlobAuditingPoliciesClientListBySQLPoolResponse]

NewListBySQLPoolPager - Lists extended auditing settings of a Sql pool.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - ExtendedSQLPoolBlobAuditingPoliciesClientListBySQLPoolOptions contains the optional parameters for the ExtendedSQLPoolBlobAuditingPoliciesClient.NewListBySQLPoolPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolExtendedAuditingSettingsList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewExtendedSQLPoolBlobAuditingPoliciesClient().NewListBySQLPoolPager("blobauditingtest-6852", "blobauditingtest-2080", "testdb", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ExtendedSQLPoolBlobAuditingPolicyListResult = armsynapse.ExtendedSQLPoolBlobAuditingPolicyListResult{
		// 	Value: []*armsynapse.ExtendedSQLPoolBlobAuditingPolicy{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb/extendedAuditingSettings/default"),
		// 			Properties: &armsynapse.ExtendedSQLPoolBlobAuditingPolicyProperties{
		// 				AuditActionsAndGroups: []*string{
		// 				},
		// 				IsAzureMonitorTargetEnabled: to.Ptr(false),
		// 				IsStorageSecondaryKeyInUse: to.Ptr(false),
		// 				PredicateExpression: to.Ptr("statement = 'select 1'"),
		// 				RetentionDays: to.Ptr[int32](0),
		// 				State: to.Ptr(armsynapse.BlobAuditingPolicyStateDisabled),
		// 				StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				StorageEndpoint: to.Ptr(""),
		// 			},
		// 	}},
		// }
	}
}

Output:

type ExtendedSQLPoolBlobAuditingPoliciesClientCreateOrUpdateOptions added in v0.2.0 

type ExtendedSQLPoolBlobAuditingPoliciesClientCreateOrUpdateOptions struct {
}

ExtendedSQLPoolBlobAuditingPoliciesClientCreateOrUpdateOptions contains the optional parameters for the ExtendedSQLPoolBlobAuditingPoliciesClient.CreateOrUpdate method.

type ExtendedSQLPoolBlobAuditingPoliciesClientCreateOrUpdateResponse added in v0.2.0 

type ExtendedSQLPoolBlobAuditingPoliciesClientCreateOrUpdateResponse struct {
	// An extended Sql pool blob auditing policy.
	ExtendedSQLPoolBlobAuditingPolicy
}

ExtendedSQLPoolBlobAuditingPoliciesClientCreateOrUpdateResponse contains the response from method ExtendedSQLPoolBlobAuditingPoliciesClient.CreateOrUpdate.

type ExtendedSQLPoolBlobAuditingPoliciesClientGetOptions added in v0.2.0 

type ExtendedSQLPoolBlobAuditingPoliciesClientGetOptions struct {
}

ExtendedSQLPoolBlobAuditingPoliciesClientGetOptions contains the optional parameters for the ExtendedSQLPoolBlobAuditingPoliciesClient.Get method.

type ExtendedSQLPoolBlobAuditingPoliciesClientGetResponse added in v0.2.0 

type ExtendedSQLPoolBlobAuditingPoliciesClientGetResponse struct {
	// An extended Sql pool blob auditing policy.
	ExtendedSQLPoolBlobAuditingPolicy
}

ExtendedSQLPoolBlobAuditingPoliciesClientGetResponse contains the response from method ExtendedSQLPoolBlobAuditingPoliciesClient.Get.

type ExtendedSQLPoolBlobAuditingPoliciesClientListBySQLPoolOptions added in v0.2.0 

type ExtendedSQLPoolBlobAuditingPoliciesClientListBySQLPoolOptions struct {
}

ExtendedSQLPoolBlobAuditingPoliciesClientListBySQLPoolOptions contains the optional parameters for the ExtendedSQLPoolBlobAuditingPoliciesClient.NewListBySQLPoolPager method.

type ExtendedSQLPoolBlobAuditingPoliciesClientListBySQLPoolResponse added in v0.2.0 

type ExtendedSQLPoolBlobAuditingPoliciesClientListBySQLPoolResponse struct {
	// A list of sql pool extended auditing settings.
	ExtendedSQLPoolBlobAuditingPolicyListResult
}

ExtendedSQLPoolBlobAuditingPoliciesClientListBySQLPoolResponse contains the response from method ExtendedSQLPoolBlobAuditingPoliciesClient.NewListBySQLPoolPager.

type ExtendedSQLPoolBlobAuditingPolicy 

type ExtendedSQLPoolBlobAuditingPolicy struct {
	// Resource properties.
	Properties *ExtendedSQLPoolBlobAuditingPolicyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ExtendedSQLPoolBlobAuditingPolicy - An extended Sql pool blob auditing policy.

func (ExtendedSQLPoolBlobAuditingPolicy) MarshalJSON 

func (e ExtendedSQLPoolBlobAuditingPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtendedSQLPoolBlobAuditingPolicy.

func (*ExtendedSQLPoolBlobAuditingPolicy) UnmarshalJSON 

func (e *ExtendedSQLPoolBlobAuditingPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtendedSQLPoolBlobAuditingPolicy.

type ExtendedSQLPoolBlobAuditingPolicyListResult 

type ExtendedSQLPoolBlobAuditingPolicyListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*ExtendedSQLPoolBlobAuditingPolicy
}

ExtendedSQLPoolBlobAuditingPolicyListResult - A list of sql pool extended auditing settings.

func (ExtendedSQLPoolBlobAuditingPolicyListResult) MarshalJSON 

func (e ExtendedSQLPoolBlobAuditingPolicyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtendedSQLPoolBlobAuditingPolicyListResult.

func (*ExtendedSQLPoolBlobAuditingPolicyListResult) UnmarshalJSON added in v0.6.0 

func (e *ExtendedSQLPoolBlobAuditingPolicyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtendedSQLPoolBlobAuditingPolicyListResult.

type ExtendedSQLPoolBlobAuditingPolicyProperties 

type ExtendedSQLPoolBlobAuditingPolicyProperties struct {
	// REQUIRED; Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.
	State *BlobAuditingPolicyState

	// Specifies the Actions-Groups and Actions to audit.
	// The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures
	// executed against the database, as well as successful and failed logins:
	// BATCHCOMPLETEDGROUP, SUCCESSFULDATABASEAUTHENTICATIONGROUP, FAILEDDATABASEAUTHENTICATIONGROUP.
	// This above combination is also the set that is configured by default when enabling auditing from the Azure portal.
	// The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary
	// groups could lead to very large quantities of audit records):
	// APPLICATIONROLECHANGEPASSWORDGROUP BACKUPRESTOREGROUP DATABASELOGOUTGROUP DATABASEOBJECTCHANGEGROUP DATABASEOBJECTOWNERSHIPCHANGEGROUP
	// DATABASEOBJECTPERMISSIONCHANGEGROUP DATABASEOPERATIONGROUP
	// DATABASEPERMISSIONCHANGEGROUP DATABASEPRINCIPALCHANGEGROUP DATABASEPRINCIPALIMPERSONATIONGROUP DATABASEROLEMEMBERCHANGEGROUP
	// FAILEDDATABASEAUTHENTICATIONGROUP SCHEMAOBJECTACCESSGROUP SCHEMAOBJECT
	// CHANGEGROUP SCHEMAOBJECTOWNERSHIPCHANGEGROUP SCHEMAOBJECTPERMISSIONCHANGEGROUP SUCCESSFULDATABASEAUTHENTICATIONGROUP USERCHANGEPASSWORDGROUP
	// BATCHSTARTEDGROUP BATCHCOMPLETED_GROUP
	// These are groups that cover all sql statements and stored procedures executed against the database, and should not be used
	// in combination with other groups as this will result in duplicate audit logs.
	// For more information, see Database-Level Audit Action Groups
	// [https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups].
	// For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server
	// auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE
	// EXECUTE RECEIVE REFERENCES
	// The general form for defining an action to be audited is: {action} ON {object} BY {principal}
	// Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or
	// schema. For the latter cases, the forms DATABASE::{dbname} and SCHEMA::{schema
	// name} are used, respectively.
	// For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public
	// For more information, see Database-Level Audit Actions
	// [https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions]
	AuditActionsAndGroups []*string

	// Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'state'
	// as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.
	// When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on
	// the database should be also created. Note that for server level audit you
	// should use the 'master' database as {databaseName}.
	// Diagnostic Settings URI format: PUT
	// https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview
	// For more information, see Diagnostic Settings REST API [https://go.microsoft.com/fwlink/?linkid=2033207]or Diagnostic Settings
	// PowerShell [https://go.microsoft.com/fwlink/?linkid=2033043]
	IsAzureMonitorTargetEnabled *bool

	// Specifies whether storageAccountAccessKey value is the storage's secondary key.
	IsStorageSecondaryKeyInUse *bool

	// Specifies condition of where clause when creating an audit.
	PredicateExpression *string

	// Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default
	// minimum value is 1000 (1 second). The maximum is 2,147,483,647.
	QueueDelayMs *int32

	// Specifies the number of days to keep in the audit logs in the storage account.
	RetentionDays *int32

	// Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not
	// specifying the storageAccountAccessKey will use SQL server system-assigned
	// managed identity to access the storage. Prerequisites for using managed identity authentication:
	// 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).
	// 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server
	// identity. For more information, see Auditing to storage using Managed
	// Identity authentication [https://go.microsoft.com/fwlink/?linkid=2114355]
	StorageAccountAccessKey *string

	// Specifies the blob storage subscription Id.
	StorageAccountSubscriptionID *string

	// Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint
	// or isAzureMonitorTargetEnabled is required.
	StorageEndpoint *string
}

ExtendedSQLPoolBlobAuditingPolicyProperties - Properties of an extended Sql pool blob auditing policy.

func (ExtendedSQLPoolBlobAuditingPolicyProperties) MarshalJSON 

func (e ExtendedSQLPoolBlobAuditingPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtendedSQLPoolBlobAuditingPolicyProperties.

func (*ExtendedSQLPoolBlobAuditingPolicyProperties) UnmarshalJSON added in v0.6.0 

func (e *ExtendedSQLPoolBlobAuditingPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtendedSQLPoolBlobAuditingPolicyProperties.

type ExtendedServerBlobAuditingPolicy 

type ExtendedServerBlobAuditingPolicy struct {
	// Resource properties.
	Properties *ExtendedServerBlobAuditingPolicyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ExtendedServerBlobAuditingPolicy - An extended server blob auditing policy.

func (ExtendedServerBlobAuditingPolicy) MarshalJSON 

func (e ExtendedServerBlobAuditingPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtendedServerBlobAuditingPolicy.

func (*ExtendedServerBlobAuditingPolicy) UnmarshalJSON 

func (e *ExtendedServerBlobAuditingPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtendedServerBlobAuditingPolicy.

type ExtendedServerBlobAuditingPolicyListResult 

type ExtendedServerBlobAuditingPolicyListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*ExtendedServerBlobAuditingPolicy
}

ExtendedServerBlobAuditingPolicyListResult - A list of server extended auditing settings.

func (ExtendedServerBlobAuditingPolicyListResult) MarshalJSON 

func (e ExtendedServerBlobAuditingPolicyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtendedServerBlobAuditingPolicyListResult.

func (*ExtendedServerBlobAuditingPolicyListResult) UnmarshalJSON added in v0.6.0 

func (e *ExtendedServerBlobAuditingPolicyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtendedServerBlobAuditingPolicyListResult.

type ExtendedServerBlobAuditingPolicyProperties 

type ExtendedServerBlobAuditingPolicyProperties struct {
	// REQUIRED; Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.
	State *BlobAuditingPolicyState

	// Specifies the Actions-Groups and Actions to audit.
	// The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures
	// executed against the database, as well as successful and failed logins:
	// BATCHCOMPLETEDGROUP, SUCCESSFULDATABASEAUTHENTICATIONGROUP, FAILEDDATABASEAUTHENTICATIONGROUP.
	// This above combination is also the set that is configured by default when enabling auditing from the Azure portal.
	// The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary
	// groups could lead to very large quantities of audit records):
	// APPLICATIONROLECHANGEPASSWORDGROUP BACKUPRESTOREGROUP DATABASELOGOUTGROUP DATABASEOBJECTCHANGEGROUP DATABASEOBJECTOWNERSHIPCHANGEGROUP
	// DATABASEOBJECTPERMISSIONCHANGEGROUP DATABASEOPERATIONGROUP
	// DATABASEPERMISSIONCHANGEGROUP DATABASEPRINCIPALCHANGEGROUP DATABASEPRINCIPALIMPERSONATIONGROUP DATABASEROLEMEMBERCHANGEGROUP
	// FAILEDDATABASEAUTHENTICATIONGROUP SCHEMAOBJECTACCESSGROUP SCHEMAOBJECT
	// CHANGEGROUP SCHEMAOBJECTOWNERSHIPCHANGEGROUP SCHEMAOBJECTPERMISSIONCHANGEGROUP SUCCESSFULDATABASEAUTHENTICATIONGROUP USERCHANGEPASSWORDGROUP
	// BATCHSTARTEDGROUP BATCHCOMPLETED_GROUP
	// These are groups that cover all sql statements and stored procedures executed against the database, and should not be used
	// in combination with other groups as this will result in duplicate audit logs.
	// For more information, see Database-Level Audit Action Groups
	// [https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups].
	// For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server
	// auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE
	// EXECUTE RECEIVE REFERENCES
	// The general form for defining an action to be audited is: {action} ON {object} BY {principal}
	// Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or
	// schema. For the latter cases, the forms DATABASE::{dbname} and SCHEMA::{schema
	// name} are used, respectively.
	// For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public
	// For more information, see Database-Level Audit Actions
	// [https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions]
	AuditActionsAndGroups []*string

	// Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'state'
	// as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.
	// When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on
	// the database should be also created. Note that for server level audit you
	// should use the 'master' database as {databaseName}.
	// Diagnostic Settings URI format: PUT
	// https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview
	// For more information, see Diagnostic Settings REST API [https://go.microsoft.com/fwlink/?linkid=2033207]or Diagnostic Settings
	// PowerShell [https://go.microsoft.com/fwlink/?linkid=2033043]
	IsAzureMonitorTargetEnabled *bool

	// Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the
	// events to Azure Monitor, specify 'State' as 'Enabled',
	// 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true
	// When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on
	// the master database should also be created.
	// Diagnostic Settings URI format: PUT
	// https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview
	// For more information, see Diagnostic Settings REST API [https://go.microsoft.com/fwlink/?linkid=2033207]or Diagnostic Settings
	// PowerShell [https://go.microsoft.com/fwlink/?linkid=2033043]
	IsDevopsAuditEnabled *bool

	// Specifies whether storageAccountAccessKey value is the storage's secondary key.
	IsStorageSecondaryKeyInUse *bool

	// Specifies condition of where clause when creating an audit.
	PredicateExpression *string

	// Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default
	// minimum value is 1000 (1 second). The maximum is 2,147,483,647.
	QueueDelayMs *int32

	// Specifies the number of days to keep in the audit logs in the storage account.
	RetentionDays *int32

	// Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not
	// specifying the storageAccountAccessKey will use SQL server system-assigned
	// managed identity to access the storage. Prerequisites for using managed identity authentication:
	// 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).
	// 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server
	// identity. For more information, see Auditing to storage using Managed
	// Identity authentication [https://go.microsoft.com/fwlink/?linkid=2114355]
	StorageAccountAccessKey *string

	// Specifies the blob storage subscription Id.
	StorageAccountSubscriptionID *string

	// Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint
	// or isAzureMonitorTargetEnabled is required.
	StorageEndpoint *string
}

ExtendedServerBlobAuditingPolicyProperties - Properties of an extended server blob auditing policy.

func (ExtendedServerBlobAuditingPolicyProperties) MarshalJSON 

func (e ExtendedServerBlobAuditingPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtendedServerBlobAuditingPolicyProperties.

func (*ExtendedServerBlobAuditingPolicyProperties) UnmarshalJSON added in v0.6.0 

func (e *ExtendedServerBlobAuditingPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtendedServerBlobAuditingPolicyProperties.

type FollowerDatabaseDefinition 

type FollowerDatabaseDefinition struct {
	// REQUIRED; Resource name of the attached database configuration in the follower cluster.
	AttachedDatabaseConfigurationName *string

	// REQUIRED; Resource id of the cluster that follows a database owned by this cluster.
	KustoPoolResourceID *string

	// READ-ONLY; The database name owned by this cluster that was followed. * in case following all databases.
	DatabaseName *string
}

FollowerDatabaseDefinition - A class representing follower database request.

func (FollowerDatabaseDefinition) MarshalJSON added in v0.6.0 

func (f FollowerDatabaseDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FollowerDatabaseDefinition.

func (*FollowerDatabaseDefinition) UnmarshalJSON added in v0.6.0 

func (f *FollowerDatabaseDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FollowerDatabaseDefinition.

type FollowerDatabaseListResult 

type FollowerDatabaseListResult struct {
	// The list of follower database result.
	Value []*FollowerDatabaseDefinition
}

FollowerDatabaseListResult - The list Kusto database principals operation response.

func (FollowerDatabaseListResult) MarshalJSON 

func (f FollowerDatabaseListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FollowerDatabaseListResult.

func (*FollowerDatabaseListResult) UnmarshalJSON added in v0.6.0 

func (f *FollowerDatabaseListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FollowerDatabaseListResult.

type GeoBackupPolicy 

type GeoBackupPolicy struct {
	// REQUIRED; The properties of the geo backup policy.
	Properties *GeoBackupPolicyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; Kind of geo backup policy. This is metadata used for the Azure portal experience.
	Kind *string

	// READ-ONLY; Backup policy location.
	Location *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

GeoBackupPolicy - A database geo backup policy.

func (GeoBackupPolicy) MarshalJSON 

func (g GeoBackupPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GeoBackupPolicy.

func (*GeoBackupPolicy) UnmarshalJSON 

func (g *GeoBackupPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GeoBackupPolicy.

type GeoBackupPolicyListResult 

type GeoBackupPolicyListResult struct {
	// The list of geo backup policies.
	Value []*GeoBackupPolicy
}

GeoBackupPolicyListResult - The response to a list geo backup policies request.

func (GeoBackupPolicyListResult) MarshalJSON 

func (g GeoBackupPolicyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GeoBackupPolicyListResult.

func (*GeoBackupPolicyListResult) UnmarshalJSON added in v0.6.0 

func (g *GeoBackupPolicyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GeoBackupPolicyListResult.

type GeoBackupPolicyName 

type GeoBackupPolicyName string
const (
	GeoBackupPolicyNameDefault GeoBackupPolicyName = "Default"
)

func PossibleGeoBackupPolicyNameValues 

func PossibleGeoBackupPolicyNameValues() []GeoBackupPolicyName

PossibleGeoBackupPolicyNameValues returns the possible values for the GeoBackupPolicyName const type.

type GeoBackupPolicyProperties 

type GeoBackupPolicyProperties struct {
	// REQUIRED; The state of the geo backup policy.
	State *GeoBackupPolicyState

	// READ-ONLY; The storage type of the geo backup policy.
	StorageType *string
}

GeoBackupPolicyProperties - The properties of the geo backup policy.

func (GeoBackupPolicyProperties) MarshalJSON added in v0.6.0 

func (g GeoBackupPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GeoBackupPolicyProperties.

func (*GeoBackupPolicyProperties) UnmarshalJSON added in v0.6.0 

func (g *GeoBackupPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GeoBackupPolicyProperties.

type GeoBackupPolicyState 

type GeoBackupPolicyState string

GeoBackupPolicyState - The state of the geo backup policy. 

const (
	GeoBackupPolicyStateDisabled GeoBackupPolicyState = "Disabled"
	GeoBackupPolicyStateEnabled  GeoBackupPolicyState = "Enabled"
)

func PossibleGeoBackupPolicyStateValues 

func PossibleGeoBackupPolicyStateValues() []GeoBackupPolicyState

PossibleGeoBackupPolicyStateValues returns the possible values for the GeoBackupPolicyState const type.

type GetClient added in v0.6.0 

type GetClient struct {
	// contains filtered or unexported fields
}

GetClient contains the methods for the Get group. Don't use this type directly, use NewGetClient() instead.

func NewGetClient added in v0.6.0 

func NewGetClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*GetClient, error)

NewGetClient creates a new instance of GetClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*GetClient) IntegrationRuntimeEnableInteractivequery added in v0.6.0 

func (client *GetClient) IntegrationRuntimeEnableInteractivequery(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, integrationRuntimeOperationID string, options *GetClientIntegrationRuntimeEnableInteractivequeryOptions) (GetClientIntegrationRuntimeEnableInteractivequeryResponse, error)

IntegrationRuntimeEnableInteractivequery - Get an integration runtime enable interactivequery operation status If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • integrationRuntimeOperationID - Integration runtime Operation Id
  • options - GetClientIntegrationRuntimeEnableInteractivequeryOptions contains the optional parameters for the GetClient.IntegrationRuntimeEnableInteractivequery method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/EnableInteractivequery_IntegrationRuntimes.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewGetClient().IntegrationRuntimeEnableInteractivequery(ctx, "drage-felles-prod-rg", "felles-prod-synapse-workspace", "SSIS-intergrationRuntime-Drage", "5752dcdf918e4aecb941245ddf6ebb83", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeEnableinteractivequery = armsynapse.IntegrationRuntimeEnableinteractivequery{
	// 	Properties: map[string]any{
	// 		"name": "5752dcdf918e4aecb941245ddf6ebb83",
	// 		"error": nil,
	// 		"properties": nil,
	// 		"status": "InProgress",
	// 	},
	// }
}

Output:

func (*GetClient) IntegrationRuntimeStart added in v0.6.0 

func (client *GetClient) IntegrationRuntimeStart(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, integrationRuntimeOperationID string, options *GetClientIntegrationRuntimeStartOptions) (GetClientIntegrationRuntimeStartResponse, error)

IntegrationRuntimeStart - Get an integration runtime start operation status If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • integrationRuntimeOperationID - Integration runtime Operation Id
  • options - GetClientIntegrationRuntimeStartOptions contains the optional parameters for the GetClient.IntegrationRuntimeStart method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Start_OperationStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewGetClient().IntegrationRuntimeStart(ctx, "drage-felles-prod-rg", "felles-prod-synapse-workspace", "SSIS-intergrationRuntime-Drage", "5752dcdf918e4aecb941245ddf6ebb83", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeOperationStatus = armsynapse.IntegrationRuntimeOperationStatus{
	// 	Properties: map[string]any{
	// 		"name": "5752dcdf918e4aecb941245ddf6ebb83",
	// 		"error": nil,
	// 		"properties": nil,
	// 		"status": "InProgress",
	// 	},
	// }
}

Output:

func (*GetClient) IntegrationRuntimeStop added in v0.6.0 

func (client *GetClient) IntegrationRuntimeStop(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, integrationRuntimeOperationID string, options *GetClientIntegrationRuntimeStopOptions) (GetClientIntegrationRuntimeStopResponse, error)

IntegrationRuntimeStop - Get an integration runtime stop operation status If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • integrationRuntimeOperationID - Integration runtime Operation Id
  • options - GetClientIntegrationRuntimeStopOptions contains the optional parameters for the GetClient.IntegrationRuntimeStop method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Stop_OperationStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewGetClient().IntegrationRuntimeStop(ctx, "drage-felles-prod-rg", "felles-prod-synapse-workspace", "SSIS-intergrationRuntime-Drage", "5752dcdf918e4aecb941245ddf6ebb83", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeStopOperationStatus = armsynapse.IntegrationRuntimeStopOperationStatus{
	// 	Properties: map[string]any{
	// 		"name": "5752dcdf918e4aecb941245ddf6ebb83",
	// 		"error": nil,
	// 		"properties": nil,
	// 		"status": "InProgress",
	// 	},
	// }
}

Output:

type GetClientIntegrationRuntimeEnableInteractivequeryOptions added in v0.6.0 

type GetClientIntegrationRuntimeEnableInteractivequeryOptions struct {
}

GetClientIntegrationRuntimeEnableInteractivequeryOptions contains the optional parameters for the GetClient.IntegrationRuntimeEnableInteractivequery method.

type GetClientIntegrationRuntimeEnableInteractivequeryResponse added in v0.6.0 

type GetClientIntegrationRuntimeEnableInteractivequeryResponse struct {
	// Integration Runtime Operation Status Properties
	IntegrationRuntimeEnableinteractivequery
}

GetClientIntegrationRuntimeEnableInteractivequeryResponse contains the response from method GetClient.IntegrationRuntimeEnableInteractivequery.

type GetClientIntegrationRuntimeStartOptions added in v0.6.0 

type GetClientIntegrationRuntimeStartOptions struct {
}

GetClientIntegrationRuntimeStartOptions contains the optional parameters for the GetClient.IntegrationRuntimeStart method.

type GetClientIntegrationRuntimeStartResponse added in v0.6.0 

type GetClientIntegrationRuntimeStartResponse struct {
	// Integration Runtime Operation Status Properties
	IntegrationRuntimeOperationStatus
}

GetClientIntegrationRuntimeStartResponse contains the response from method GetClient.IntegrationRuntimeStart.

type GetClientIntegrationRuntimeStopOptions added in v0.6.0 

type GetClientIntegrationRuntimeStopOptions struct {
}

GetClientIntegrationRuntimeStopOptions contains the optional parameters for the GetClient.IntegrationRuntimeStop method.

type GetClientIntegrationRuntimeStopResponse added in v0.6.0 

type GetClientIntegrationRuntimeStopResponse struct {
	// Integration Runtime Operation Status Properties
	IntegrationRuntimeStopOperationStatus
}

GetClientIntegrationRuntimeStopResponse contains the response from method GetClient.IntegrationRuntimeStop.

type GetSsisObjectMetadataRequest 

type GetSsisObjectMetadataRequest struct {
	// Metadata path.
	MetadataPath *string
}

GetSsisObjectMetadataRequest - The request payload of get SSIS object metadata.

func (GetSsisObjectMetadataRequest) MarshalJSON added in v0.6.0 

func (g GetSsisObjectMetadataRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GetSsisObjectMetadataRequest.

func (*GetSsisObjectMetadataRequest) UnmarshalJSON added in v0.6.0 

func (g *GetSsisObjectMetadataRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GetSsisObjectMetadataRequest.

type IPFirewallRuleInfo 

type IPFirewallRuleInfo struct {
	// IP firewall rule properties
	Properties *IPFirewallRuleProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

IPFirewallRuleInfo - IP firewall rule

func (IPFirewallRuleInfo) MarshalJSON 

func (i IPFirewallRuleInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPFirewallRuleInfo.

func (*IPFirewallRuleInfo) UnmarshalJSON 

func (i *IPFirewallRuleInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPFirewallRuleInfo.

type IPFirewallRuleInfoListResult 

type IPFirewallRuleInfoListResult struct {
	// Link to next page of results
	NextLink *string

	// List of IP firewall rules
	Value []*IPFirewallRuleInfo
}

IPFirewallRuleInfoListResult - List of IP firewall rules

func (IPFirewallRuleInfoListResult) MarshalJSON 

func (i IPFirewallRuleInfoListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPFirewallRuleInfoListResult.

func (*IPFirewallRuleInfoListResult) UnmarshalJSON added in v0.6.0 

func (i *IPFirewallRuleInfoListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPFirewallRuleInfoListResult.

type IPFirewallRuleProperties 

type IPFirewallRuleProperties struct {
	// The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress
	EndIPAddress *string

	// The start IP address of the firewall rule. Must be IPv4 format
	StartIPAddress *string

	// READ-ONLY; Resource provisioning state
	ProvisioningState *ProvisioningState
}

IPFirewallRuleProperties - IP firewall rule properties

func (IPFirewallRuleProperties) MarshalJSON added in v0.6.0 

func (i IPFirewallRuleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPFirewallRuleProperties.

func (*IPFirewallRuleProperties) UnmarshalJSON added in v0.6.0 

func (i *IPFirewallRuleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPFirewallRuleProperties.

type IPFirewallRulesClient 

type IPFirewallRulesClient struct {
	// contains filtered or unexported fields
}

IPFirewallRulesClient contains the methods for the IPFirewallRules group. Don't use this type directly, use NewIPFirewallRulesClient() instead.

func NewIPFirewallRulesClient 

func NewIPFirewallRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*IPFirewallRulesClient, error)

NewIPFirewallRulesClient creates a new instance of IPFirewallRulesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*IPFirewallRulesClient) BeginCreateOrUpdate 

func (client *IPFirewallRulesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, ruleName string, ipFirewallRuleInfo IPFirewallRuleInfo, options *IPFirewallRulesClientBeginCreateOrUpdateOptions) (*runtime.Poller[IPFirewallRulesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a firewall rule If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • ruleName - The IP firewall rule name
  • ipFirewallRuleInfo - IP firewall rule properties
  • options - IPFirewallRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the IPFirewallRulesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateIpFirewallRule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIPFirewallRulesClient().BeginCreateOrUpdate(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExampleIpFirewallRule", armsynapse.IPFirewallRuleInfo{
		Properties: &armsynapse.IPFirewallRuleProperties{
			EndIPAddress:   to.Ptr("10.0.0.254"),
			StartIPAddress: to.Ptr("10.0.0.0"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IPFirewallRuleInfo = armsynapse.IPFirewallRuleInfo{
	// 	Name: to.Ptr("ExampleIpFirewallRule"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/firewallRules"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/firewallRules/ExampleIpFirewallRule"),
	// 	Properties: &armsynapse.IPFirewallRuleProperties{
	// 		EndIPAddress: to.Ptr("10.0.0.254"),
	// 		ProvisioningState: to.Ptr(armsynapse.ProvisioningStateSucceeded),
	// 		StartIPAddress: to.Ptr("10.0.0.0"),
	// 	},
	// }
}

Output:

func (*IPFirewallRulesClient) BeginDelete 

func (client *IPFirewallRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, ruleName string, options *IPFirewallRulesClientBeginDeleteOptions) (*runtime.Poller[IPFirewallRulesClientDeleteResponse], error)

BeginDelete - Deletes a firewall rule If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • ruleName - The IP firewall rule name
  • options - IPFirewallRulesClientBeginDeleteOptions contains the optional parameters for the IPFirewallRulesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteIpFirewallRule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIPFirewallRulesClient().BeginDelete(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExampleIpFirewallRule", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IPFirewallRuleInfo = armsynapse.IPFirewallRuleInfo{
	// 	Name: to.Ptr("ExampleIpFirewallRule"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/firewallRules"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/firewallRules/ExampleIpFirewallRule"),
	// 	Properties: &armsynapse.IPFirewallRuleProperties{
	// 		EndIPAddress: to.Ptr("10.0.0.254"),
	// 		ProvisioningState: to.Ptr(armsynapse.ProvisioningStateSucceeded),
	// 		StartIPAddress: to.Ptr("10.0.0.0"),
	// 	},
	// }
}

Output:

func (*IPFirewallRulesClient) BeginReplaceAll 

func (client *IPFirewallRulesClient) BeginReplaceAll(ctx context.Context, resourceGroupName string, workspaceName string, request ReplaceAllIPFirewallRulesRequest, options *IPFirewallRulesClientBeginReplaceAllOptions) (*runtime.Poller[IPFirewallRulesClientReplaceAllResponse], error)

BeginReplaceAll - Replaces firewall rules If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • request - Replace all IP firewall rules request
  • options - IPFirewallRulesClientBeginReplaceAllOptions contains the optional parameters for the IPFirewallRulesClient.BeginReplaceAll method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ReplaceAllIpFirewallRules.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIPFirewallRulesClient().BeginReplaceAll(ctx, "ExampleResourceGroup", "ExampleWorkspace", armsynapse.ReplaceAllIPFirewallRulesRequest{
		IPFirewallRules: map[string]*armsynapse.IPFirewallRuleProperties{
			"AnotherExampleFirewallRule": {
				EndIPAddress:   to.Ptr("10.0.1.254"),
				StartIPAddress: to.Ptr("10.0.1.0"),
			},
			"ExampleFirewallRule": {
				EndIPAddress:   to.Ptr("10.0.0.254"),
				StartIPAddress: to.Ptr("10.0.0.0"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ReplaceAllFirewallRulesOperationResponse = armsynapse.ReplaceAllFirewallRulesOperationResponse{
	// 	OperationID: to.Ptr("00000000-1111-4444-2222-333333333333"),
	// }
}

Output:

func (*IPFirewallRulesClient) Get 

func (client *IPFirewallRulesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, ruleName string, options *IPFirewallRulesClientGetOptions) (IPFirewallRulesClientGetResponse, error)

Get - Get a firewall rule If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • ruleName - The IP firewall rule name
  • options - IPFirewallRulesClientGetOptions contains the optional parameters for the IPFirewallRulesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetIpFirewallRule.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIPFirewallRulesClient().Get(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExampleIpFirewallRule", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IPFirewallRuleInfo = armsynapse.IPFirewallRuleInfo{
	// 	Name: to.Ptr("ExampleIpFirewallRule"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/firewallRules"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/firewallRules/ExampleIpFirewallRule"),
	// 	Properties: &armsynapse.IPFirewallRuleProperties{
	// 		EndIPAddress: to.Ptr("10.0.0.254"),
	// 		ProvisioningState: to.Ptr(armsynapse.ProvisioningStateSucceeded),
	// 		StartIPAddress: to.Ptr("10.0.0.0"),
	// 	},
	// }
}

Output:

func (*IPFirewallRulesClient) NewListByWorkspacePager added in v0.4.0 

func (client *IPFirewallRulesClient) NewListByWorkspacePager(resourceGroupName string, workspaceName string, options *IPFirewallRulesClientListByWorkspaceOptions) *runtime.Pager[IPFirewallRulesClientListByWorkspaceResponse]

NewListByWorkspacePager - Returns a list of firewall rules

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - IPFirewallRulesClientListByWorkspaceOptions contains the optional parameters for the IPFirewallRulesClient.NewListByWorkspacePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListIpFirewallRules.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewIPFirewallRulesClient().NewListByWorkspacePager("ExampleResourceGroup", "ExampleWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.IPFirewallRuleInfoListResult = armsynapse.IPFirewallRuleInfoListResult{
		// 	Value: []*armsynapse.IPFirewallRuleInfo{
		// 	},
		// }
	}
}

Output:

type IPFirewallRulesClientBeginCreateOrUpdateOptions added in v0.2.0 

type IPFirewallRulesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IPFirewallRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the IPFirewallRulesClient.BeginCreateOrUpdate method.

type IPFirewallRulesClientBeginDeleteOptions added in v0.2.0 

type IPFirewallRulesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IPFirewallRulesClientBeginDeleteOptions contains the optional parameters for the IPFirewallRulesClient.BeginDelete method.

type IPFirewallRulesClientBeginReplaceAllOptions added in v0.2.0 

type IPFirewallRulesClientBeginReplaceAllOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IPFirewallRulesClientBeginReplaceAllOptions contains the optional parameters for the IPFirewallRulesClient.BeginReplaceAll method.

type IPFirewallRulesClientCreateOrUpdateResponse added in v0.2.0 

type IPFirewallRulesClientCreateOrUpdateResponse struct {
	// IP firewall rule
	IPFirewallRuleInfo
}

IPFirewallRulesClientCreateOrUpdateResponse contains the response from method IPFirewallRulesClient.BeginCreateOrUpdate.

type IPFirewallRulesClientDeleteResponse added in v0.2.0 

type IPFirewallRulesClientDeleteResponse struct {
	// IP firewall rule
	IPFirewallRuleInfo
}

IPFirewallRulesClientDeleteResponse contains the response from method IPFirewallRulesClient.BeginDelete.

type IPFirewallRulesClientGetOptions added in v0.2.0 

type IPFirewallRulesClientGetOptions struct {
}

IPFirewallRulesClientGetOptions contains the optional parameters for the IPFirewallRulesClient.Get method.

type IPFirewallRulesClientGetResponse added in v0.2.0 

type IPFirewallRulesClientGetResponse struct {
	// IP firewall rule
	IPFirewallRuleInfo
}

IPFirewallRulesClientGetResponse contains the response from method IPFirewallRulesClient.Get.

type IPFirewallRulesClientListByWorkspaceOptions added in v0.2.0 

type IPFirewallRulesClientListByWorkspaceOptions struct {
}

IPFirewallRulesClientListByWorkspaceOptions contains the optional parameters for the IPFirewallRulesClient.NewListByWorkspacePager method.

type IPFirewallRulesClientListByWorkspaceResponse added in v0.2.0 

type IPFirewallRulesClientListByWorkspaceResponse struct {
	// List of IP firewall rules
	IPFirewallRuleInfoListResult
}

IPFirewallRulesClientListByWorkspaceResponse contains the response from method IPFirewallRulesClient.NewListByWorkspacePager.

type IPFirewallRulesClientReplaceAllResponse added in v0.2.0 

type IPFirewallRulesClientReplaceAllResponse struct {
	// An existing operation for replacing the firewall rules
	ReplaceAllFirewallRulesOperationResponse
}

IPFirewallRulesClientReplaceAllResponse contains the response from method IPFirewallRulesClient.BeginReplaceAll.

type IntegrationRuntime 

type IntegrationRuntime struct {
	// REQUIRED; Type of integration runtime.
	Type *IntegrationRuntimeType

	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// Integration runtime description.
	Description *string
}

IntegrationRuntime - Azure Synapse nested object which serves as a compute resource for activities.

func (*IntegrationRuntime) GetIntegrationRuntime 

func (i *IntegrationRuntime) GetIntegrationRuntime() *IntegrationRuntime

GetIntegrationRuntime implements the IntegrationRuntimeClassification interface for type IntegrationRuntime.

func (IntegrationRuntime) MarshalJSON added in v0.2.0 

func (i IntegrationRuntime) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntime.

func (*IntegrationRuntime) UnmarshalJSON 

func (i *IntegrationRuntime) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntime.

type IntegrationRuntimeAuthKeyName 

type IntegrationRuntimeAuthKeyName string

IntegrationRuntimeAuthKeyName - The name of the authentication key to regenerate. 

const (
	IntegrationRuntimeAuthKeyNameAuthKey1 IntegrationRuntimeAuthKeyName = "authKey1"
	IntegrationRuntimeAuthKeyNameAuthKey2 IntegrationRuntimeAuthKeyName = "authKey2"
)

func PossibleIntegrationRuntimeAuthKeyNameValues 

func PossibleIntegrationRuntimeAuthKeyNameValues() []IntegrationRuntimeAuthKeyName

PossibleIntegrationRuntimeAuthKeyNameValues returns the possible values for the IntegrationRuntimeAuthKeyName const type.

type IntegrationRuntimeAuthKeys 

type IntegrationRuntimeAuthKeys struct {
	// The primary integration runtime authentication key.
	AuthKey1 *string

	// The secondary integration runtime authentication key.
	AuthKey2 *string
}

IntegrationRuntimeAuthKeys - The integration runtime authentication keys.

func (IntegrationRuntimeAuthKeys) MarshalJSON added in v0.6.0 

func (i IntegrationRuntimeAuthKeys) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeAuthKeys.

func (*IntegrationRuntimeAuthKeys) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeAuthKeys) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeAuthKeys.

type IntegrationRuntimeAuthKeysClient 

type IntegrationRuntimeAuthKeysClient struct {
	// contains filtered or unexported fields
}

IntegrationRuntimeAuthKeysClient contains the methods for the IntegrationRuntimeAuthKeys group. Don't use this type directly, use NewIntegrationRuntimeAuthKeysClient() instead.

func NewIntegrationRuntimeAuthKeysClient 

func NewIntegrationRuntimeAuthKeysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*IntegrationRuntimeAuthKeysClient, error)

NewIntegrationRuntimeAuthKeysClient creates a new instance of IntegrationRuntimeAuthKeysClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*IntegrationRuntimeAuthKeysClient) List 

func (client *IntegrationRuntimeAuthKeysClient) List(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimeAuthKeysClientListOptions) (IntegrationRuntimeAuthKeysClientListResponse, error)

List - List authentication keys in an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimeAuthKeysClientListOptions contains the optional parameters for the IntegrationRuntimeAuthKeysClient.List method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_ListAuthKeys.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimeAuthKeysClient().List(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeAuthKeys = armsynapse.IntegrationRuntimeAuthKeys{
	// 	AuthKey1: to.Ptr("**********"),
	// 	AuthKey2: to.Ptr("**********"),
	// }
}

Output:

func (*IntegrationRuntimeAuthKeysClient) Regenerate 

func (client *IntegrationRuntimeAuthKeysClient) Regenerate(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, regenerateKeyParameters IntegrationRuntimeRegenerateKeyParameters, options *IntegrationRuntimeAuthKeysClientRegenerateOptions) (IntegrationRuntimeAuthKeysClientRegenerateResponse, error)

Regenerate - Regenerate the authentication key for an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • regenerateKeyParameters - The parameters for regenerating integration runtime authentication key.
  • options - IntegrationRuntimeAuthKeysClientRegenerateOptions contains the optional parameters for the IntegrationRuntimeAuthKeysClient.Regenerate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_RegenerateAuthKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimeAuthKeysClient().Regenerate(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", armsynapse.IntegrationRuntimeRegenerateKeyParameters{
		KeyName: to.Ptr(armsynapse.IntegrationRuntimeAuthKeyNameAuthKey2),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeAuthKeys = armsynapse.IntegrationRuntimeAuthKeys{
	// 	AuthKey2: to.Ptr("**********"),
	// }
}

Output:

type IntegrationRuntimeAuthKeysClientListOptions added in v0.2.0 

type IntegrationRuntimeAuthKeysClientListOptions struct {
}

IntegrationRuntimeAuthKeysClientListOptions contains the optional parameters for the IntegrationRuntimeAuthKeysClient.List method.

type IntegrationRuntimeAuthKeysClientListResponse added in v0.2.0 

type IntegrationRuntimeAuthKeysClientListResponse struct {
	// The integration runtime authentication keys.
	IntegrationRuntimeAuthKeys
}

IntegrationRuntimeAuthKeysClientListResponse contains the response from method IntegrationRuntimeAuthKeysClient.List.

type IntegrationRuntimeAuthKeysClientRegenerateOptions added in v0.2.0 

type IntegrationRuntimeAuthKeysClientRegenerateOptions struct {
}

IntegrationRuntimeAuthKeysClientRegenerateOptions contains the optional parameters for the IntegrationRuntimeAuthKeysClient.Regenerate method.

type IntegrationRuntimeAuthKeysClientRegenerateResponse added in v0.2.0 

type IntegrationRuntimeAuthKeysClientRegenerateResponse struct {
	// The integration runtime authentication keys.
	IntegrationRuntimeAuthKeys
}

IntegrationRuntimeAuthKeysClientRegenerateResponse contains the response from method IntegrationRuntimeAuthKeysClient.Regenerate.

type IntegrationRuntimeAutoUpdate 

type IntegrationRuntimeAutoUpdate string

IntegrationRuntimeAutoUpdate - The state of integration runtime auto update. 

const (
	IntegrationRuntimeAutoUpdateOff IntegrationRuntimeAutoUpdate = "Off"
	IntegrationRuntimeAutoUpdateOn  IntegrationRuntimeAutoUpdate = "On"
)

func PossibleIntegrationRuntimeAutoUpdateValues 

func PossibleIntegrationRuntimeAutoUpdateValues() []IntegrationRuntimeAutoUpdate

PossibleIntegrationRuntimeAutoUpdateValues returns the possible values for the IntegrationRuntimeAutoUpdate const type.

type IntegrationRuntimeClassification 

type IntegrationRuntimeClassification interface {
	// GetIntegrationRuntime returns the IntegrationRuntime content of the underlying type.
	GetIntegrationRuntime() *IntegrationRuntime
}

IntegrationRuntimeClassification provides polymorphic access to related types. Call the interface's GetIntegrationRuntime() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *IntegrationRuntime, *ManagedIntegrationRuntime, *SelfHostedIntegrationRuntime

type IntegrationRuntimeComputeProperties 

type IntegrationRuntimeComputeProperties struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// Data flow properties for managed integration runtime.
	DataFlowProperties *IntegrationRuntimeDataFlowProperties

	// The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities
	Location *string

	// Maximum parallel executions count per node for managed integration runtime.
	MaxParallelExecutionsPerNode *int32

	// The node size requirement to managed integration runtime.
	NodeSize *string

	// The required number of nodes for managed integration runtime.
	NumberOfNodes *int32

	// VNet properties for managed integration runtime.
	VNetProperties *IntegrationRuntimeVNetProperties
}

IntegrationRuntimeComputeProperties - The compute resource properties for managed integration runtime.

func (IntegrationRuntimeComputeProperties) MarshalJSON 

func (i IntegrationRuntimeComputeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeComputeProperties.

func (*IntegrationRuntimeComputeProperties) UnmarshalJSON 

func (i *IntegrationRuntimeComputeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeComputeProperties.

type IntegrationRuntimeConnectionInfo 

type IntegrationRuntimeConnectionInfo struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// READ-ONLY; The on-premises integration runtime host URL.
	HostServiceURI *string

	// READ-ONLY; The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation.
	IdentityCertThumbprint *string

	// READ-ONLY; Whether the identity certificate is expired.
	IsIdentityCertExprired *bool

	// READ-ONLY; The public key for encrypting a credential when transferring the credential to the integration runtime.
	PublicKey *string

	// READ-ONLY; The token generated in service. Callers use this token to authenticate to integration runtime.
	ServiceToken *string

	// READ-ONLY; The integration runtime version.
	Version *string
}

IntegrationRuntimeConnectionInfo - Connection information for encrypting the on-premises data source credentials.

func (IntegrationRuntimeConnectionInfo) MarshalJSON 

func (i IntegrationRuntimeConnectionInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeConnectionInfo.

func (*IntegrationRuntimeConnectionInfo) UnmarshalJSON 

func (i *IntegrationRuntimeConnectionInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeConnectionInfo.

type IntegrationRuntimeConnectionInfosClient 

type IntegrationRuntimeConnectionInfosClient struct {
	// contains filtered or unexported fields
}

IntegrationRuntimeConnectionInfosClient contains the methods for the IntegrationRuntimeConnectionInfos group. Don't use this type directly, use NewIntegrationRuntimeConnectionInfosClient() instead.

func NewIntegrationRuntimeConnectionInfosClient 

func NewIntegrationRuntimeConnectionInfosClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*IntegrationRuntimeConnectionInfosClient, error)

NewIntegrationRuntimeConnectionInfosClient creates a new instance of IntegrationRuntimeConnectionInfosClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*IntegrationRuntimeConnectionInfosClient) Get 

func (client *IntegrationRuntimeConnectionInfosClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimeConnectionInfosClientGetOptions) (IntegrationRuntimeConnectionInfosClientGetResponse, error)

Get - Get connection info for an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimeConnectionInfosClientGetOptions contains the optional parameters for the IntegrationRuntimeConnectionInfosClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_GetConnectionInfo.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimeConnectionInfosClient().Get(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeConnectionInfo = armsynapse.IntegrationRuntimeConnectionInfo{
	// 	HostServiceURI: to.Ptr("https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/"),
	// 	IdentityCertThumbprint: to.Ptr("**********"),
	// 	IsIdentityCertExprired: to.Ptr(false),
	// 	PublicKey: to.Ptr("**********"),
	// 	ServiceToken: to.Ptr("**********"),
	// 	Version: to.Ptr("3.8.6730.2"),
	// }
}

Output:

type IntegrationRuntimeConnectionInfosClientGetOptions added in v0.2.0 

type IntegrationRuntimeConnectionInfosClientGetOptions struct {
}

IntegrationRuntimeConnectionInfosClientGetOptions contains the optional parameters for the IntegrationRuntimeConnectionInfosClient.Get method.

type IntegrationRuntimeConnectionInfosClientGetResponse added in v0.2.0 

type IntegrationRuntimeConnectionInfosClientGetResponse struct {
	// Connection information for encrypting the on-premises data source credentials.
	IntegrationRuntimeConnectionInfo
}

IntegrationRuntimeConnectionInfosClientGetResponse contains the response from method IntegrationRuntimeConnectionInfosClient.Get.

type IntegrationRuntimeCredentialsClient 

type IntegrationRuntimeCredentialsClient struct {
	// contains filtered or unexported fields
}

IntegrationRuntimeCredentialsClient contains the methods for the IntegrationRuntimeCredentials group. Don't use this type directly, use NewIntegrationRuntimeCredentialsClient() instead.

func NewIntegrationRuntimeCredentialsClient 

func NewIntegrationRuntimeCredentialsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*IntegrationRuntimeCredentialsClient, error)

NewIntegrationRuntimeCredentialsClient creates a new instance of IntegrationRuntimeCredentialsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*IntegrationRuntimeCredentialsClient) Sync 

func (client *IntegrationRuntimeCredentialsClient) Sync(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimeCredentialsClientSyncOptions) (IntegrationRuntimeCredentialsClientSyncResponse, error)

Sync - Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimeCredentialsClientSyncOptions contains the optional parameters for the IntegrationRuntimeCredentialsClient.Sync method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_SyncCredentials.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewIntegrationRuntimeCredentialsClient().Sync(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type IntegrationRuntimeCredentialsClientSyncOptions added in v0.2.0 

type IntegrationRuntimeCredentialsClientSyncOptions struct {
}

IntegrationRuntimeCredentialsClientSyncOptions contains the optional parameters for the IntegrationRuntimeCredentialsClient.Sync method.

type IntegrationRuntimeCredentialsClientSyncResponse added in v0.2.0 

type IntegrationRuntimeCredentialsClientSyncResponse struct {
}

IntegrationRuntimeCredentialsClientSyncResponse contains the response from method IntegrationRuntimeCredentialsClient.Sync.

type IntegrationRuntimeCustomSetupScriptProperties 

type IntegrationRuntimeCustomSetupScriptProperties struct {
	// The URI of the Azure blob container that contains the custom setup script.
	BlobContainerURI *string

	// The SAS token of the Azure blob container.
	SasToken *SecureString
}

IntegrationRuntimeCustomSetupScriptProperties - Custom setup script properties for a managed dedicated integration runtime.

func (IntegrationRuntimeCustomSetupScriptProperties) MarshalJSON added in v0.6.0 

func (i IntegrationRuntimeCustomSetupScriptProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeCustomSetupScriptProperties.

func (*IntegrationRuntimeCustomSetupScriptProperties) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeCustomSetupScriptProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeCustomSetupScriptProperties.

type IntegrationRuntimeDataFlowProperties 

type IntegrationRuntimeDataFlowProperties struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if
	// this is set as false. Default is true.
	Cleanup *bool

	// Compute type of the cluster which will execute data flow job.
	ComputeType *DataFlowComputeType

	// Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.
	CoreCount *int32

	// Time to live (in minutes) setting of the cluster which will execute data flow job.
	TimeToLive *int32
}

IntegrationRuntimeDataFlowProperties - Data flow properties for managed integration runtime.

func (IntegrationRuntimeDataFlowProperties) MarshalJSON 

func (i IntegrationRuntimeDataFlowProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeDataFlowProperties.

func (*IntegrationRuntimeDataFlowProperties) UnmarshalJSON 

func (i *IntegrationRuntimeDataFlowProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeDataFlowProperties.

type IntegrationRuntimeDataProxyProperties 

type IntegrationRuntimeDataProxyProperties struct {
	// The self-hosted integration runtime reference.
	ConnectVia *EntityReference

	// The path to contain the staged data in the Blob storage.
	Path *string

	// The staging linked service reference.
	StagingLinkedService *EntityReference
}

IntegrationRuntimeDataProxyProperties - Data proxy properties for a managed dedicated integration runtime.

func (IntegrationRuntimeDataProxyProperties) MarshalJSON added in v0.6.0 

func (i IntegrationRuntimeDataProxyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeDataProxyProperties.

func (*IntegrationRuntimeDataProxyProperties) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeDataProxyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeDataProxyProperties.

type IntegrationRuntimeEdition 

type IntegrationRuntimeEdition string

IntegrationRuntimeEdition - The edition for the SSIS Integration Runtime 

const (
	IntegrationRuntimeEditionEnterprise IntegrationRuntimeEdition = "Enterprise"
	IntegrationRuntimeEditionStandard   IntegrationRuntimeEdition = "Standard"
)

func PossibleIntegrationRuntimeEditionValues 

func PossibleIntegrationRuntimeEditionValues() []IntegrationRuntimeEdition

PossibleIntegrationRuntimeEditionValues returns the possible values for the IntegrationRuntimeEdition const type.

type IntegrationRuntimeEnableinteractivequery added in v0.6.0 

type IntegrationRuntimeEnableinteractivequery struct {
	// The operation error message.
	Error *string

	// The operation name.
	Name *string

	// The operation properties.
	Properties any

	// EnableInteractivequery status of Integrationruntimes.
	Status *WorkspaceStatus
}

IntegrationRuntimeEnableinteractivequery - Integration Runtime Operation Status Properties

func (IntegrationRuntimeEnableinteractivequery) MarshalJSON added in v0.6.0 

func (i IntegrationRuntimeEnableinteractivequery) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeEnableinteractivequery.

func (*IntegrationRuntimeEnableinteractivequery) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeEnableinteractivequery) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeEnableinteractivequery.

type IntegrationRuntimeEntityReferenceType 

type IntegrationRuntimeEntityReferenceType string

IntegrationRuntimeEntityReferenceType - The type of this referenced entity. 

const (
	IntegrationRuntimeEntityReferenceTypeIntegrationRuntimeReference IntegrationRuntimeEntityReferenceType = "IntegrationRuntimeReference"
	IntegrationRuntimeEntityReferenceTypeLinkedServiceReference      IntegrationRuntimeEntityReferenceType = "LinkedServiceReference"
)

func PossibleIntegrationRuntimeEntityReferenceTypeValues 

func PossibleIntegrationRuntimeEntityReferenceTypeValues() []IntegrationRuntimeEntityReferenceType

PossibleIntegrationRuntimeEntityReferenceTypeValues returns the possible values for the IntegrationRuntimeEntityReferenceType const type.

type IntegrationRuntimeInternalChannelEncryptionMode 

type IntegrationRuntimeInternalChannelEncryptionMode string

IntegrationRuntimeInternalChannelEncryptionMode - It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist). 

const (
	IntegrationRuntimeInternalChannelEncryptionModeNotEncrypted IntegrationRuntimeInternalChannelEncryptionMode = "NotEncrypted"
	IntegrationRuntimeInternalChannelEncryptionModeNotSet       IntegrationRuntimeInternalChannelEncryptionMode = "NotSet"
	IntegrationRuntimeInternalChannelEncryptionModeSSLEncrypted IntegrationRuntimeInternalChannelEncryptionMode = "SslEncrypted"
)

func PossibleIntegrationRuntimeInternalChannelEncryptionModeValues 

func PossibleIntegrationRuntimeInternalChannelEncryptionModeValues() []IntegrationRuntimeInternalChannelEncryptionMode

PossibleIntegrationRuntimeInternalChannelEncryptionModeValues returns the possible values for the IntegrationRuntimeInternalChannelEncryptionMode const type.

type IntegrationRuntimeLicenseType 

type IntegrationRuntimeLicenseType string

IntegrationRuntimeLicenseType - License type for bringing your own license scenario. 

const (
	IntegrationRuntimeLicenseTypeBasePrice       IntegrationRuntimeLicenseType = "BasePrice"
	IntegrationRuntimeLicenseTypeLicenseIncluded IntegrationRuntimeLicenseType = "LicenseIncluded"
)

func PossibleIntegrationRuntimeLicenseTypeValues 

func PossibleIntegrationRuntimeLicenseTypeValues() []IntegrationRuntimeLicenseType

PossibleIntegrationRuntimeLicenseTypeValues returns the possible values for the IntegrationRuntimeLicenseType const type.

type IntegrationRuntimeListResponse 

type IntegrationRuntimeListResponse struct {
	// REQUIRED; List of integration runtimes.
	Value []*IntegrationRuntimeResource

	// The link to the next page of results, if any remaining results exist.
	NextLink *string
}

IntegrationRuntimeListResponse - A list of integration runtime resources.

func (IntegrationRuntimeListResponse) MarshalJSON 

func (i IntegrationRuntimeListResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeListResponse.

func (*IntegrationRuntimeListResponse) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeListResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeListResponse.

type IntegrationRuntimeMonitoringData 

type IntegrationRuntimeMonitoringData struct {
	// Integration runtime name.
	Name *string

	// Integration runtime node monitoring data.
	Nodes []*IntegrationRuntimeNodeMonitoringData
}

IntegrationRuntimeMonitoringData - Get monitoring data response.

func (IntegrationRuntimeMonitoringData) MarshalJSON 

func (i IntegrationRuntimeMonitoringData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeMonitoringData.

func (*IntegrationRuntimeMonitoringData) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeMonitoringData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeMonitoringData.

type IntegrationRuntimeMonitoringDataClient 

type IntegrationRuntimeMonitoringDataClient struct {
	// contains filtered or unexported fields
}

IntegrationRuntimeMonitoringDataClient contains the methods for the IntegrationRuntimeMonitoringData group. Don't use this type directly, use NewIntegrationRuntimeMonitoringDataClient() instead.

func NewIntegrationRuntimeMonitoringDataClient 

func NewIntegrationRuntimeMonitoringDataClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*IntegrationRuntimeMonitoringDataClient, error)

NewIntegrationRuntimeMonitoringDataClient creates a new instance of IntegrationRuntimeMonitoringDataClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*IntegrationRuntimeMonitoringDataClient) List 

func (client *IntegrationRuntimeMonitoringDataClient) List(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimeMonitoringDataClientListOptions) (IntegrationRuntimeMonitoringDataClientListResponse, error)

List - Get monitoring data for an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimeMonitoringDataClientListOptions contains the optional parameters for the IntegrationRuntimeMonitoringDataClient.List method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimeMonitoringData_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimeMonitoringDataClient().List(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeMonitoringData = armsynapse.IntegrationRuntimeMonitoringData{
	// 	Name: to.Ptr("exampleIntegrationRuntime"),
	// 	Nodes: []*armsynapse.IntegrationRuntimeNodeMonitoringData{
	// 		{
	// 			AvailableMemoryInMB: to.Ptr[int32](16740),
	// 			ConcurrentJobsLimit: to.Ptr[int32](28),
	// 			ConcurrentJobsRunning: to.Ptr[int32](0),
	// 			CPUUtilization: to.Ptr[int32](15),
	// 			NodeName: to.Ptr("Node_1"),
	// 			ReceivedBytes: to.Ptr[float32](6.731423377990723),
	// 			SentBytes: to.Ptr[float32](2.647491693496704),
	// 	}},
	// }
}

Output:

type IntegrationRuntimeMonitoringDataClientListOptions added in v0.2.0 

type IntegrationRuntimeMonitoringDataClientListOptions struct {
}

IntegrationRuntimeMonitoringDataClientListOptions contains the optional parameters for the IntegrationRuntimeMonitoringDataClient.List method.

type IntegrationRuntimeMonitoringDataClientListResponse added in v0.2.0 

type IntegrationRuntimeMonitoringDataClientListResponse struct {
	// Get monitoring data response.
	IntegrationRuntimeMonitoringData
}

IntegrationRuntimeMonitoringDataClientListResponse contains the response from method IntegrationRuntimeMonitoringDataClient.List.

type IntegrationRuntimeNodeIPAddress 

type IntegrationRuntimeNodeIPAddress struct {
	// READ-ONLY; The IP address of self-hosted integration runtime node.
	IPAddress *string
}

IntegrationRuntimeNodeIPAddress - The IP address of self-hosted integration runtime node.

func (IntegrationRuntimeNodeIPAddress) MarshalJSON added in v0.6.0 

func (i IntegrationRuntimeNodeIPAddress) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeNodeIPAddress.

func (*IntegrationRuntimeNodeIPAddress) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeNodeIPAddress) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeNodeIPAddress.

type IntegrationRuntimeNodeIPAddressClient 

type IntegrationRuntimeNodeIPAddressClient struct {
	// contains filtered or unexported fields
}

IntegrationRuntimeNodeIPAddressClient contains the methods for the IntegrationRuntimeNodeIPAddress group. Don't use this type directly, use NewIntegrationRuntimeNodeIPAddressClient() instead.

func NewIntegrationRuntimeNodeIPAddressClient 

func NewIntegrationRuntimeNodeIPAddressClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*IntegrationRuntimeNodeIPAddressClient, error)

NewIntegrationRuntimeNodeIPAddressClient creates a new instance of IntegrationRuntimeNodeIPAddressClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*IntegrationRuntimeNodeIPAddressClient) Get 

func (client *IntegrationRuntimeNodeIPAddressClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, nodeName string, options *IntegrationRuntimeNodeIPAddressClientGetOptions) (IntegrationRuntimeNodeIPAddressClientGetResponse, error)

Get - Get the IP address of an integration runtime node If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • nodeName - Integration runtime node name
  • options - IntegrationRuntimeNodeIPAddressClientGetOptions contains the optional parameters for the IntegrationRuntimeNodeIPAddressClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimeNodes_GetIpAddress.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimeNodeIPAddressClient().Get(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", "Node_1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeNodeIPAddress = armsynapse.IntegrationRuntimeNodeIPAddress{
	// 	IPAddress: to.Ptr("**********"),
	// }
}

Output:

type IntegrationRuntimeNodeIPAddressClientGetOptions added in v0.2.0 

type IntegrationRuntimeNodeIPAddressClientGetOptions struct {
}

IntegrationRuntimeNodeIPAddressClientGetOptions contains the optional parameters for the IntegrationRuntimeNodeIPAddressClient.Get method.

type IntegrationRuntimeNodeIPAddressClientGetResponse added in v0.2.0 

type IntegrationRuntimeNodeIPAddressClientGetResponse struct {
	// The IP address of self-hosted integration runtime node.
	IntegrationRuntimeNodeIPAddress
}

IntegrationRuntimeNodeIPAddressClientGetResponse contains the response from method IntegrationRuntimeNodeIPAddressClient.Get.

type IntegrationRuntimeNodeMonitoringData 

type IntegrationRuntimeNodeMonitoringData struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// READ-ONLY; Available memory (MB) on the integration runtime node.
	AvailableMemoryInMB *int32

	// READ-ONLY; CPU percentage on the integration runtime node.
	CPUUtilization *int32

	// READ-ONLY; Maximum concurrent jobs on the integration runtime node.
	ConcurrentJobsLimit *int32

	// READ-ONLY; The number of jobs currently running on the integration runtime node.
	ConcurrentJobsRunning *int32

	// READ-ONLY; The maximum concurrent jobs in this integration runtime.
	MaxConcurrentJobs *int32

	// READ-ONLY; Name of the integration runtime node.
	NodeName *string

	// READ-ONLY; Received bytes on the integration runtime node.
	ReceivedBytes *float32

	// READ-ONLY; Sent bytes on the integration runtime node.
	SentBytes *float32
}

IntegrationRuntimeNodeMonitoringData - Monitoring data for integration runtime node.

func (IntegrationRuntimeNodeMonitoringData) MarshalJSON 

func (i IntegrationRuntimeNodeMonitoringData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeNodeMonitoringData.

func (*IntegrationRuntimeNodeMonitoringData) UnmarshalJSON 

func (i *IntegrationRuntimeNodeMonitoringData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeNodeMonitoringData.

type IntegrationRuntimeNodesClient 

type IntegrationRuntimeNodesClient struct {
	// contains filtered or unexported fields
}

IntegrationRuntimeNodesClient contains the methods for the IntegrationRuntimeNodes group. Don't use this type directly, use NewIntegrationRuntimeNodesClient() instead.

func NewIntegrationRuntimeNodesClient 

func NewIntegrationRuntimeNodesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*IntegrationRuntimeNodesClient, error)

NewIntegrationRuntimeNodesClient creates a new instance of IntegrationRuntimeNodesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*IntegrationRuntimeNodesClient) Delete 

func (client *IntegrationRuntimeNodesClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, nodeName string, options *IntegrationRuntimeNodesClientDeleteOptions) (IntegrationRuntimeNodesClientDeleteResponse, error)

Delete - Delete an integration runtime node If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • nodeName - Integration runtime node name
  • options - IntegrationRuntimeNodesClientDeleteOptions contains the optional parameters for the IntegrationRuntimeNodesClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimeNodes_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewIntegrationRuntimeNodesClient().Delete(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", "Node_1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*IntegrationRuntimeNodesClient) Get 

func (client *IntegrationRuntimeNodesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, nodeName string, options *IntegrationRuntimeNodesClientGetOptions) (IntegrationRuntimeNodesClientGetResponse, error)

Get - Get an integration runtime node If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • nodeName - Integration runtime node name
  • options - IntegrationRuntimeNodesClientGetOptions contains the optional parameters for the IntegrationRuntimeNodesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimeNodes_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimeNodesClient().Get(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", "Node_1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SelfHostedIntegrationRuntimeNode = armsynapse.SelfHostedIntegrationRuntimeNode{
	// 	Capabilities: map[string]*string{
	// 		"connectedToResourceManager": to.Ptr("True"),
	// 		"credentialInSync": to.Ptr("True"),
	// 		"httpsPortEnabled": to.Ptr("True"),
	// 		"nodeEnabled": to.Ptr("True"),
	// 		"serviceBusConnected": to.Ptr("True"),
	// 	},
	// 	HostServiceURI: to.Ptr("https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/"),
	// 	IsActiveDispatcher: to.Ptr(true),
	// 	LastConnectTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-17T06:30:46.626Z"); return t}()),
	// 	LastStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-17T03:45:30.849Z"); return t}()),
	// 	LastUpdateResult: to.Ptr(armsynapse.IntegrationRuntimeUpdateResultNone),
	// 	MachineName: to.Ptr("YANZHANG-DT"),
	// 	MaxConcurrentJobs: to.Ptr[int32](20),
	// 	NodeName: to.Ptr("Node_1"),
	// 	RegisterTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-17T03:44:55.801Z"); return t}()),
	// 	Status: to.Ptr(armsynapse.SelfHostedIntegrationRuntimeNodeStatusOnline),
	// 	Version: to.Ptr("3.8.6743.6"),
	// 	VersionStatus: to.Ptr("UpToDate"),
	// }
}

Output:

func (*IntegrationRuntimeNodesClient) Update 

func (client *IntegrationRuntimeNodesClient) Update(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, nodeName string, updateIntegrationRuntimeNodeRequest UpdateIntegrationRuntimeNodeRequest, options *IntegrationRuntimeNodesClientUpdateOptions) (IntegrationRuntimeNodesClientUpdateResponse, error)

Update - Create an integration runtime node If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • nodeName - Integration runtime node name
  • updateIntegrationRuntimeNodeRequest - The parameters for updating an integration runtime node.
  • options - IntegrationRuntimeNodesClientUpdateOptions contains the optional parameters for the IntegrationRuntimeNodesClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimeNodes_Update.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimeNodesClient().Update(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", "Node_1", armsynapse.UpdateIntegrationRuntimeNodeRequest{
		ConcurrentJobsLimit: to.Ptr[int32](2),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SelfHostedIntegrationRuntimeNode = armsynapse.SelfHostedIntegrationRuntimeNode{
	// 	Capabilities: map[string]*string{
	// 		"connectedToResourceManager": to.Ptr("True"),
	// 		"credentialInSync": to.Ptr("True"),
	// 		"httpsPortEnabled": to.Ptr("True"),
	// 		"nodeEnabled": to.Ptr("True"),
	// 		"serviceBusConnected": to.Ptr("True"),
	// 	},
	// 	ConcurrentJobsLimit: to.Ptr[int32](2),
	// 	HostServiceURI: to.Ptr("https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/"),
	// 	IsActiveDispatcher: to.Ptr(true),
	// 	LastConnectTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T15:00:35.754Z"); return t}()),
	// 	LastStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T14:52:59.893Z"); return t}()),
	// 	LastUpdateResult: to.Ptr(armsynapse.IntegrationRuntimeUpdateResultNone),
	// 	MachineName: to.Ptr("YANZHANG-DT"),
	// 	MaxConcurrentJobs: to.Ptr[int32](56),
	// 	NodeName: to.Ptr("Node_1"),
	// 	RegisterTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T14:51:44.923Z"); return t}()),
	// 	Status: to.Ptr(armsynapse.SelfHostedIntegrationRuntimeNodeStatusOnline),
	// 	Version: to.Ptr("3.8.6730.2"),
	// 	VersionStatus: to.Ptr("UpToDate"),
	// }
}

Output:

type IntegrationRuntimeNodesClientDeleteOptions added in v0.2.0 

type IntegrationRuntimeNodesClientDeleteOptions struct {
}

IntegrationRuntimeNodesClientDeleteOptions contains the optional parameters for the IntegrationRuntimeNodesClient.Delete method.

type IntegrationRuntimeNodesClientDeleteResponse added in v0.2.0 

type IntegrationRuntimeNodesClientDeleteResponse struct {
}

IntegrationRuntimeNodesClientDeleteResponse contains the response from method IntegrationRuntimeNodesClient.Delete.

type IntegrationRuntimeNodesClientGetOptions added in v0.2.0 

type IntegrationRuntimeNodesClientGetOptions struct {
}

IntegrationRuntimeNodesClientGetOptions contains the optional parameters for the IntegrationRuntimeNodesClient.Get method.

type IntegrationRuntimeNodesClientGetResponse added in v0.2.0 

type IntegrationRuntimeNodesClientGetResponse struct {
	// Properties of Self-hosted integration runtime node.
	SelfHostedIntegrationRuntimeNode
}

IntegrationRuntimeNodesClientGetResponse contains the response from method IntegrationRuntimeNodesClient.Get.

type IntegrationRuntimeNodesClientUpdateOptions added in v0.2.0 

type IntegrationRuntimeNodesClientUpdateOptions struct {
}

IntegrationRuntimeNodesClientUpdateOptions contains the optional parameters for the IntegrationRuntimeNodesClient.Update method.

type IntegrationRuntimeNodesClientUpdateResponse added in v0.2.0 

type IntegrationRuntimeNodesClientUpdateResponse struct {
	// Properties of Self-hosted integration runtime node.
	SelfHostedIntegrationRuntimeNode
}

IntegrationRuntimeNodesClientUpdateResponse contains the response from method IntegrationRuntimeNodesClient.Update.

type IntegrationRuntimeObjectMetadataClient 

type IntegrationRuntimeObjectMetadataClient struct {
	// contains filtered or unexported fields
}

IntegrationRuntimeObjectMetadataClient contains the methods for the IntegrationRuntimeObjectMetadata group. Don't use this type directly, use NewIntegrationRuntimeObjectMetadataClient() instead.

func NewIntegrationRuntimeObjectMetadataClient 

func NewIntegrationRuntimeObjectMetadataClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*IntegrationRuntimeObjectMetadataClient, error)

NewIntegrationRuntimeObjectMetadataClient creates a new instance of IntegrationRuntimeObjectMetadataClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*IntegrationRuntimeObjectMetadataClient) BeginRefresh 

func (client *IntegrationRuntimeObjectMetadataClient) BeginRefresh(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimeObjectMetadataClientBeginRefreshOptions) (*runtime.Poller[IntegrationRuntimeObjectMetadataClientRefreshResponse], error)

BeginRefresh - Refresh the object metadata in an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimeObjectMetadataClientBeginRefreshOptions contains the optional parameters for the IntegrationRuntimeObjectMetadataClient.BeginRefresh method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimeObjectMetadata_Refresh.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIntegrationRuntimeObjectMetadataClient().BeginRefresh(ctx, "exampleResourceGroup", "exampleWorkspace", "testactivityv2", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SsisObjectMetadataStatusResponse = armsynapse.SsisObjectMetadataStatusResponse{
	// 	Name: to.Ptr("ca63c855b72d44959653ffcc6eb0b96c"),
	// 	Status: to.Ptr("Succeeded"),
	// }
}

Output:

func (*IntegrationRuntimeObjectMetadataClient) List 

func (client *IntegrationRuntimeObjectMetadataClient) List(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimeObjectMetadataClientListOptions) (IntegrationRuntimeObjectMetadataClientListResponse, error)

List - Get object metadata from an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimeObjectMetadataClientListOptions contains the optional parameters for the IntegrationRuntimeObjectMetadataClient.List method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimeObjectMetadata_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimeObjectMetadataClient().List(ctx, "exampleResourceGroup", "exampleWorkspace", "testactivityv2", &armsynapse.IntegrationRuntimeObjectMetadataClientListOptions{GetMetadataRequest: &armsynapse.GetSsisObjectMetadataRequest{
		MetadataPath: to.Ptr("ssisFolders"),
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SsisObjectMetadataListResponse = armsynapse.SsisObjectMetadataListResponse{
	// 	Value: []armsynapse.SsisObjectMetadataClassification{
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("TestFolder"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			Description: to.Ptr(""),
	// 			ID: to.Ptr[int64](1),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("EnvironmentFolder"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			Description: to.Ptr(""),
	// 			ID: to.Ptr[int64](2),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("ActivityTest"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			Description: to.Ptr(""),
	// 			ID: to.Ptr[int64](3),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("这是文件夹"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			Description: to.Ptr(""),
	// 			ID: to.Ptr[int64](4),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("1"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](5),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("2"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](6),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("3"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](7),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("4"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](8),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("5"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](9),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("6"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](10),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("7"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](11),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("8"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](12),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("9"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](13),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("10"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](14),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("11"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](15),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("12"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](16),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("13"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](17),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("14"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](18),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("15"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](19),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("16"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](20),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("17"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](21),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("18"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](22),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("19"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](23),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("20"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](24),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("21"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](25),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("22"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](26),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("23"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](27),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("24"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](28),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("25"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](29),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("26"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](30),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("27"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](31),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("28"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](32),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("29"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](33),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("30"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](34),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("31"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](35),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("32"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](36),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("33"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](37),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("34"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](38),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("35"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](39),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("36"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](40),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("37"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](41),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("38"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](42),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("39"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](43),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("40"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](44),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("41"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](45),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("42"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](46),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("43"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](47),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("44"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](48),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("45"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](49),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("46"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](50),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("47"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](51),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("48"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](52),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("49"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](53),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("50"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](54),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("51"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](55),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("52"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](56),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("53"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](57),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("54"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](58),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("55"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](59),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("56"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](60),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("57"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](61),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("58"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](62),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("59"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](63),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("60"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](64),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("61"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](65),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("62"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](66),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("63"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](67),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("64"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](68),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("65"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](69),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("66"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](70),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("67"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](71),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("68"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](72),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("69"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](73),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("70"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](74),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("71"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](75),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("72"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](76),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("73"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](77),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("74"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](78),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("75"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](79),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("76"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](80),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("77"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](81),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("78"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](82),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("79"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](83),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("80"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](84),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("81"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](85),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("82"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](86),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("83"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](87),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("84"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](88),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("85"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](89),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("86"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](90),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("87"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](91),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("88"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](92),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("89"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](93),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("90"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](94),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("91"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](95),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("92"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](96),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("93"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](97),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("94"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](98),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("95"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](99),
	// 		},
	// 		&armsynapse.SsisFolder{
	// 			Name: to.Ptr("96"),
	// 			Type: to.Ptr(armsynapse.SsisObjectMetadataTypeFolder),
	// 			ID: to.Ptr[int64](100),
	// 	}},
	// }
}

Output:

type IntegrationRuntimeObjectMetadataClientBeginRefreshOptions added in v0.2.0 

type IntegrationRuntimeObjectMetadataClientBeginRefreshOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IntegrationRuntimeObjectMetadataClientBeginRefreshOptions contains the optional parameters for the IntegrationRuntimeObjectMetadataClient.BeginRefresh method.

type IntegrationRuntimeObjectMetadataClientListOptions added in v0.2.0 

type IntegrationRuntimeObjectMetadataClientListOptions struct {
	// The parameters for getting a SSIS object metadata.
	GetMetadataRequest *GetSsisObjectMetadataRequest
}

IntegrationRuntimeObjectMetadataClientListOptions contains the optional parameters for the IntegrationRuntimeObjectMetadataClient.List method.

type IntegrationRuntimeObjectMetadataClientListResponse added in v0.2.0 

type IntegrationRuntimeObjectMetadataClientListResponse struct {
	// A list of SSIS object metadata.
	SsisObjectMetadataListResponse
}

IntegrationRuntimeObjectMetadataClientListResponse contains the response from method IntegrationRuntimeObjectMetadataClient.List.

type IntegrationRuntimeObjectMetadataClientRefreshResponse added in v0.2.0 

type IntegrationRuntimeObjectMetadataClientRefreshResponse struct {
	// The status of the operation.
	SsisObjectMetadataStatusResponse
}

IntegrationRuntimeObjectMetadataClientRefreshResponse contains the response from method IntegrationRuntimeObjectMetadataClient.BeginRefresh.

type IntegrationRuntimeOperationStatus added in v0.6.0 

type IntegrationRuntimeOperationStatus struct {
	// The operation error message.
	Error *string

	// The operation name.
	Name *string

	// The operation properties.
	Properties any

	// status of Start Integrationruntimes.
	Status *WorkspaceStatus
}

IntegrationRuntimeOperationStatus - Integration Runtime Operation Status Properties

func (IntegrationRuntimeOperationStatus) MarshalJSON added in v0.6.0 

func (i IntegrationRuntimeOperationStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeOperationStatus.

func (*IntegrationRuntimeOperationStatus) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeOperationStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeOperationStatus.

type IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint 

type IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint struct {
	// The category of outbound network dependency.
	Category *string

	// The endpoints for outbound network dependency.
	Endpoints []*IntegrationRuntimeOutboundNetworkDependenciesEndpoint
}

IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint - Azure-SSIS integration runtime outbound network dependency endpoints for one category.

func (IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint) MarshalJSON 

func (i IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint.

func (*IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint.

type IntegrationRuntimeOutboundNetworkDependenciesEndpoint 

type IntegrationRuntimeOutboundNetworkDependenciesEndpoint struct {
	// The domain name of endpoint.
	DomainName *string

	// The details of endpoint.
	EndpointDetails []*IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails
}

IntegrationRuntimeOutboundNetworkDependenciesEndpoint - The endpoint for Azure-SSIS integration runtime outbound network dependency.

func (IntegrationRuntimeOutboundNetworkDependenciesEndpoint) MarshalJSON 

func (i IntegrationRuntimeOutboundNetworkDependenciesEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeOutboundNetworkDependenciesEndpoint.

func (*IntegrationRuntimeOutboundNetworkDependenciesEndpoint) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeOutboundNetworkDependenciesEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeOutboundNetworkDependenciesEndpoint.

type IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails 

type IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails struct {
	// The port of endpoint.
	Port *int32
}

IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails - The details of Azure-SSIS integration runtime outbound network dependency endpoint.

func (IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails) MarshalJSON added in v0.6.0 

func (i IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails.

func (*IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails.

type IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse 

type IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse struct {
	// The list of outbound network dependency endpoints.
	Value []*IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint
}

IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse - Azure-SSIS integration runtime outbound network dependency endpoints.

func (IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse) MarshalJSON 

func (i IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse.

func (*IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse.

type IntegrationRuntimeRegenerateKeyParameters 

type IntegrationRuntimeRegenerateKeyParameters struct {
	// The name of the authentication key to regenerate.
	KeyName *IntegrationRuntimeAuthKeyName
}

IntegrationRuntimeRegenerateKeyParameters - Parameters to regenerate the authentication key.

func (IntegrationRuntimeRegenerateKeyParameters) MarshalJSON added in v0.6.0 

func (i IntegrationRuntimeRegenerateKeyParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeRegenerateKeyParameters.

func (*IntegrationRuntimeRegenerateKeyParameters) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeRegenerateKeyParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeRegenerateKeyParameters.

type IntegrationRuntimeResource 

type IntegrationRuntimeResource struct {
	// REQUIRED; Integration runtime properties.
	Properties IntegrationRuntimeClassification

	// READ-ONLY; Resource Etag.
	Etag *string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

IntegrationRuntimeResource - Integration runtime resource type.

func (IntegrationRuntimeResource) MarshalJSON 

func (i IntegrationRuntimeResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeResource.

func (*IntegrationRuntimeResource) UnmarshalJSON 

func (i *IntegrationRuntimeResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeResource.

type IntegrationRuntimeSsisCatalogInfo 

type IntegrationRuntimeSsisCatalogInfo struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// The password of the administrator user account of the catalog database.
	CatalogAdminPassword *SecureString

	// The administrator user name of catalog database.
	CatalogAdminUserName *string

	// The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/
	CatalogPricingTier *IntegrationRuntimeSsisCatalogPricingTier

	// The catalog database server URL.
	CatalogServerEndpoint *string
}

IntegrationRuntimeSsisCatalogInfo - Catalog information for managed dedicated integration runtime.

func (IntegrationRuntimeSsisCatalogInfo) MarshalJSON 

func (i IntegrationRuntimeSsisCatalogInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeSsisCatalogInfo.

func (*IntegrationRuntimeSsisCatalogInfo) UnmarshalJSON 

func (i *IntegrationRuntimeSsisCatalogInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeSsisCatalogInfo.

type IntegrationRuntimeSsisCatalogPricingTier 

type IntegrationRuntimeSsisCatalogPricingTier string

IntegrationRuntimeSsisCatalogPricingTier - The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/ 

const (
	IntegrationRuntimeSsisCatalogPricingTierBasic     IntegrationRuntimeSsisCatalogPricingTier = "Basic"
	IntegrationRuntimeSsisCatalogPricingTierPremium   IntegrationRuntimeSsisCatalogPricingTier = "Premium"
	IntegrationRuntimeSsisCatalogPricingTierPremiumRS IntegrationRuntimeSsisCatalogPricingTier = "PremiumRS"
	IntegrationRuntimeSsisCatalogPricingTierStandard  IntegrationRuntimeSsisCatalogPricingTier = "Standard"
)

func PossibleIntegrationRuntimeSsisCatalogPricingTierValues 

func PossibleIntegrationRuntimeSsisCatalogPricingTierValues() []IntegrationRuntimeSsisCatalogPricingTier

PossibleIntegrationRuntimeSsisCatalogPricingTierValues returns the possible values for the IntegrationRuntimeSsisCatalogPricingTier const type.

type IntegrationRuntimeSsisProperties 

type IntegrationRuntimeSsisProperties struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// Catalog information for managed dedicated integration runtime.
	CatalogInfo *IntegrationRuntimeSsisCatalogInfo

	// Custom setup script properties for a managed dedicated integration runtime.
	CustomSetupScriptProperties *IntegrationRuntimeCustomSetupScriptProperties

	// Data proxy properties for a managed dedicated integration runtime.
	DataProxyProperties *IntegrationRuntimeDataProxyProperties

	// The edition for the SSIS Integration Runtime
	Edition *IntegrationRuntimeEdition

	// Custom setup without script properties for a SSIS integration runtime.
	ExpressCustomSetupProperties []CustomSetupBaseClassification

	// License type for bringing your own license scenario.
	LicenseType *IntegrationRuntimeLicenseType
}

IntegrationRuntimeSsisProperties - SSIS properties for managed integration runtime.

func (IntegrationRuntimeSsisProperties) MarshalJSON 

func (i IntegrationRuntimeSsisProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeSsisProperties.

func (*IntegrationRuntimeSsisProperties) UnmarshalJSON 

func (i *IntegrationRuntimeSsisProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeSsisProperties.

type IntegrationRuntimeState 

type IntegrationRuntimeState string

IntegrationRuntimeState - The state of integration runtime. 

const (
	IntegrationRuntimeStateAccessDenied     IntegrationRuntimeState = "AccessDenied"
	IntegrationRuntimeStateInitial          IntegrationRuntimeState = "Initial"
	IntegrationRuntimeStateLimited          IntegrationRuntimeState = "Limited"
	IntegrationRuntimeStateNeedRegistration IntegrationRuntimeState = "NeedRegistration"
	IntegrationRuntimeStateOffline          IntegrationRuntimeState = "Offline"
	IntegrationRuntimeStateOnline           IntegrationRuntimeState = "Online"
	IntegrationRuntimeStateStarted          IntegrationRuntimeState = "Started"
	IntegrationRuntimeStateStarting         IntegrationRuntimeState = "Starting"
	IntegrationRuntimeStateStopped          IntegrationRuntimeState = "Stopped"
	IntegrationRuntimeStateStopping         IntegrationRuntimeState = "Stopping"
)

func PossibleIntegrationRuntimeStateValues 

func PossibleIntegrationRuntimeStateValues() []IntegrationRuntimeState

PossibleIntegrationRuntimeStateValues returns the possible values for the IntegrationRuntimeState const type.

type IntegrationRuntimeStatus 

type IntegrationRuntimeStatus struct {
	// REQUIRED; Type of integration runtime.
	Type *IntegrationRuntimeType

	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// READ-ONLY; The workspace name which the integration runtime belong to.
	DataFactoryName *string

	// READ-ONLY; The state of integration runtime.
	State *IntegrationRuntimeState
}

IntegrationRuntimeStatus - Integration runtime status.

func (*IntegrationRuntimeStatus) GetIntegrationRuntimeStatus 

func (i *IntegrationRuntimeStatus) GetIntegrationRuntimeStatus() *IntegrationRuntimeStatus

GetIntegrationRuntimeStatus implements the IntegrationRuntimeStatusClassification interface for type IntegrationRuntimeStatus.

func (IntegrationRuntimeStatus) MarshalJSON added in v0.2.0 

func (i IntegrationRuntimeStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeStatus.

func (*IntegrationRuntimeStatus) UnmarshalJSON 

func (i *IntegrationRuntimeStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeStatus.

type IntegrationRuntimeStatusClassification 

type IntegrationRuntimeStatusClassification interface {
	// GetIntegrationRuntimeStatus returns the IntegrationRuntimeStatus content of the underlying type.
	GetIntegrationRuntimeStatus() *IntegrationRuntimeStatus
}

IntegrationRuntimeStatusClassification provides polymorphic access to related types. Call the interface's GetIntegrationRuntimeStatus() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *IntegrationRuntimeStatus, *ManagedIntegrationRuntimeStatus, *SelfHostedIntegrationRuntimeStatus

type IntegrationRuntimeStatusClient 

type IntegrationRuntimeStatusClient struct {
	// contains filtered or unexported fields
}

IntegrationRuntimeStatusClient contains the methods for the IntegrationRuntimeStatus group. Don't use this type directly, use NewIntegrationRuntimeStatusClient() instead.

func NewIntegrationRuntimeStatusClient 

func NewIntegrationRuntimeStatusClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*IntegrationRuntimeStatusClient, error)

NewIntegrationRuntimeStatusClient creates a new instance of IntegrationRuntimeStatusClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*IntegrationRuntimeStatusClient) Get 

func (client *IntegrationRuntimeStatusClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimeStatusClientGetOptions) (IntegrationRuntimeStatusClientGetResponse, error)

Get - Get the integration runtime status If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimeStatusClientGetOptions contains the optional parameters for the IntegrationRuntimeStatusClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_GetStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimeStatusClient().Get(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeStatusResponse = armsynapse.IntegrationRuntimeStatusResponse{
	// 	Name: to.Ptr("exampleIntegrationRuntime"),
	// 	Properties: &armsynapse.SelfHostedIntegrationRuntimeStatus{
	// 		Type: to.Ptr(armsynapse.IntegrationRuntimeTypeSelfHosted),
	// 		State: to.Ptr(armsynapse.IntegrationRuntimeStateOnline),
	// 		TypeProperties: &armsynapse.SelfHostedIntegrationRuntimeStatusTypeProperties{
	// 			AutoUpdate: to.Ptr(armsynapse.IntegrationRuntimeAutoUpdateOff),
	// 			Capabilities: map[string]*string{
	// 				"connectedToResourceManager": to.Ptr("True"),
	// 				"credentialInSync": to.Ptr("True"),
	// 				"httpsPortEnabled": to.Ptr("True"),
	// 				"nodeEnabled": to.Ptr("True"),
	// 				"serviceBusConnected": to.Ptr("True"),
	// 			},
	// 			CreateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T09:17:45.183Z"); return t}()),
	// 			LatestVersion: to.Ptr("3.7.6711.1"),
	// 			LocalTimeZoneOffset: to.Ptr("PT8H"),
	// 			Nodes: []*armsynapse.SelfHostedIntegrationRuntimeNode{
	// 				{
	// 					Capabilities: map[string]*string{
	// 						"connectedToResourceManager": to.Ptr("True"),
	// 						"credentialInSync": to.Ptr("True"),
	// 						"httpsPortEnabled": to.Ptr("True"),
	// 						"nodeEnabled": to.Ptr("True"),
	// 						"serviceBusConnected": to.Ptr("True"),
	// 					},
	// 					HostServiceURI: to.Ptr("https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/"),
	// 					IsActiveDispatcher: to.Ptr(true),
	// 					LastConnectTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T14:52:59.893Z"); return t}()),
	// 					LastStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T14:52:59.893Z"); return t}()),
	// 					LastUpdateResult: to.Ptr(armsynapse.IntegrationRuntimeUpdateResultNone),
	// 					MachineName: to.Ptr("YANZHANG-DT"),
	// 					MaxConcurrentJobs: to.Ptr[int32](56),
	// 					NodeName: to.Ptr("Node_1"),
	// 					RegisterTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T14:51:44.923Z"); return t}()),
	// 					Status: to.Ptr(armsynapse.SelfHostedIntegrationRuntimeNodeStatusOnline),
	// 					Version: to.Ptr("3.8.6730.2"),
	// 					VersionStatus: to.Ptr("UpToDate"),
	// 			}},
	// 			ServiceUrls: []*string{
	// 				to.Ptr("wu.frontend.int.clouddatahub-int.net"),
	// 				to.Ptr("*.servicebus.windows.net")},
	// 				TaskQueueID: to.Ptr("1a6296ab-423c-4346-9bcc-85a78c2c0582"),
	// 				UpdateDelayOffset: to.Ptr("PT3H"),
	// 				Version: to.Ptr("3.8.6730.2"),
	// 				VersionStatus: to.Ptr("UpToDate"),
	// 			},
	// 		},
	// 	}
}

Output:

type IntegrationRuntimeStatusClientGetOptions added in v0.2.0 

type IntegrationRuntimeStatusClientGetOptions struct {
}

IntegrationRuntimeStatusClientGetOptions contains the optional parameters for the IntegrationRuntimeStatusClient.Get method.

type IntegrationRuntimeStatusClientGetResponse added in v0.2.0 

type IntegrationRuntimeStatusClientGetResponse struct {
	// Integration runtime status response.
	IntegrationRuntimeStatusResponse
}

IntegrationRuntimeStatusClientGetResponse contains the response from method IntegrationRuntimeStatusClient.Get.

type IntegrationRuntimeStatusResponse 

type IntegrationRuntimeStatusResponse struct {
	// REQUIRED; Integration runtime properties.
	Properties IntegrationRuntimeStatusClassification

	// READ-ONLY; The integration runtime name.
	Name *string
}

IntegrationRuntimeStatusResponse - Integration runtime status response.

func (IntegrationRuntimeStatusResponse) MarshalJSON 

func (i IntegrationRuntimeStatusResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeStatusResponse.

func (*IntegrationRuntimeStatusResponse) UnmarshalJSON 

func (i *IntegrationRuntimeStatusResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeStatusResponse.

type IntegrationRuntimeStopOperationStatus added in v0.6.0 

type IntegrationRuntimeStopOperationStatus struct {
	// The operation error message.
	Error *string

	// The operation name.
	Name *string

	// The operation properties.
	Properties any

	// status of Start Integrationruntimes.
	Status *WorkspaceStatus
}

IntegrationRuntimeStopOperationStatus - Integration Runtime Operation Status Properties

func (IntegrationRuntimeStopOperationStatus) MarshalJSON added in v0.6.0 

func (i IntegrationRuntimeStopOperationStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeStopOperationStatus.

func (*IntegrationRuntimeStopOperationStatus) UnmarshalJSON added in v0.6.0 

func (i *IntegrationRuntimeStopOperationStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeStopOperationStatus.

type IntegrationRuntimeType 

type IntegrationRuntimeType string

IntegrationRuntimeType - The type of integration runtime. 

const (
	IntegrationRuntimeTypeManaged    IntegrationRuntimeType = "Managed"
	IntegrationRuntimeTypeSelfHosted IntegrationRuntimeType = "SelfHosted"
)

func PossibleIntegrationRuntimeTypeValues 

func PossibleIntegrationRuntimeTypeValues() []IntegrationRuntimeType

PossibleIntegrationRuntimeTypeValues returns the possible values for the IntegrationRuntimeType const type.

type IntegrationRuntimeUpdateResult 

type IntegrationRuntimeUpdateResult string

IntegrationRuntimeUpdateResult - The result of the last integration runtime node update. 

const (
	IntegrationRuntimeUpdateResultFail    IntegrationRuntimeUpdateResult = "Fail"
	IntegrationRuntimeUpdateResultNone    IntegrationRuntimeUpdateResult = "None"
	IntegrationRuntimeUpdateResultSucceed IntegrationRuntimeUpdateResult = "Succeed"
)

func PossibleIntegrationRuntimeUpdateResultValues 

func PossibleIntegrationRuntimeUpdateResultValues() []IntegrationRuntimeUpdateResult

PossibleIntegrationRuntimeUpdateResultValues returns the possible values for the IntegrationRuntimeUpdateResult const type.

type IntegrationRuntimeVNetProperties 

type IntegrationRuntimeVNetProperties struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// Resource IDs of the public IP addresses that this integration runtime will use.
	PublicIPs []*string

	// The name of the subnet this integration runtime will join.
	Subnet *string

	// The ID of subnet, to which this Azure-SSIS integration runtime will be joined.
	SubnetID *string

	// The ID of the VNet that this integration runtime will join.
	VNetID *string
}

IntegrationRuntimeVNetProperties - VNet properties for managed integration runtime.

func (IntegrationRuntimeVNetProperties) MarshalJSON 

func (i IntegrationRuntimeVNetProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntegrationRuntimeVNetProperties.

func (*IntegrationRuntimeVNetProperties) UnmarshalJSON 

func (i *IntegrationRuntimeVNetProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntegrationRuntimeVNetProperties.

type IntegrationRuntimesClient 

type IntegrationRuntimesClient struct {
	// contains filtered or unexported fields
}

IntegrationRuntimesClient contains the methods for the IntegrationRuntimes group. Don't use this type directly, use NewIntegrationRuntimesClient() instead.

func NewIntegrationRuntimesClient 

func NewIntegrationRuntimesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*IntegrationRuntimesClient, error)

NewIntegrationRuntimesClient creates a new instance of IntegrationRuntimesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*IntegrationRuntimesClient) BeginCreate 

func (client *IntegrationRuntimesClient) BeginCreate(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, integrationRuntime IntegrationRuntimeResource, options *IntegrationRuntimesClientBeginCreateOptions) (*runtime.Poller[IntegrationRuntimesClientCreateResponse], error)

BeginCreate - Create an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • integrationRuntime - Integration runtime resource definition.
  • options - IntegrationRuntimesClientBeginCreateOptions contains the optional parameters for the IntegrationRuntimesClient.BeginCreate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIntegrationRuntimesClient().BeginCreate(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", armsynapse.IntegrationRuntimeResource{
		Properties: &armsynapse.SelfHostedIntegrationRuntime{
			Type:        to.Ptr(armsynapse.IntegrationRuntimeTypeSelfHosted),
			Description: to.Ptr("A selfhosted integration runtime"),
		},
	}, &armsynapse.IntegrationRuntimesClientBeginCreateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeResource = armsynapse.IntegrationRuntimeResource{
	// 	Name: to.Ptr("exampleIntegrationRuntime"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/integrationruntimes"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime"),
	// 	Etag: to.Ptr("000046c4-0000-0000-0000-5b2198bf0000"),
	// 	Properties: &armsynapse.SelfHostedIntegrationRuntime{
	// 		Type: to.Ptr(armsynapse.IntegrationRuntimeTypeSelfHosted),
	// 		Description: to.Ptr("A selfhosted integration runtime"),
	// 	},
	// }
}

Output:

func (*IntegrationRuntimesClient) BeginDelete 

func (client *IntegrationRuntimesClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimesClientBeginDeleteOptions) (*runtime.Poller[IntegrationRuntimesClientDeleteResponse], error)

BeginDelete - Delete an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimesClientBeginDeleteOptions contains the optional parameters for the IntegrationRuntimesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIntegrationRuntimesClient().BeginDelete(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*IntegrationRuntimesClient) BeginDisableInteractiveQuery 

func (client *IntegrationRuntimesClient) BeginDisableInteractiveQuery(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimesClientBeginDisableInteractiveQueryOptions) (*runtime.Poller[IntegrationRuntimesClientDisableInteractiveQueryResponse], error)

BeginDisableInteractiveQuery - Disable interactive query in integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimesClientBeginDisableInteractiveQueryOptions contains the optional parameters for the IntegrationRuntimesClient.BeginDisableInteractiveQuery method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_DisableInteractiveQuery.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIntegrationRuntimesClient().BeginDisableInteractiveQuery(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleManagedIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*IntegrationRuntimesClient) BeginEnableInteractiveQuery 

func (client *IntegrationRuntimesClient) BeginEnableInteractiveQuery(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimesClientBeginEnableInteractiveQueryOptions) (*runtime.Poller[IntegrationRuntimesClientEnableInteractiveQueryResponse], error)

BeginEnableInteractiveQuery - Enable interactive query in integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimesClientBeginEnableInteractiveQueryOptions contains the optional parameters for the IntegrationRuntimesClient.BeginEnableInteractiveQuery method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_EnableInteractiveQuery.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIntegrationRuntimesClient().BeginEnableInteractiveQuery(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleManagedIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*IntegrationRuntimesClient) BeginStart 

func (client *IntegrationRuntimesClient) BeginStart(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimesClientBeginStartOptions) (*runtime.Poller[IntegrationRuntimesClientStartResponse], error)

BeginStart - Start an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimesClientBeginStartOptions contains the optional parameters for the IntegrationRuntimesClient.BeginStart method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Start.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIntegrationRuntimesClient().BeginStart(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleManagedIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeStatusResponse = armsynapse.IntegrationRuntimeStatusResponse{
	// 	Name: to.Ptr("exampleManagedIntegrationRuntime"),
	// 	Properties: &armsynapse.ManagedIntegrationRuntimeStatus{
	// 		Type: to.Ptr(armsynapse.IntegrationRuntimeTypeManaged),
	// 		DataFactoryName: to.Ptr("exampleWorkspaceName"),
	// 		State: to.Ptr(armsynapse.IntegrationRuntimeStateStarted),
	// 		TypeProperties: &armsynapse.ManagedIntegrationRuntimeStatusTypeProperties{
	// 			CreateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-13T21:11:01.869Z"); return t}()),
	// 			Nodes: []*armsynapse.ManagedIntegrationRuntimeNode{
	// 			},
	// 			OtherErrors: []*armsynapse.ManagedIntegrationRuntimeError{
	// 			},
	// 		},
	// 	},
	// }
}

Output:

func (*IntegrationRuntimesClient) BeginStop 

func (client *IntegrationRuntimesClient) BeginStop(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimesClientBeginStopOptions) (*runtime.Poller[IntegrationRuntimesClientStopResponse], error)

BeginStop - Stop an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimesClientBeginStopOptions contains the optional parameters for the IntegrationRuntimesClient.BeginStop method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Stop.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIntegrationRuntimesClient().BeginStop(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleManagedIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*IntegrationRuntimesClient) Get 

func (client *IntegrationRuntimesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimesClientGetOptions) (IntegrationRuntimesClientGetResponse, error)

Get - Get an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimesClientGetOptions contains the optional parameters for the IntegrationRuntimesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimesClient().Get(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", &armsynapse.IntegrationRuntimesClientGetOptions{IfNoneMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeResource = armsynapse.IntegrationRuntimeResource{
	// 	Name: to.Ptr("exampleIntegrationRuntime"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/integrationruntimes"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime"),
	// 	Etag: to.Ptr("15003c4f-0000-0200-0000-5cbe090b0000"),
	// 	Properties: &armsynapse.SelfHostedIntegrationRuntime{
	// 		Type: to.Ptr(armsynapse.IntegrationRuntimeTypeSelfHosted),
	// 		Description: to.Ptr("A selfhosted integration runtime"),
	// 	},
	// }
}

Output:

func (*IntegrationRuntimesClient) ListOutboundNetworkDependenciesEndpoints 

func (client *IntegrationRuntimesClient) ListOutboundNetworkDependenciesEndpoints(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimesClientListOutboundNetworkDependenciesEndpointsOptions) (IntegrationRuntimesClientListOutboundNetworkDependenciesEndpointsResponse, error)

ListOutboundNetworkDependenciesEndpoints - Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimesClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the IntegrationRuntimesClient.ListOutboundNetworkDependenciesEndpoints method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimesClient().ListOutboundNetworkDependenciesEndpoints(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse = armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse{
	// 	Value: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint{
	// 		{
	// 			Category: to.Ptr("Azure Data Factory (Management)"),
	// 			Endpoints: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("wu.frontend.int.clouddatahub-int.net"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 			}},
	// 		},
	// 		{
	// 			Category: to.Ptr("Azure Storage (Management)"),
	// 			Endpoints: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("*.blob.core.windows.net"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 				},
	// 				{
	// 					DomainName: to.Ptr("*.table.core.windows.net"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 			}},
	// 		},
	// 		{
	// 			Category: to.Ptr("Event Hub (Logging)"),
	// 			Endpoints: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("*.servicebus.windows.net"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 			}},
	// 		},
	// 		{
	// 			Category: to.Ptr("Microsoft Logging service (Internal Use)"),
	// 			Endpoints: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("gcs.prod.monitoring.core.windows.net"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 				},
	// 				{
	// 					DomainName: to.Ptr("prod.warmpath.msftcloudes.com"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 				},
	// 				{
	// 					DomainName: to.Ptr("azurewatsonanalysis-prod.core.windows.net"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 			}},
	// 	}},
	// }
}

Output:

func (*IntegrationRuntimesClient) NewListByWorkspacePager added in v0.4.0 

func (client *IntegrationRuntimesClient) NewListByWorkspacePager(resourceGroupName string, workspaceName string, options *IntegrationRuntimesClientListByWorkspaceOptions) *runtime.Pager[IntegrationRuntimesClientListByWorkspaceResponse]

NewListByWorkspacePager - List all integration runtimes

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - IntegrationRuntimesClientListByWorkspaceOptions contains the optional parameters for the IntegrationRuntimesClient.NewListByWorkspacePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_ListByWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewIntegrationRuntimesClient().NewListByWorkspacePager("exampleResourceGroup", "exampleWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.IntegrationRuntimeListResponse = armsynapse.IntegrationRuntimeListResponse{
		// 	Value: []*armsynapse.IntegrationRuntimeResource{
		// 		{
		// 			Name: to.Ptr("exampleIntegrationRuntime"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/integrationruntimes"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime"),
		// 			Etag: to.Ptr("0400f1a1-0000-0000-0000-5b2188640000"),
		// 			Properties: &armsynapse.SelfHostedIntegrationRuntime{
		// 				Type: to.Ptr(armsynapse.IntegrationRuntimeTypeSelfHosted),
		// 				Description: to.Ptr("A selfhosted integration runtime"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*IntegrationRuntimesClient) Update 

func (client *IntegrationRuntimesClient) Update(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, updateIntegrationRuntimeRequest UpdateIntegrationRuntimeRequest, options *IntegrationRuntimesClientUpdateOptions) (IntegrationRuntimesClientUpdateResponse, error)

Update - Update an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • updateIntegrationRuntimeRequest - The parameters for updating an integration runtime.
  • options - IntegrationRuntimesClientUpdateOptions contains the optional parameters for the IntegrationRuntimesClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Update.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimesClient().Update(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", armsynapse.UpdateIntegrationRuntimeRequest{
		AutoUpdate:        to.Ptr(armsynapse.IntegrationRuntimeAutoUpdateOff),
		UpdateDelayOffset: to.Ptr("\"PT3H\""),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeResource = armsynapse.IntegrationRuntimeResource{
	// 	Name: to.Ptr("exampleIntegrationRuntime"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/integrationruntimes"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime"),
	// 	Etag: to.Ptr("0400f1a1-0000-0000-0000-5b2188640000"),
	// 	Properties: &armsynapse.SelfHostedIntegrationRuntime{
	// 		Type: to.Ptr(armsynapse.IntegrationRuntimeTypeSelfHosted),
	// 		Description: to.Ptr("A selfhosted integration runtime"),
	// 	},
	// }
}

Output:

func (*IntegrationRuntimesClient) Upgrade 

func (client *IntegrationRuntimesClient) Upgrade(ctx context.Context, resourceGroupName string, workspaceName string, integrationRuntimeName string, options *IntegrationRuntimesClientUpgradeOptions) (IntegrationRuntimesClientUpgradeResponse, error)

Upgrade - Upgrade an integration runtime If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • integrationRuntimeName - Integration runtime name
  • options - IntegrationRuntimesClientUpgradeOptions contains the optional parameters for the IntegrationRuntimesClient.Upgrade method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Upgrade.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewIntegrationRuntimesClient().Upgrade(ctx, "exampleResourceGroup", "exampleWorkspace", "exampleIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type IntegrationRuntimesClientBeginCreateOptions added in v0.2.0 

type IntegrationRuntimesClientBeginCreateOptions struct {
	// ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity
	// or can be * for unconditional update.
	IfMatch *string

	// Resumes the LRO from the provided token.
	ResumeToken string
}

IntegrationRuntimesClientBeginCreateOptions contains the optional parameters for the IntegrationRuntimesClient.BeginCreate method.

type IntegrationRuntimesClientBeginDeleteOptions added in v0.2.0 

type IntegrationRuntimesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IntegrationRuntimesClientBeginDeleteOptions contains the optional parameters for the IntegrationRuntimesClient.BeginDelete method.

type IntegrationRuntimesClientBeginDisableInteractiveQueryOptions added in v0.2.0 

type IntegrationRuntimesClientBeginDisableInteractiveQueryOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IntegrationRuntimesClientBeginDisableInteractiveQueryOptions contains the optional parameters for the IntegrationRuntimesClient.BeginDisableInteractiveQuery method.

type IntegrationRuntimesClientBeginEnableInteractiveQueryOptions added in v0.2.0 

type IntegrationRuntimesClientBeginEnableInteractiveQueryOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IntegrationRuntimesClientBeginEnableInteractiveQueryOptions contains the optional parameters for the IntegrationRuntimesClient.BeginEnableInteractiveQuery method.

type IntegrationRuntimesClientBeginStartOptions added in v0.2.0 

type IntegrationRuntimesClientBeginStartOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IntegrationRuntimesClientBeginStartOptions contains the optional parameters for the IntegrationRuntimesClient.BeginStart method.

type IntegrationRuntimesClientBeginStopOptions added in v0.2.0 

type IntegrationRuntimesClientBeginStopOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IntegrationRuntimesClientBeginStopOptions contains the optional parameters for the IntegrationRuntimesClient.BeginStop method.

type IntegrationRuntimesClientCreateResponse added in v0.2.0 

type IntegrationRuntimesClientCreateResponse struct {
	// Integration runtime resource type.
	IntegrationRuntimeResource
}

IntegrationRuntimesClientCreateResponse contains the response from method IntegrationRuntimesClient.BeginCreate.

type IntegrationRuntimesClientDeleteResponse added in v0.2.0 

type IntegrationRuntimesClientDeleteResponse struct {
}

IntegrationRuntimesClientDeleteResponse contains the response from method IntegrationRuntimesClient.BeginDelete.

type IntegrationRuntimesClientDisableInteractiveQueryResponse added in v0.2.0 

type IntegrationRuntimesClientDisableInteractiveQueryResponse struct {
}

IntegrationRuntimesClientDisableInteractiveQueryResponse contains the response from method IntegrationRuntimesClient.BeginDisableInteractiveQuery.

type IntegrationRuntimesClientEnableInteractiveQueryResponse added in v0.2.0 

type IntegrationRuntimesClientEnableInteractiveQueryResponse struct {
}

IntegrationRuntimesClientEnableInteractiveQueryResponse contains the response from method IntegrationRuntimesClient.BeginEnableInteractiveQuery.

type IntegrationRuntimesClientGetOptions added in v0.2.0 

type IntegrationRuntimesClientGetOptions struct {
	// ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag,
	// or if * was provided, then no content will be returned.
	IfNoneMatch *string
}

IntegrationRuntimesClientGetOptions contains the optional parameters for the IntegrationRuntimesClient.Get method.

type IntegrationRuntimesClientGetResponse added in v0.2.0 

type IntegrationRuntimesClientGetResponse struct {
	// Integration runtime resource type.
	IntegrationRuntimeResource
}

IntegrationRuntimesClientGetResponse contains the response from method IntegrationRuntimesClient.Get.

type IntegrationRuntimesClientListByWorkspaceOptions added in v0.2.0 

type IntegrationRuntimesClientListByWorkspaceOptions struct {
}

IntegrationRuntimesClientListByWorkspaceOptions contains the optional parameters for the IntegrationRuntimesClient.NewListByWorkspacePager method.

type IntegrationRuntimesClientListByWorkspaceResponse added in v0.2.0 

type IntegrationRuntimesClientListByWorkspaceResponse struct {
	// A list of integration runtime resources.
	IntegrationRuntimeListResponse
}

IntegrationRuntimesClientListByWorkspaceResponse contains the response from method IntegrationRuntimesClient.NewListByWorkspacePager.

type IntegrationRuntimesClientListOutboundNetworkDependenciesEndpointsOptions added in v0.2.0 

type IntegrationRuntimesClientListOutboundNetworkDependenciesEndpointsOptions struct {
}

IntegrationRuntimesClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the IntegrationRuntimesClient.ListOutboundNetworkDependenciesEndpoints method.

type IntegrationRuntimesClientListOutboundNetworkDependenciesEndpointsResponse added in v0.2.0 

type IntegrationRuntimesClientListOutboundNetworkDependenciesEndpointsResponse struct {
	// Azure-SSIS integration runtime outbound network dependency endpoints.
	IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse
}

IntegrationRuntimesClientListOutboundNetworkDependenciesEndpointsResponse contains the response from method IntegrationRuntimesClient.ListOutboundNetworkDependenciesEndpoints.

type IntegrationRuntimesClientStartResponse added in v0.2.0 

type IntegrationRuntimesClientStartResponse struct {
	// Integration runtime status response.
	IntegrationRuntimeStatusResponse
}

IntegrationRuntimesClientStartResponse contains the response from method IntegrationRuntimesClient.BeginStart.

type IntegrationRuntimesClientStopResponse added in v0.2.0 

type IntegrationRuntimesClientStopResponse struct {
}

IntegrationRuntimesClientStopResponse contains the response from method IntegrationRuntimesClient.BeginStop.

type IntegrationRuntimesClientUpdateOptions added in v0.2.0 

type IntegrationRuntimesClientUpdateOptions struct {
}

IntegrationRuntimesClientUpdateOptions contains the optional parameters for the IntegrationRuntimesClient.Update method.

type IntegrationRuntimesClientUpdateResponse added in v0.2.0 

type IntegrationRuntimesClientUpdateResponse struct {
	// Integration runtime resource type.
	IntegrationRuntimeResource
}

IntegrationRuntimesClientUpdateResponse contains the response from method IntegrationRuntimesClient.Update.

type IntegrationRuntimesClientUpgradeOptions added in v0.2.0 

type IntegrationRuntimesClientUpgradeOptions struct {
}

IntegrationRuntimesClientUpgradeOptions contains the optional parameters for the IntegrationRuntimesClient.Upgrade method.

type IntegrationRuntimesClientUpgradeResponse added in v0.2.0 

type IntegrationRuntimesClientUpgradeResponse struct {
}

IntegrationRuntimesClientUpgradeResponse contains the response from method IntegrationRuntimesClient.Upgrade.

type IotHubConnectionProperties 

type IotHubConnectionProperties struct {
	// REQUIRED; The iot hub consumer group.
	ConsumerGroup *string

	// REQUIRED; The resource ID of the Iot hub to be used to create a data connection.
	IotHubResourceID *string

	// REQUIRED; The name of the share access policy
	SharedAccessPolicyName *string

	// The data format of the message. Optionally the data format can be added to each message.
	DataFormat *IotHubDataFormat

	// System properties of the iot hub
	EventSystemProperties []*string

	// The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
	MappingRuleName *string

	// The table where the data should be ingested. Optionally the table information can be added to each message.
	TableName *string

	// READ-ONLY; The provisioned state of the resource.
	ProvisioningState *ResourceProvisioningState
}

IotHubConnectionProperties - Class representing the Kusto Iot hub connection properties.

func (IotHubConnectionProperties) MarshalJSON 

func (i IotHubConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IotHubConnectionProperties.

func (*IotHubConnectionProperties) UnmarshalJSON added in v0.6.0 

func (i *IotHubConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IotHubConnectionProperties.

type IotHubDataConnection 

type IotHubDataConnection struct {
	// REQUIRED; Kind of the endpoint for the data connection
	Kind *DataConnectionKind

	// Resource location.
	Location *string

	// The Iot Hub data connection properties.
	Properties *IotHubConnectionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

IotHubDataConnection - Class representing an iot hub data connection.

func (*IotHubDataConnection) GetDataConnection added in v0.2.0 

func (i *IotHubDataConnection) GetDataConnection() *DataConnection

GetDataConnection implements the DataConnectionClassification interface for type IotHubDataConnection.

func (IotHubDataConnection) MarshalJSON 

func (i IotHubDataConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IotHubDataConnection.

func (*IotHubDataConnection) UnmarshalJSON 

func (i *IotHubDataConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IotHubDataConnection.

type IotHubDataFormat 

type IotHubDataFormat string

IotHubDataFormat - The data format of the message. Optionally the data format can be added to each message. 

const (
	IotHubDataFormatAPACHEAVRO IotHubDataFormat = "APACHEAVRO"
	IotHubDataFormatAVRO       IotHubDataFormat = "AVRO"
	IotHubDataFormatCSV        IotHubDataFormat = "CSV"
	IotHubDataFormatJSON       IotHubDataFormat = "JSON"
	IotHubDataFormatMULTIJSON  IotHubDataFormat = "MULTIJSON"
	IotHubDataFormatORC        IotHubDataFormat = "ORC"
	IotHubDataFormatPARQUET    IotHubDataFormat = "PARQUET"
	IotHubDataFormatPSV        IotHubDataFormat = "PSV"
	IotHubDataFormatRAW        IotHubDataFormat = "RAW"
	IotHubDataFormatSCSV       IotHubDataFormat = "SCSV"
	IotHubDataFormatSINGLEJSON IotHubDataFormat = "SINGLEJSON"
	IotHubDataFormatSOHSV      IotHubDataFormat = "SOHSV"
	IotHubDataFormatTSV        IotHubDataFormat = "TSV"
	IotHubDataFormatTSVE       IotHubDataFormat = "TSVE"
	IotHubDataFormatTXT        IotHubDataFormat = "TXT"
	IotHubDataFormatW3CLOGFILE IotHubDataFormat = "W3CLOGFILE"
)

func PossibleIotHubDataFormatValues 

func PossibleIotHubDataFormatValues() []IotHubDataFormat

PossibleIotHubDataFormatValues returns the possible values for the IotHubDataFormat const type.

type KekIdentityProperties 

type KekIdentityProperties struct {
	// Boolean specifying whether to use system assigned identity or not
	UseSystemAssignedIdentity any

	// User assigned identity resource Id
	UserAssignedIdentity *string
}

KekIdentityProperties - Key encryption key properties

func (KekIdentityProperties) MarshalJSON added in v0.6.0 

func (k KekIdentityProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KekIdentityProperties.

func (*KekIdentityProperties) UnmarshalJSON added in v0.6.0 

func (k *KekIdentityProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KekIdentityProperties.

type Key 

type Key struct {
	// Keys resource properties
	Properties *KeyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Key - A workspace key

func (Key) MarshalJSON 

func (k Key) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Key.

func (*Key) UnmarshalJSON 

func (k *Key) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Key.

type KeyInfoListResult 

type KeyInfoListResult struct {
	// Link to the next page of results
	NextLink *string

	// List of keys
	Value []*Key
}

KeyInfoListResult - List of keys

func (KeyInfoListResult) MarshalJSON 

func (k KeyInfoListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyInfoListResult.

func (*KeyInfoListResult) UnmarshalJSON added in v0.6.0 

func (k *KeyInfoListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyInfoListResult.

type KeyProperties 

type KeyProperties struct {
	// Used to activate the workspace after a customer managed key is provided.
	IsActiveCMK *bool

	// The Key Vault Url of the workspace key.
	KeyVaultURL *string
}

KeyProperties - Key properties

func (KeyProperties) MarshalJSON added in v0.6.0 

func (k KeyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyProperties.

func (*KeyProperties) UnmarshalJSON added in v0.6.0 

func (k *KeyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyProperties.

type KeysClient 

type KeysClient struct {
	// contains filtered or unexported fields
}

KeysClient contains the methods for the Keys group. Don't use this type directly, use NewKeysClient() instead.

func NewKeysClient 

func NewKeysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*KeysClient, error)

NewKeysClient creates a new instance of KeysClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*KeysClient) CreateOrUpdate 

func (client *KeysClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, keyName string, keyProperties Key, options *KeysClientCreateOrUpdateOptions) (KeysClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a workspace key If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • keyName - The name of the workspace key
  • keyProperties - Key put request properties
  • options - KeysClientCreateOrUpdateOptions contains the optional parameters for the KeysClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKeysClient().CreateOrUpdate(ctx, "ExampleResourceGroup", "ExampleWorkspace", "somekey", armsynapse.Key{
		Properties: &armsynapse.KeyProperties{
			IsActiveCMK: to.Ptr(true),
			KeyVaultURL: to.Ptr("https://vault.azure.net/keys/somesecret"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Key = armsynapse.Key{
	// 	Name: to.Ptr("somekey"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/keys"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey"),
	// 	Properties: &armsynapse.KeyProperties{
	// 		IsActiveCMK: to.Ptr(true),
	// 		KeyVaultURL: to.Ptr("https://vault.azure.net/keys/somesecret"),
	// 	},
	// }
}

Output:

func (*KeysClient) Delete 

func (client *KeysClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, keyName string, options *KeysClientDeleteOptions) (KeysClientDeleteResponse, error)

Delete - Deletes a workspace key If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • keyName - The name of the workspace key
  • options - KeysClientDeleteOptions contains the optional parameters for the KeysClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKeysClient().Delete(ctx, "ExampleResourceGroup", "ExampleWorkspace", "somekey", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Key = armsynapse.Key{
	// 	Name: to.Ptr("somekey"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/keys"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey"),
	// 	Properties: &armsynapse.KeyProperties{
	// 		IsActiveCMK: to.Ptr(true),
	// 		KeyVaultURL: to.Ptr("https://vault.azure.net/keys/key1"),
	// 	},
	// }
}

Output:

func (*KeysClient) Get 

func (client *KeysClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, keyName string, options *KeysClientGetOptions) (KeysClientGetResponse, error)

Get - Gets a workspace key If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • keyName - The name of the workspace key
  • options - KeysClientGetOptions contains the optional parameters for the KeysClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKeysClient().Get(ctx, "ExampleResourceGroup", "ExampleWorkspace", "somekey", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Key = armsynapse.Key{
	// 	Name: to.Ptr("somekey"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/keys"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey"),
	// 	Properties: &armsynapse.KeyProperties{
	// 		IsActiveCMK: to.Ptr(true),
	// 		KeyVaultURL: to.Ptr("https://vault.azure.net/keys/key1"),
	// 	},
	// }
}

Output:

func (*KeysClient) NewListByWorkspacePager added in v0.4.0 

func (client *KeysClient) NewListByWorkspacePager(resourceGroupName string, workspaceName string, options *KeysClientListByWorkspaceOptions) *runtime.Pager[KeysClientListByWorkspaceResponse]

NewListByWorkspacePager - Returns a list of keys in a workspace

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - KeysClientListByWorkspaceOptions contains the optional parameters for the KeysClient.NewListByWorkspacePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListKeysInWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKeysClient().NewListByWorkspacePager("ExampleResourceGroup", "ExampleWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.KeyInfoListResult = armsynapse.KeyInfoListResult{
		// 	Value: []*armsynapse.Key{
		// 		{
		// 			Name: to.Ptr("key1"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/keys"),
		// 			ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key1"),
		// 			Properties: &armsynapse.KeyProperties{
		// 				IsActiveCMK: to.Ptr(false),
		// 				KeyVaultURL: to.Ptr("https://vault.azure.net/keys/somesecret1"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("key2"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/keys"),
		// 			ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key2"),
		// 			Properties: &armsynapse.KeyProperties{
		// 				IsActiveCMK: to.Ptr(true),
		// 				KeyVaultURL: to.Ptr("https://vault.azure.net/keys/somesecret2"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type KeysClientCreateOrUpdateOptions added in v0.2.0 

type KeysClientCreateOrUpdateOptions struct {
}

KeysClientCreateOrUpdateOptions contains the optional parameters for the KeysClient.CreateOrUpdate method.

type KeysClientCreateOrUpdateResponse added in v0.2.0 

type KeysClientCreateOrUpdateResponse struct {
	// A workspace key
	Key
}

KeysClientCreateOrUpdateResponse contains the response from method KeysClient.CreateOrUpdate.

type KeysClientDeleteOptions added in v0.2.0 

type KeysClientDeleteOptions struct {
}

KeysClientDeleteOptions contains the optional parameters for the KeysClient.Delete method.

type KeysClientDeleteResponse added in v0.2.0 

type KeysClientDeleteResponse struct {
	// A workspace key
	Key
}

KeysClientDeleteResponse contains the response from method KeysClient.Delete.

type KeysClientGetOptions added in v0.2.0 

type KeysClientGetOptions struct {
}

KeysClientGetOptions contains the optional parameters for the KeysClient.Get method.

type KeysClientGetResponse added in v0.2.0 

type KeysClientGetResponse struct {
	// A workspace key
	Key
}

KeysClientGetResponse contains the response from method KeysClient.Get.

type KeysClientListByWorkspaceOptions added in v0.2.0 

type KeysClientListByWorkspaceOptions struct {
}

KeysClientListByWorkspaceOptions contains the optional parameters for the KeysClient.NewListByWorkspacePager method.

type KeysClientListByWorkspaceResponse added in v0.2.0 

type KeysClientListByWorkspaceResponse struct {
	// List of keys
	KeyInfoListResult
}

KeysClientListByWorkspaceResponse contains the response from method KeysClient.NewListByWorkspacePager.

type Kind 

type Kind string

Kind - Kind of the database 

const (
	KindReadOnlyFollowing Kind = "ReadOnlyFollowing"
	KindReadWrite         Kind = "ReadWrite"
)

func PossibleKindValues 

func PossibleKindValues() []Kind

PossibleKindValues returns the possible values for the Kind const type.

type KustoOperationsClient 

type KustoOperationsClient struct {
	// contains filtered or unexported fields
}

KustoOperationsClient contains the methods for the KustoOperations group. Don't use this type directly, use NewKustoOperationsClient() instead.

func NewKustoOperationsClient 

func NewKustoOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*KustoOperationsClient, error)

NewKustoOperationsClient creates a new instance of KustoOperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*KustoOperationsClient) NewListPager added in v0.4.0 

func (client *KustoOperationsClient) NewListPager(options *KustoOperationsClientListOptions) *runtime.Pager[KustoOperationsClientListResponse]

NewListPager - Lists available operations for the Kusto sub-resources inside Microsoft.Synapse provider.

Generated from API version 2021-06-01-preview

  • options - KustoOperationsClientListOptions contains the optional parameters for the KustoOperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoOperationsList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKustoOperationsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OperationListResult = armsynapse.OperationListResult{
		// 	Value: []*armsynapse.Operation{
		// 		{
		// 			Name: to.Ptr("operationName"),
		// 			Display: &armsynapse.OperationDisplay{
		// 				Description: to.Ptr("operation description"),
		// 				Operation: to.Ptr("operationName"),
		// 				Provider: to.Ptr("providerName"),
		// 				Resource: to.Ptr("resourceName"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type KustoOperationsClientListOptions added in v0.2.0 

type KustoOperationsClientListOptions struct {
}

KustoOperationsClientListOptions contains the optional parameters for the KustoOperationsClient.NewListPager method.

type KustoOperationsClientListResponse added in v0.2.0 

type KustoOperationsClientListResponse struct {
	// Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next
	// set of results.
	OperationListResult
}

KustoOperationsClientListResponse contains the response from method KustoOperationsClient.NewListPager.

type KustoPool 

type KustoPool struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; The SKU of the kusto pool.
	SKU *AzureSKU

	// The kusto pool properties.
	Properties *KustoPoolProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

KustoPool - Class representing a Kusto kusto pool.

func (KustoPool) MarshalJSON 

func (k KustoPool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustoPool.

func (*KustoPool) UnmarshalJSON 

func (k *KustoPool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPool.

type KustoPoolAttachedDatabaseConfigurationsClient 

type KustoPoolAttachedDatabaseConfigurationsClient struct {
	// contains filtered or unexported fields
}

KustoPoolAttachedDatabaseConfigurationsClient contains the methods for the KustoPoolAttachedDatabaseConfigurations group. Don't use this type directly, use NewKustoPoolAttachedDatabaseConfigurationsClient() instead.

func NewKustoPoolAttachedDatabaseConfigurationsClient 

func NewKustoPoolAttachedDatabaseConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*KustoPoolAttachedDatabaseConfigurationsClient, error)

NewKustoPoolAttachedDatabaseConfigurationsClient creates a new instance of KustoPoolAttachedDatabaseConfigurationsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*KustoPoolAttachedDatabaseConfigurationsClient) BeginCreateOrUpdate 

func (client *KustoPoolAttachedDatabaseConfigurationsClient) BeginCreateOrUpdate(ctx context.Context, workspaceName string, kustoPoolName string, attachedDatabaseConfigurationName string, resourceGroupName string, parameters AttachedDatabaseConfiguration, options *KustoPoolAttachedDatabaseConfigurationsClientBeginCreateOrUpdateOptions) (*runtime.Poller[KustoPoolAttachedDatabaseConfigurationsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates an attached database configuration. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • attachedDatabaseConfigurationName - The name of the attached database configuration.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • parameters - The database parameters supplied to the CreateOrUpdate operation.
  • options - KustoPoolAttachedDatabaseConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolAttachedDatabaseConfigurationsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolAttachedDatabaseConfigurationsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolAttachedDatabaseConfigurationsClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoclusterrptest4", "attachedDatabaseConfigurations1", "kustorptest", armsynapse.AttachedDatabaseConfiguration{
		Location: to.Ptr("westus"),
		Properties: &armsynapse.AttachedDatabaseConfigurationProperties{
			KustoPoolResourceID:               to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/Workspaces/kustorptest/KustoPools/kustoclusterrptest4"),
			DatabaseName:                      to.Ptr("kustodatabase"),
			DefaultPrincipalsModificationKind: to.Ptr(armsynapse.DefaultPrincipalsModificationKindUnion),
			TableLevelSharingProperties: &armsynapse.TableLevelSharingProperties{
				ExternalTablesToExclude: []*string{
					to.Ptr("ExternalTable2")},
				ExternalTablesToInclude: []*string{
					to.Ptr("ExternalTable1")},
				MaterializedViewsToExclude: []*string{
					to.Ptr("MaterializedViewTable2")},
				MaterializedViewsToInclude: []*string{
					to.Ptr("MaterializedViewTable1")},
				TablesToExclude: []*string{
					to.Ptr("Table2")},
				TablesToInclude: []*string{
					to.Ptr("Table1")},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AttachedDatabaseConfiguration = armsynapse.AttachedDatabaseConfiguration{
	// 	Name: to.Ptr("KustoClusterRPTest4/attachedDatabaseConfigurations1"),
	// 	Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/AttachedDatabaseConfigurations"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/Workspaces/kustorptest/KustoPools/kustoclusterrptest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1"),
	// 	Location: to.Ptr("westus"),
	// 	Properties: &armsynapse.AttachedDatabaseConfigurationProperties{
	// 		KustoPoolResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/Workspaces/kustorptest/KustoPools/KustoClusterLeader"),
	// 		DatabaseName: to.Ptr("db1"),
	// 		DefaultPrincipalsModificationKind: to.Ptr(armsynapse.DefaultPrincipalsModificationKindUnion),
	// 		ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 		TableLevelSharingProperties: &armsynapse.TableLevelSharingProperties{
	// 			ExternalTablesToExclude: []*string{
	// 				to.Ptr("ExternalTable2")},
	// 				ExternalTablesToInclude: []*string{
	// 					to.Ptr("ExternalTable1")},
	// 					MaterializedViewsToExclude: []*string{
	// 						to.Ptr("MaterializedViewTable2")},
	// 						MaterializedViewsToInclude: []*string{
	// 							to.Ptr("MaterializedViewTable1")},
	// 							TablesToExclude: []*string{
	// 								to.Ptr("Table2")},
	// 								TablesToInclude: []*string{
	// 									to.Ptr("Table1")},
	// 								},
	// 							},
	// 						}
}

Output:

func (*KustoPoolAttachedDatabaseConfigurationsClient) BeginDelete 

func (client *KustoPoolAttachedDatabaseConfigurationsClient) BeginDelete(ctx context.Context, workspaceName string, kustoPoolName string, attachedDatabaseConfigurationName string, resourceGroupName string, options *KustoPoolAttachedDatabaseConfigurationsClientBeginDeleteOptions) (*runtime.Poller[KustoPoolAttachedDatabaseConfigurationsClientDeleteResponse], error)

BeginDelete - Deletes the attached database configuration with the given name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • attachedDatabaseConfigurationName - The name of the attached database configuration.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolAttachedDatabaseConfigurationsClientBeginDeleteOptions contains the optional parameters for the KustoPoolAttachedDatabaseConfigurationsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolAttachedDatabaseConfigurationsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolAttachedDatabaseConfigurationsClient().BeginDelete(ctx, "kustorptest", "kustoclusterrptest4", "attachedDatabaseConfigurations1", "kustorptest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KustoPoolAttachedDatabaseConfigurationsClient) Get 

func (client *KustoPoolAttachedDatabaseConfigurationsClient) Get(ctx context.Context, workspaceName string, kustoPoolName string, attachedDatabaseConfigurationName string, resourceGroupName string, options *KustoPoolAttachedDatabaseConfigurationsClientGetOptions) (KustoPoolAttachedDatabaseConfigurationsClientGetResponse, error)

Get - Returns an attached database configuration. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • attachedDatabaseConfigurationName - The name of the attached database configuration.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolAttachedDatabaseConfigurationsClientGetOptions contains the optional parameters for the KustoPoolAttachedDatabaseConfigurationsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolAttachedDatabaseConfigurationsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolAttachedDatabaseConfigurationsClient().Get(ctx, "kustorptest", "kustoclusterrptest4", "attachedDatabaseConfigurations1", "kustorptest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AttachedDatabaseConfiguration = armsynapse.AttachedDatabaseConfiguration{
	// 	Name: to.Ptr("KustoClusterRPTest4/attachedDatabaseConfigurations1"),
	// 	Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/AttachedDatabaseConfigurations"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/Workspaces/kustorptest/KustoPools/kustoclusterrptest4/AttachedDatabaseConfigurations/attachedDatabaseConfigurations1"),
	// 	Location: to.Ptr("westus"),
	// 	Properties: &armsynapse.AttachedDatabaseConfigurationProperties{
	// 		KustoPoolResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/Workspaces/kustorptest/KustoPools/kustoclusterrptest4"),
	// 		DatabaseName: to.Ptr("*"),
	// 		DefaultPrincipalsModificationKind: to.Ptr(armsynapse.DefaultPrincipalsModificationKindUnion),
	// 		ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 		TableLevelSharingProperties: &armsynapse.TableLevelSharingProperties{
	// 			ExternalTablesToExclude: []*string{
	// 				to.Ptr("ExternalTable2")},
	// 				ExternalTablesToInclude: []*string{
	// 					to.Ptr("ExternalTable1")},
	// 					MaterializedViewsToExclude: []*string{
	// 						to.Ptr("MaterializedViewTable2")},
	// 						MaterializedViewsToInclude: []*string{
	// 							to.Ptr("MaterializedViewTable1")},
	// 							TablesToExclude: []*string{
	// 								to.Ptr("Table2")},
	// 								TablesToInclude: []*string{
	// 									to.Ptr("Table1")},
	// 								},
	// 							},
	// 						}
}

Output:

func (*KustoPoolAttachedDatabaseConfigurationsClient) NewListByKustoPoolPager added in v0.4.0 

func (client *KustoPoolAttachedDatabaseConfigurationsClient) NewListByKustoPoolPager(workspaceName string, kustoPoolName string, resourceGroupName string, options *KustoPoolAttachedDatabaseConfigurationsClientListByKustoPoolOptions) *runtime.Pager[KustoPoolAttachedDatabaseConfigurationsClientListByKustoPoolResponse]

NewListByKustoPoolPager - Returns the list of attached database configurations of the given Kusto Pool.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolAttachedDatabaseConfigurationsClientListByKustoPoolOptions contains the optional parameters for the KustoPoolAttachedDatabaseConfigurationsClient.NewListByKustoPoolPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolAttachedDatabaseConfigurationsListByKustoPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKustoPoolAttachedDatabaseConfigurationsClient().NewListByKustoPoolPager("kustorptest", "kustoclusterrptest4", "kustorptest", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AttachedDatabaseConfigurationListResult = armsynapse.AttachedDatabaseConfigurationListResult{
		// 	Value: []*armsynapse.AttachedDatabaseConfiguration{
		// 		{
		// 			Name: to.Ptr("KustoClusterRPTest4/KustoDatabase8"),
		// 			Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/AttachedDatabaseConfigurations"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/Workspaces/kustorptest/KustoPools/kustoclusterrptest4/AttachedDatabaseConfigurations/KustoDatabase8"),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armsynapse.AttachedDatabaseConfigurationProperties{
		// 				KustoPoolResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/Workspaces/kustorptest/KustoPools/KustoClusterLeader"),
		// 				DatabaseName: to.Ptr("db1"),
		// 				DefaultPrincipalsModificationKind: to.Ptr(armsynapse.DefaultPrincipalsModificationKindUnion),
		// 				ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("KustoClusterRPTest4/KustoDatabase9"),
		// 			Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/AttachedDatabaseConfigurations"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/Workspaces/kustorptest/KustoPools/kustoclusterrptest4/AttachedDatabaseConfigurations/KustoDatabase9"),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armsynapse.AttachedDatabaseConfigurationProperties{
		// 				KustoPoolResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/Workspaces/kustorptest/KustoPools/KustoClusterLeader"),
		// 				DatabaseName: to.Ptr("db1"),
		// 				DefaultPrincipalsModificationKind: to.Ptr(armsynapse.DefaultPrincipalsModificationKindUnion),
		// 				ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
		// 				TableLevelSharingProperties: &armsynapse.TableLevelSharingProperties{
		// 					ExternalTablesToExclude: []*string{
		// 						to.Ptr("ExternalTable2")},
		// 						ExternalTablesToInclude: []*string{
		// 							to.Ptr("ExternalTable1")},
		// 							MaterializedViewsToExclude: []*string{
		// 								to.Ptr("MaterializedViewTable2")},
		// 								MaterializedViewsToInclude: []*string{
		// 									to.Ptr("MaterializedViewTable1")},
		// 									TablesToExclude: []*string{
		// 										to.Ptr("Table2")},
		// 										TablesToInclude: []*string{
		// 											to.Ptr("Table1")},
		// 										},
		// 									},
		// 							}},
		// 						}
	}
}

Output:

type KustoPoolAttachedDatabaseConfigurationsClientBeginCreateOrUpdateOptions added in v0.2.0 

type KustoPoolAttachedDatabaseConfigurationsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolAttachedDatabaseConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolAttachedDatabaseConfigurationsClient.BeginCreateOrUpdate method.

type KustoPoolAttachedDatabaseConfigurationsClientBeginDeleteOptions added in v0.2.0 

type KustoPoolAttachedDatabaseConfigurationsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolAttachedDatabaseConfigurationsClientBeginDeleteOptions contains the optional parameters for the KustoPoolAttachedDatabaseConfigurationsClient.BeginDelete method.

type KustoPoolAttachedDatabaseConfigurationsClientCreateOrUpdateResponse added in v0.2.0 

type KustoPoolAttachedDatabaseConfigurationsClientCreateOrUpdateResponse struct {
	// Class representing an attached database configuration.
	AttachedDatabaseConfiguration
}

KustoPoolAttachedDatabaseConfigurationsClientCreateOrUpdateResponse contains the response from method KustoPoolAttachedDatabaseConfigurationsClient.BeginCreateOrUpdate.

type KustoPoolAttachedDatabaseConfigurationsClientDeleteResponse added in v0.2.0 

type KustoPoolAttachedDatabaseConfigurationsClientDeleteResponse struct {
}

KustoPoolAttachedDatabaseConfigurationsClientDeleteResponse contains the response from method KustoPoolAttachedDatabaseConfigurationsClient.BeginDelete.

type KustoPoolAttachedDatabaseConfigurationsClientGetOptions added in v0.2.0 

type KustoPoolAttachedDatabaseConfigurationsClientGetOptions struct {
}

KustoPoolAttachedDatabaseConfigurationsClientGetOptions contains the optional parameters for the KustoPoolAttachedDatabaseConfigurationsClient.Get method.

type KustoPoolAttachedDatabaseConfigurationsClientGetResponse added in v0.2.0 

type KustoPoolAttachedDatabaseConfigurationsClientGetResponse struct {
	// Class representing an attached database configuration.
	AttachedDatabaseConfiguration
}

KustoPoolAttachedDatabaseConfigurationsClientGetResponse contains the response from method KustoPoolAttachedDatabaseConfigurationsClient.Get.

type KustoPoolAttachedDatabaseConfigurationsClientListByKustoPoolOptions added in v0.2.0 

type KustoPoolAttachedDatabaseConfigurationsClientListByKustoPoolOptions struct {
}

KustoPoolAttachedDatabaseConfigurationsClientListByKustoPoolOptions contains the optional parameters for the KustoPoolAttachedDatabaseConfigurationsClient.NewListByKustoPoolPager method.

type KustoPoolAttachedDatabaseConfigurationsClientListByKustoPoolResponse added in v0.2.0 

type KustoPoolAttachedDatabaseConfigurationsClientListByKustoPoolResponse struct {
	// The list attached database configurations operation response.
	AttachedDatabaseConfigurationListResult
}

KustoPoolAttachedDatabaseConfigurationsClientListByKustoPoolResponse contains the response from method KustoPoolAttachedDatabaseConfigurationsClient.NewListByKustoPoolPager.

type KustoPoolCheckNameRequest 

type KustoPoolCheckNameRequest struct {
	// REQUIRED; Kusto Pool name.
	Name *string

	// CONSTANT; The type of resource, Microsoft.Synapse/workspaces/kustoPools.
	// Field has constant value "Microsoft.Synapse/workspaces/kustoPools", any specified value is ignored.
	Type *string
}

KustoPoolCheckNameRequest - The object sent for a kusto pool check name availability request.

func (KustoPoolCheckNameRequest) MarshalJSON added in v0.6.0 

func (k KustoPoolCheckNameRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustoPoolCheckNameRequest.

func (*KustoPoolCheckNameRequest) UnmarshalJSON added in v0.6.0 

func (k *KustoPoolCheckNameRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPoolCheckNameRequest.

type KustoPoolChildResourceClient 

type KustoPoolChildResourceClient struct {
	// contains filtered or unexported fields
}

KustoPoolChildResourceClient contains the methods for the KustoPoolChildResource group. Don't use this type directly, use NewKustoPoolChildResourceClient() instead.

func NewKustoPoolChildResourceClient 

func NewKustoPoolChildResourceClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*KustoPoolChildResourceClient, error)

NewKustoPoolChildResourceClient creates a new instance of KustoPoolChildResourceClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*KustoPoolChildResourceClient) CheckNameAvailability 

func (client *KustoPoolChildResourceClient) CheckNameAvailability(ctx context.Context, workspaceName string, kustoPoolName string, resourceGroupName string, resourceName DatabaseCheckNameRequest, options *KustoPoolChildResourceClientCheckNameAvailabilityOptions) (KustoPoolChildResourceClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the Kusto Pool child resource name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • resourceName - The name of the Kusto Pool child resource.
  • options - KustoPoolChildResourceClientCheckNameAvailabilityOptions contains the optional parameters for the KustoPoolChildResourceClient.CheckNameAvailability method.
Example (KustoPoolAttachedDatabaseConfigurationCheckNameAvailability)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolAttachedDatabaseConfigurationCheckNameAvailability.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolChildResourceClient().CheckNameAvailability(ctx, "kustorptest", "kustoclusterrptest4", "kustorptest", armsynapse.DatabaseCheckNameRequest{
		Name: to.Ptr("adc1"),
		Type: to.Ptr(armsynapse.TypeMicrosoftSynapseWorkspacesKustoPoolsAttachedDatabaseConfigurations),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameResult = armsynapse.CheckNameResult{
	// 	Name: to.Ptr("adc1"),
	// 	Message: to.Ptr("Name 'adc1' is already taken. Please specify a different name"),
	// 	NameAvailable: to.Ptr(false),
	// }
}

Output:
Example (KustoPoolDatabasesCheckNameAvailability)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDatabasesCheckNameAvailability.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolChildResourceClient().CheckNameAvailability(ctx, "synapseWorkspaceName", "kustoclusterrptest4", "kustorptest", armsynapse.DatabaseCheckNameRequest{
		Name: to.Ptr("database1"),
		Type: to.Ptr(armsynapse.TypeMicrosoftSynapseWorkspacesKustoPoolsDatabases),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameResult = armsynapse.CheckNameResult{
	// 	Name: to.Ptr("database1"),
	// 	Message: to.Ptr("Name 'database1' is already taken. Please specify a different name"),
	// 	NameAvailable: to.Ptr(false),
	// }
}

Output:

type KustoPoolChildResourceClientCheckNameAvailabilityOptions added in v0.2.0 

type KustoPoolChildResourceClientCheckNameAvailabilityOptions struct {
}

KustoPoolChildResourceClientCheckNameAvailabilityOptions contains the optional parameters for the KustoPoolChildResourceClient.CheckNameAvailability method.

type KustoPoolChildResourceClientCheckNameAvailabilityResponse added in v0.2.0 

type KustoPoolChildResourceClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

KustoPoolChildResourceClientCheckNameAvailabilityResponse contains the response from method KustoPoolChildResourceClient.CheckNameAvailability.

type KustoPoolDataConnectionsClient 

type KustoPoolDataConnectionsClient struct {
	// contains filtered or unexported fields
}

KustoPoolDataConnectionsClient contains the methods for the KustoPoolDataConnections group. Don't use this type directly, use NewKustoPoolDataConnectionsClient() instead.

func NewKustoPoolDataConnectionsClient 

func NewKustoPoolDataConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*KustoPoolDataConnectionsClient, error)

NewKustoPoolDataConnectionsClient creates a new instance of KustoPoolDataConnectionsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*KustoPoolDataConnectionsClient) BeginCreateOrUpdate 

func (client *KustoPoolDataConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, kustoPoolName string, databaseName string, dataConnectionName string, parameters DataConnectionClassification, options *KustoPoolDataConnectionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[KustoPoolDataConnectionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a data connection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • dataConnectionName - The name of the data connection.
  • parameters - The data connection parameters supplied to the CreateOrUpdate operation.
  • options - KustoPoolDataConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolDataConnectionsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDataConnectionsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolDataConnectionsClient().BeginCreateOrUpdate(ctx, "kustorptest", "synapseWorkspaceName", "kustoclusterrptest4", "KustoDatabase8", "DataConnections8", &armsynapse.EventHubDataConnection{
		Kind:     to.Ptr(armsynapse.DataConnectionKindEventHub),
		Location: to.Ptr("westus"),
		Properties: &armsynapse.EventHubConnectionProperties{
			ConsumerGroup:      to.Ptr("testConsumerGroup1"),
			EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsynapse.KustoPoolDataConnectionsClientCreateOrUpdateResponse{
	// 	                            DataConnectionClassification: &armsynapse.EventHubDataConnection{
	// 		Name: to.Ptr("KustoClusterRPTest4/KustoDatabase8/DataConnections8"),
	// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
	// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustopools/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8"),
	// 		Kind: to.Ptr(armsynapse.DataConnectionKindEventHub),
	// 		Location: to.Ptr("westus"),
	// 		Properties: &armsynapse.EventHubConnectionProperties{
	// 			ConsumerGroup: to.Ptr("testConsumerGroup1"),
	// 			EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*KustoPoolDataConnectionsClient) BeginDataConnectionValidation 

func (client *KustoPoolDataConnectionsClient) BeginDataConnectionValidation(ctx context.Context, resourceGroupName string, workspaceName string, kustoPoolName string, databaseName string, parameters DataConnectionValidation, options *KustoPoolDataConnectionsClientBeginDataConnectionValidationOptions) (*runtime.Poller[KustoPoolDataConnectionsClientDataConnectionValidationResponse], error)

BeginDataConnectionValidation - Checks that the data connection parameters are valid. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • parameters - The data connection parameters supplied to the CreateOrUpdate operation.
  • options - KustoPoolDataConnectionsClientBeginDataConnectionValidationOptions contains the optional parameters for the KustoPoolDataConnectionsClient.BeginDataConnectionValidation method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDataConnectionValidation.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolDataConnectionsClient().BeginDataConnectionValidation(ctx, "kustorptest", "kustorptest", "kustoclusterrptest4", "KustoDatabase8", armsynapse.DataConnectionValidation{
		DataConnectionName: to.Ptr("DataConnections8"),
		Properties: &armsynapse.EventHubDataConnection{
			Kind: to.Ptr(armsynapse.DataConnectionKindEventHub),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataConnectionValidationListResult = armsynapse.DataConnectionValidationListResult{
	// 	Value: []*armsynapse.DataConnectionValidationResult{
	// 		{
	// 			ErrorMessage: to.Ptr("Event hub's namespace does not exist"),
	// 		},
	// 		{
	// 			ErrorMessage: to.Ptr("Database does not exist"),
	// 	}},
	// }
}

Output:

func (*KustoPoolDataConnectionsClient) BeginDelete 

func (client *KustoPoolDataConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, kustoPoolName string, databaseName string, dataConnectionName string, options *KustoPoolDataConnectionsClientBeginDeleteOptions) (*runtime.Poller[KustoPoolDataConnectionsClientDeleteResponse], error)

BeginDelete - Deletes the data connection with the given name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • dataConnectionName - The name of the data connection.
  • options - KustoPoolDataConnectionsClientBeginDeleteOptions contains the optional parameters for the KustoPoolDataConnectionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDataConnectionsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolDataConnectionsClient().BeginDelete(ctx, "kustorptest", "synapseWorkspaceName", "kustoclusterrptest4", "KustoDatabase8", "kustoeventhubconnection1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KustoPoolDataConnectionsClient) BeginUpdate 

func (client *KustoPoolDataConnectionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, workspaceName string, kustoPoolName string, databaseName string, dataConnectionName string, parameters DataConnectionClassification, options *KustoPoolDataConnectionsClientBeginUpdateOptions) (*runtime.Poller[KustoPoolDataConnectionsClientUpdateResponse], error)

BeginUpdate - Updates a data connection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • dataConnectionName - The name of the data connection.
  • parameters - The data connection parameters supplied to the Update operation.
  • options - KustoPoolDataConnectionsClientBeginUpdateOptions contains the optional parameters for the KustoPoolDataConnectionsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDataConnectionsUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolDataConnectionsClient().BeginUpdate(ctx, "kustorptest", "synapseWorkspaceName", "kustoclusterrptest4", "KustoDatabase8", "DataConnections8", &armsynapse.EventHubDataConnection{
		Kind:     to.Ptr(armsynapse.DataConnectionKindEventHub),
		Location: to.Ptr("westus"),
		Properties: &armsynapse.EventHubConnectionProperties{
			ConsumerGroup:      to.Ptr("testConsumerGroup1"),
			EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsynapse.KustoPoolDataConnectionsClientUpdateResponse{
	// 	                            DataConnectionClassification: &armsynapse.EventHubDataConnection{
	// 		Name: to.Ptr("KustoClusterRPTest4/KustoDatabase8/DataConnections8"),
	// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
	// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustopools/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8"),
	// 		Kind: to.Ptr(armsynapse.DataConnectionKindEventHub),
	// 		Location: to.Ptr("westus"),
	// 		Properties: &armsynapse.EventHubConnectionProperties{
	// 			ConsumerGroup: to.Ptr("testConsumerGroup1"),
	// 			EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*KustoPoolDataConnectionsClient) CheckNameAvailability 

func (client *KustoPoolDataConnectionsClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, workspaceName string, kustoPoolName string, databaseName string, dataConnectionName DataConnectionCheckNameRequest, options *KustoPoolDataConnectionsClientCheckNameAvailabilityOptions) (KustoPoolDataConnectionsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the data connection name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • dataConnectionName - The name of the data connection.
  • options - KustoPoolDataConnectionsClientCheckNameAvailabilityOptions contains the optional parameters for the KustoPoolDataConnectionsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDataConnectionsCheckNameAvailability.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolDataConnectionsClient().CheckNameAvailability(ctx, "kustorptest", "synapseWorkspaceName", "kustoclusterrptest4", "Kustodatabase8", armsynapse.DataConnectionCheckNameRequest{
		Name: to.Ptr("DataConnections8"),
		Type: to.Ptr("Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameResult = armsynapse.CheckNameResult{
	// 	Name: to.Ptr("DataConnections8"),
	// 	Message: to.Ptr("Name 'DataConnections8' is already taken. Please specify a different name."),
	// 	NameAvailable: to.Ptr(false),
	// 	Reason: to.Ptr(armsynapse.ReasonAlreadyExists),
	// }
}

Output:

func (*KustoPoolDataConnectionsClient) Get 

func (client *KustoPoolDataConnectionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, kustoPoolName string, databaseName string, dataConnectionName string, options *KustoPoolDataConnectionsClientGetOptions) (KustoPoolDataConnectionsClientGetResponse, error)

Get - Returns a data connection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • dataConnectionName - The name of the data connection.
  • options - KustoPoolDataConnectionsClientGetOptions contains the optional parameters for the KustoPoolDataConnectionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDataConnectionsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolDataConnectionsClient().Get(ctx, "kustorptest", "synapseWorkspaceName", "kustoclusterrptest4", "KustoDatabase8", "DataConnections8", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsynapse.KustoPoolDataConnectionsClientGetResponse{
	// 	                            DataConnectionClassification: &armsynapse.EventHubDataConnection{
	// 		Name: to.Ptr("KustoClusterRPTest4/KustoDatabase8/DataConnections8"),
	// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
	// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustopools/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8"),
	// 		Kind: to.Ptr(armsynapse.DataConnectionKindEventHub),
	// 		Location: to.Ptr("westus"),
	// 		Properties: &armsynapse.EventHubConnectionProperties{
	// 			ConsumerGroup: to.Ptr("testConsumerGroup1"),
	// 			EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*KustoPoolDataConnectionsClient) NewListByDatabasePager added in v0.4.0 

func (client *KustoPoolDataConnectionsClient) NewListByDatabasePager(resourceGroupName string, workspaceName string, kustoPoolName string, databaseName string, options *KustoPoolDataConnectionsClientListByDatabaseOptions) *runtime.Pager[KustoPoolDataConnectionsClientListByDatabaseResponse]

NewListByDatabasePager - Returns the list of data connections of the given Kusto pool database.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • options - KustoPoolDataConnectionsClientListByDatabaseOptions contains the optional parameters for the KustoPoolDataConnectionsClient.NewListByDatabasePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDataConnectionsListByDatabase.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKustoPoolDataConnectionsClient().NewListByDatabasePager("kustorptest", "synapseWorkspaceName", "kustoclusterrptest4", "KustoDatabase8", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DataConnectionListResult = armsynapse.DataConnectionListResult{
		// 	Value: []armsynapse.DataConnectionClassification{
		// 		&armsynapse.EventHubDataConnection{
		// 			Name: to.Ptr("KustoClusterRPTest4/KustoDatabase8/KustoDataConnection8"),
		// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustopools/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/KustoDataConnection8"),
		// 			Kind: to.Ptr(armsynapse.DataConnectionKindEventHub),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armsynapse.EventHubConnectionProperties{
		// 				ConsumerGroup: to.Ptr("testConsumerGroup1"),
		// 				EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
		// 			},
		// 		},
		// 		&armsynapse.EventHubDataConnection{
		// 			Name: to.Ptr("KustoClusterRPTest4/KustoDatabase9/KustoDataConnection9"),
		// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustopools/KustoClusterRPTest4/Databases/KustoDatabase9/DataConnections/KustoDataConnection9"),
		// 			Kind: to.Ptr(armsynapse.DataConnectionKindEventHub),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armsynapse.EventHubConnectionProperties{
		// 				ConsumerGroup: to.Ptr("testConsumerGroup2"),
		// 				EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns2/eventhubs/eventhubTest2"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type KustoPoolDataConnectionsClientBeginCreateOrUpdateOptions added in v0.2.0 

type KustoPoolDataConnectionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolDataConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolDataConnectionsClient.BeginCreateOrUpdate method.

type KustoPoolDataConnectionsClientBeginDataConnectionValidationOptions added in v0.2.0 

type KustoPoolDataConnectionsClientBeginDataConnectionValidationOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolDataConnectionsClientBeginDataConnectionValidationOptions contains the optional parameters for the KustoPoolDataConnectionsClient.BeginDataConnectionValidation method.

type KustoPoolDataConnectionsClientBeginDeleteOptions added in v0.2.0 

type KustoPoolDataConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolDataConnectionsClientBeginDeleteOptions contains the optional parameters for the KustoPoolDataConnectionsClient.BeginDelete method.

type KustoPoolDataConnectionsClientBeginUpdateOptions added in v0.2.0 

type KustoPoolDataConnectionsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolDataConnectionsClientBeginUpdateOptions contains the optional parameters for the KustoPoolDataConnectionsClient.BeginUpdate method.

type KustoPoolDataConnectionsClientCheckNameAvailabilityOptions added in v0.2.0 

type KustoPoolDataConnectionsClientCheckNameAvailabilityOptions struct {
}

KustoPoolDataConnectionsClientCheckNameAvailabilityOptions contains the optional parameters for the KustoPoolDataConnectionsClient.CheckNameAvailability method.

type KustoPoolDataConnectionsClientCheckNameAvailabilityResponse added in v0.2.0 

type KustoPoolDataConnectionsClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

KustoPoolDataConnectionsClientCheckNameAvailabilityResponse contains the response from method KustoPoolDataConnectionsClient.CheckNameAvailability.

type KustoPoolDataConnectionsClientCreateOrUpdateResponse added in v0.2.0 

type KustoPoolDataConnectionsClientCreateOrUpdateResponse struct {
	// Class representing a data connection.
	DataConnectionClassification
}

KustoPoolDataConnectionsClientCreateOrUpdateResponse contains the response from method KustoPoolDataConnectionsClient.BeginCreateOrUpdate.

func (KustoPoolDataConnectionsClientCreateOrUpdateResponse) MarshalJSON added in v0.8.0 

func (k KustoPoolDataConnectionsClientCreateOrUpdateResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustoPoolDataConnectionsClientCreateOrUpdateResponse.

func (*KustoPoolDataConnectionsClientCreateOrUpdateResponse) UnmarshalJSON added in v0.3.0 

func (k *KustoPoolDataConnectionsClientCreateOrUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPoolDataConnectionsClientCreateOrUpdateResponse.

type KustoPoolDataConnectionsClientDataConnectionValidationResponse added in v0.2.0 

type KustoPoolDataConnectionsClientDataConnectionValidationResponse struct {
	// The list Kusto data connection validation result.
	DataConnectionValidationListResult
}

KustoPoolDataConnectionsClientDataConnectionValidationResponse contains the response from method KustoPoolDataConnectionsClient.BeginDataConnectionValidation.

type KustoPoolDataConnectionsClientDeleteResponse added in v0.2.0 

type KustoPoolDataConnectionsClientDeleteResponse struct {
}

KustoPoolDataConnectionsClientDeleteResponse contains the response from method KustoPoolDataConnectionsClient.BeginDelete.

type KustoPoolDataConnectionsClientGetOptions added in v0.2.0 

type KustoPoolDataConnectionsClientGetOptions struct {
}

KustoPoolDataConnectionsClientGetOptions contains the optional parameters for the KustoPoolDataConnectionsClient.Get method.

type KustoPoolDataConnectionsClientGetResponse added in v0.2.0 

type KustoPoolDataConnectionsClientGetResponse struct {
	// Class representing a data connection.
	DataConnectionClassification
}

KustoPoolDataConnectionsClientGetResponse contains the response from method KustoPoolDataConnectionsClient.Get.

func (*KustoPoolDataConnectionsClientGetResponse) UnmarshalJSON added in v0.3.0 

func (k *KustoPoolDataConnectionsClientGetResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPoolDataConnectionsClientGetResponse.

type KustoPoolDataConnectionsClientListByDatabaseOptions added in v0.2.0 

type KustoPoolDataConnectionsClientListByDatabaseOptions struct {
}

KustoPoolDataConnectionsClientListByDatabaseOptions contains the optional parameters for the KustoPoolDataConnectionsClient.NewListByDatabasePager method.

type KustoPoolDataConnectionsClientListByDatabaseResponse added in v0.2.0 

type KustoPoolDataConnectionsClientListByDatabaseResponse struct {
	// The list Kusto data connections operation response.
	DataConnectionListResult
}

KustoPoolDataConnectionsClientListByDatabaseResponse contains the response from method KustoPoolDataConnectionsClient.NewListByDatabasePager.

type KustoPoolDataConnectionsClientUpdateResponse added in v0.2.0 

type KustoPoolDataConnectionsClientUpdateResponse struct {
	// Class representing a data connection.
	DataConnectionClassification
}

KustoPoolDataConnectionsClientUpdateResponse contains the response from method KustoPoolDataConnectionsClient.BeginUpdate.

func (KustoPoolDataConnectionsClientUpdateResponse) MarshalJSON added in v0.8.0 

func (k KustoPoolDataConnectionsClientUpdateResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustoPoolDataConnectionsClientUpdateResponse.

func (*KustoPoolDataConnectionsClientUpdateResponse) UnmarshalJSON added in v0.3.0 

func (k *KustoPoolDataConnectionsClientUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPoolDataConnectionsClientUpdateResponse.

type KustoPoolDatabasePrincipalAssignmentsClient 

type KustoPoolDatabasePrincipalAssignmentsClient struct {
	// contains filtered or unexported fields
}

KustoPoolDatabasePrincipalAssignmentsClient contains the methods for the KustoPoolDatabasePrincipalAssignments group. Don't use this type directly, use NewKustoPoolDatabasePrincipalAssignmentsClient() instead.

func NewKustoPoolDatabasePrincipalAssignmentsClient 

func NewKustoPoolDatabasePrincipalAssignmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*KustoPoolDatabasePrincipalAssignmentsClient, error)

NewKustoPoolDatabasePrincipalAssignmentsClient creates a new instance of KustoPoolDatabasePrincipalAssignmentsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*KustoPoolDatabasePrincipalAssignmentsClient) BeginCreateOrUpdate 

func (client *KustoPoolDatabasePrincipalAssignmentsClient) BeginCreateOrUpdate(ctx context.Context, workspaceName string, kustoPoolName string, databaseName string, principalAssignmentName string, resourceGroupName string, parameters DatabasePrincipalAssignment, options *KustoPoolDatabasePrincipalAssignmentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[KustoPoolDatabasePrincipalAssignmentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a Kusto pool database principalAssignment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • parameters - The Kusto principalAssignments parameters supplied for the operation.
  • options - KustoPoolDatabasePrincipalAssignmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolDatabasePrincipalAssignmentsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDatabasePrincipalAssignmentsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolDatabasePrincipalAssignmentsClient().BeginCreateOrUpdate(ctx, "synapseWorkspaceName", "kustoclusterrptest4", "Kustodatabase8", "kustoprincipal1", "kustorptest", armsynapse.DatabasePrincipalAssignment{
		Properties: &armsynapse.DatabasePrincipalProperties{
			PrincipalID:   to.Ptr("87654321-1234-1234-1234-123456789123"),
			PrincipalType: to.Ptr(armsynapse.PrincipalTypeApp),
			Role:          to.Ptr(armsynapse.DatabasePrincipalRoleAdmin),
			TenantID:      to.Ptr("12345678-1234-1234-1234-123456789123"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DatabasePrincipalAssignment = armsynapse.DatabasePrincipalAssignment{
	// 	Name: to.Ptr("synapseWorkspaceName/kustoclusterrptest4/Kustodatabase8/kustoprincipal1"),
	// 	Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/Databases/PrincipalAssignments"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustoPools/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1"),
	// 	Properties: &armsynapse.DatabasePrincipalProperties{
	// 		AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
	// 		PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
	// 		PrincipalName: to.Ptr("TestApp"),
	// 		PrincipalType: to.Ptr(armsynapse.PrincipalTypeApp),
	// 		ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 		Role: to.Ptr(armsynapse.DatabasePrincipalRoleAdmin),
	// 		TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
	// 		TenantName: to.Ptr("tenantName"),
	// 	},
	// }
}

Output:

func (*KustoPoolDatabasePrincipalAssignmentsClient) BeginDelete 

func (client *KustoPoolDatabasePrincipalAssignmentsClient) BeginDelete(ctx context.Context, workspaceName string, kustoPoolName string, databaseName string, principalAssignmentName string, resourceGroupName string, options *KustoPoolDatabasePrincipalAssignmentsClientBeginDeleteOptions) (*runtime.Poller[KustoPoolDatabasePrincipalAssignmentsClientDeleteResponse], error)

BeginDelete - Deletes a Kusto pool principalAssignment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolDatabasePrincipalAssignmentsClientBeginDeleteOptions contains the optional parameters for the KustoPoolDatabasePrincipalAssignmentsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDatabasePrincipalAssignmentsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolDatabasePrincipalAssignmentsClient().BeginDelete(ctx, "synapseWorkspaceName", "kustoclusterrptest4", "Kustodatabase8", "kustoprincipal1", "kustorptest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KustoPoolDatabasePrincipalAssignmentsClient) CheckNameAvailability 

func (client *KustoPoolDatabasePrincipalAssignmentsClient) CheckNameAvailability(ctx context.Context, workspaceName string, kustoPoolName string, databaseName string, resourceGroupName string, principalAssignmentName DatabasePrincipalAssignmentCheckNameRequest, options *KustoPoolDatabasePrincipalAssignmentsClientCheckNameAvailabilityOptions) (KustoPoolDatabasePrincipalAssignmentsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the database principal assignment is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • principalAssignmentName - The name of the resource.
  • options - KustoPoolDatabasePrincipalAssignmentsClientCheckNameAvailabilityOptions contains the optional parameters for the KustoPoolDatabasePrincipalAssignmentsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDatabasePrincipalAssignmentsCheckNameAvailability.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolDatabasePrincipalAssignmentsClient().CheckNameAvailability(ctx, "synapseWorkspaceName", "kustoclusterrptest4", "Kustodatabase8", "kustorptest", armsynapse.DatabasePrincipalAssignmentCheckNameRequest{
		Name: to.Ptr("kustoprincipal1"),
		Type: to.Ptr("Microsoft.Synapse/workspaces/kustoPools/databases/principalAssignments"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameResult = armsynapse.CheckNameResult{
	// 	Name: to.Ptr("kustoprincipal1"),
	// 	Message: to.Ptr("Name 'kustoprincipal1' is already taken. Please specify a different name"),
	// 	NameAvailable: to.Ptr(false),
	// }
}

Output:

func (*KustoPoolDatabasePrincipalAssignmentsClient) Get 

func (client *KustoPoolDatabasePrincipalAssignmentsClient) Get(ctx context.Context, workspaceName string, kustoPoolName string, databaseName string, principalAssignmentName string, resourceGroupName string, options *KustoPoolDatabasePrincipalAssignmentsClientGetOptions) (KustoPoolDatabasePrincipalAssignmentsClientGetResponse, error)

Get - Gets a Kusto pool database principalAssignment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolDatabasePrincipalAssignmentsClientGetOptions contains the optional parameters for the KustoPoolDatabasePrincipalAssignmentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDatabasePrincipalAssignmentsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolDatabasePrincipalAssignmentsClient().Get(ctx, "synapseWorkspaceName", "kustoclusterrptest4", "Kustodatabase8", "kustoprincipal1", "kustorptest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DatabasePrincipalAssignment = armsynapse.DatabasePrincipalAssignment{
	// 	Name: to.Ptr("synapseWorkspaceName/kustoclusterrptest4/Kustodatabase8/kustoprincipal1"),
	// 	Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/Databases/PrincipalAssignments"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustoPools/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1"),
	// 	Properties: &armsynapse.DatabasePrincipalProperties{
	// 		AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
	// 		PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
	// 		PrincipalName: to.Ptr("TestApp"),
	// 		PrincipalType: to.Ptr(armsynapse.PrincipalTypeApp),
	// 		ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 		Role: to.Ptr(armsynapse.DatabasePrincipalRoleAdmin),
	// 		TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
	// 		TenantName: to.Ptr("tenantName"),
	// 	},
	// }
}

Output:

func (*KustoPoolDatabasePrincipalAssignmentsClient) NewListPager added in v0.4.0 

func (client *KustoPoolDatabasePrincipalAssignmentsClient) NewListPager(workspaceName string, kustoPoolName string, databaseName string, resourceGroupName string, options *KustoPoolDatabasePrincipalAssignmentsClientListOptions) *runtime.Pager[KustoPoolDatabasePrincipalAssignmentsClientListResponse]

NewListPager - Lists all Kusto pool database principalAssignments.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolDatabasePrincipalAssignmentsClientListOptions contains the optional parameters for the KustoPoolDatabasePrincipalAssignmentsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDatabasePrincipalAssignmentsList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKustoPoolDatabasePrincipalAssignmentsClient().NewListPager("synapseWorkspaceName", "kustoclusterrptest4", "Kustodatabase8", "kustorptest", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DatabasePrincipalAssignmentListResult = armsynapse.DatabasePrincipalAssignmentListResult{
		// 	Value: []*armsynapse.DatabasePrincipalAssignment{
		// 		{
		// 			Name: to.Ptr("synapseWorkspaceName/kustoclusterrptest4/Kustodatabase8/kustoprincipal1"),
		// 			Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/Databases/PrincipalAssignments"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustoPools/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1"),
		// 			Properties: &armsynapse.DatabasePrincipalProperties{
		// 				AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
		// 				PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
		// 				PrincipalName: to.Ptr("TestApp"),
		// 				PrincipalType: to.Ptr(armsynapse.PrincipalTypeApp),
		// 				ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
		// 				Role: to.Ptr(armsynapse.DatabasePrincipalRoleAdmin),
		// 				TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
		// 				TenantName: to.Ptr("tenantName"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("synapseWorkspaceName/kustoclusterrptest4/Kustodatabase8/kustoprincipal2"),
		// 			Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/Databases/PrincipalAssignments"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustoPools/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal2"),
		// 			Properties: &armsynapse.DatabasePrincipalProperties{
		// 				AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
		// 				PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
		// 				PrincipalName: to.Ptr("TestApp"),
		// 				PrincipalType: to.Ptr(armsynapse.PrincipalTypeApp),
		// 				ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
		// 				Role: to.Ptr(armsynapse.DatabasePrincipalRoleAdmin),
		// 				TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
		// 				TenantName: to.Ptr("tenantName"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type KustoPoolDatabasePrincipalAssignmentsClientBeginCreateOrUpdateOptions added in v0.2.0 

type KustoPoolDatabasePrincipalAssignmentsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolDatabasePrincipalAssignmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolDatabasePrincipalAssignmentsClient.BeginCreateOrUpdate method.

type KustoPoolDatabasePrincipalAssignmentsClientBeginDeleteOptions added in v0.2.0 

type KustoPoolDatabasePrincipalAssignmentsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolDatabasePrincipalAssignmentsClientBeginDeleteOptions contains the optional parameters for the KustoPoolDatabasePrincipalAssignmentsClient.BeginDelete method.

type KustoPoolDatabasePrincipalAssignmentsClientCheckNameAvailabilityOptions added in v0.2.0 

type KustoPoolDatabasePrincipalAssignmentsClientCheckNameAvailabilityOptions struct {
}

KustoPoolDatabasePrincipalAssignmentsClientCheckNameAvailabilityOptions contains the optional parameters for the KustoPoolDatabasePrincipalAssignmentsClient.CheckNameAvailability method.

type KustoPoolDatabasePrincipalAssignmentsClientCheckNameAvailabilityResponse added in v0.2.0 

type KustoPoolDatabasePrincipalAssignmentsClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

KustoPoolDatabasePrincipalAssignmentsClientCheckNameAvailabilityResponse contains the response from method KustoPoolDatabasePrincipalAssignmentsClient.CheckNameAvailability.

type KustoPoolDatabasePrincipalAssignmentsClientCreateOrUpdateResponse added in v0.2.0 

type KustoPoolDatabasePrincipalAssignmentsClientCreateOrUpdateResponse struct {
	// Class representing a database principal assignment.
	DatabasePrincipalAssignment
}

KustoPoolDatabasePrincipalAssignmentsClientCreateOrUpdateResponse contains the response from method KustoPoolDatabasePrincipalAssignmentsClient.BeginCreateOrUpdate.

type KustoPoolDatabasePrincipalAssignmentsClientDeleteResponse added in v0.2.0 

type KustoPoolDatabasePrincipalAssignmentsClientDeleteResponse struct {
}

KustoPoolDatabasePrincipalAssignmentsClientDeleteResponse contains the response from method KustoPoolDatabasePrincipalAssignmentsClient.BeginDelete.

type KustoPoolDatabasePrincipalAssignmentsClientGetOptions added in v0.2.0 

type KustoPoolDatabasePrincipalAssignmentsClientGetOptions struct {
}

KustoPoolDatabasePrincipalAssignmentsClientGetOptions contains the optional parameters for the KustoPoolDatabasePrincipalAssignmentsClient.Get method.

type KustoPoolDatabasePrincipalAssignmentsClientGetResponse added in v0.2.0 

type KustoPoolDatabasePrincipalAssignmentsClientGetResponse struct {
	// Class representing a database principal assignment.
	DatabasePrincipalAssignment
}

KustoPoolDatabasePrincipalAssignmentsClientGetResponse contains the response from method KustoPoolDatabasePrincipalAssignmentsClient.Get.

type KustoPoolDatabasePrincipalAssignmentsClientListOptions added in v0.2.0 

type KustoPoolDatabasePrincipalAssignmentsClientListOptions struct {
}

KustoPoolDatabasePrincipalAssignmentsClientListOptions contains the optional parameters for the KustoPoolDatabasePrincipalAssignmentsClient.NewListPager method.

type KustoPoolDatabasePrincipalAssignmentsClientListResponse added in v0.2.0 

type KustoPoolDatabasePrincipalAssignmentsClientListResponse struct {
	// The list Kusto database principal assignments operation response.
	DatabasePrincipalAssignmentListResult
}

KustoPoolDatabasePrincipalAssignmentsClientListResponse contains the response from method KustoPoolDatabasePrincipalAssignmentsClient.NewListPager.

type KustoPoolDatabasesClient 

type KustoPoolDatabasesClient struct {
	// contains filtered or unexported fields
}

KustoPoolDatabasesClient contains the methods for the KustoPoolDatabases group. Don't use this type directly, use NewKustoPoolDatabasesClient() instead.

func NewKustoPoolDatabasesClient 

func NewKustoPoolDatabasesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*KustoPoolDatabasesClient, error)

NewKustoPoolDatabasesClient creates a new instance of KustoPoolDatabasesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*KustoPoolDatabasesClient) BeginCreateOrUpdate 

func (client *KustoPoolDatabasesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, kustoPoolName string, databaseName string, parameters DatabaseClassification, options *KustoPoolDatabasesClientBeginCreateOrUpdateOptions) (*runtime.Poller[KustoPoolDatabasesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a database. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • parameters - The database parameters supplied to the CreateOrUpdate operation.
  • options - KustoPoolDatabasesClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolDatabasesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDatabasesCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolDatabasesClient().BeginCreateOrUpdate(ctx, "kustorptest", "synapseWorkspaceName", "kustoclusterrptest4", "KustoDatabase8", &armsynapse.ReadWriteDatabase{
		Kind:     to.Ptr(armsynapse.KindReadWrite),
		Location: to.Ptr("westus"),
		Properties: &armsynapse.ReadWriteDatabaseProperties{
			SoftDeletePeriod: to.Ptr("P1D"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsynapse.KustoPoolDatabasesClientCreateOrUpdateResponse{
	// 	                            DatabaseClassification: &armsynapse.ReadWriteDatabase{
	// 		Name: to.Ptr("KustoClusterRPTest4/KustoDatabase8"),
	// 		Type: to.Ptr("Microsoft.Synapse/workspaces/kustopools/Databases"),
	// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustopools/KustoClusterRPTest4/Databases/KustoDatabase8"),
	// 		Kind: to.Ptr(armsynapse.KindReadWrite),
	// 		Location: to.Ptr("westus"),
	// 		Properties: &armsynapse.ReadWriteDatabaseProperties{
	// 			ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 			SoftDeletePeriod: to.Ptr("P1D"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*KustoPoolDatabasesClient) BeginDelete 

func (client *KustoPoolDatabasesClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, kustoPoolName string, databaseName string, options *KustoPoolDatabasesClientBeginDeleteOptions) (*runtime.Poller[KustoPoolDatabasesClientDeleteResponse], error)

BeginDelete - Deletes the database with the given name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • options - KustoPoolDatabasesClientBeginDeleteOptions contains the optional parameters for the KustoPoolDatabasesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDatabasesDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolDatabasesClient().BeginDelete(ctx, "kustorptest", "synapseWorkspaceName", "kustoclusterrptest4", "KustoDatabase8", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KustoPoolDatabasesClient) BeginUpdate 

func (client *KustoPoolDatabasesClient) BeginUpdate(ctx context.Context, resourceGroupName string, workspaceName string, kustoPoolName string, databaseName string, parameters DatabaseClassification, options *KustoPoolDatabasesClientBeginUpdateOptions) (*runtime.Poller[KustoPoolDatabasesClientUpdateResponse], error)

BeginUpdate - Updates a database. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • parameters - The database parameters supplied to the Update operation.
  • options - KustoPoolDatabasesClientBeginUpdateOptions contains the optional parameters for the KustoPoolDatabasesClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDatabasesUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolDatabasesClient().BeginUpdate(ctx, "kustorptest", "synapseWorkspaceName", "kustoclusterrptest4", "KustoDatabase8", &armsynapse.ReadWriteDatabase{
		Kind: to.Ptr(armsynapse.KindReadWrite),
		Properties: &armsynapse.ReadWriteDatabaseProperties{
			SoftDeletePeriod: to.Ptr("P1D"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsynapse.KustoPoolDatabasesClientUpdateResponse{
	// 	                            DatabaseClassification: &armsynapse.ReadWriteDatabase{
	// 		Name: to.Ptr("KustoClusterRPTest4/KustoDatabase8"),
	// 		Type: to.Ptr("Microsoft.Synapse/workspaces/kustopools/Databases"),
	// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustopools/KustoClusterRPTest4/Databases/KustoDatabase8"),
	// 		Kind: to.Ptr(armsynapse.KindReadWrite),
	// 		Location: to.Ptr("westus"),
	// 		Properties: &armsynapse.ReadWriteDatabaseProperties{
	// 			ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 			SoftDeletePeriod: to.Ptr("P1D"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*KustoPoolDatabasesClient) Get 

func (client *KustoPoolDatabasesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, kustoPoolName string, databaseName string, options *KustoPoolDatabasesClientGetOptions) (KustoPoolDatabasesClientGetResponse, error)

Get - Returns a database. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • databaseName - The name of the database in the Kusto pool.
  • options - KustoPoolDatabasesClientGetOptions contains the optional parameters for the KustoPoolDatabasesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolDatabasesGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolDatabasesClient().Get(ctx, "kustorptest", "synapseWorkspaceName", "kustoclusterrptest4", "KustoDatabase8", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsynapse.KustoPoolDatabasesClientGetResponse{
	// 	                            DatabaseClassification: &armsynapse.ReadWriteDatabase{
	// 		Name: to.Ptr("KustoClusterRPTest4/KustoDatabase8"),
	// 		Type: to.Ptr("Microsoft.Synapse/workspaces/kustopools/Databases"),
	// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustopools/KustoClusterRPTest4/Databases/KustoDatabase8"),
	// 		Kind: to.Ptr(armsynapse.KindReadWrite),
	// 		Location: to.Ptr("westus"),
	// 		Properties: &armsynapse.ReadWriteDatabaseProperties{
	// 			ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 			SoftDeletePeriod: to.Ptr("P1D"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*KustoPoolDatabasesClient) NewListByKustoPoolPager added in v0.4.0 

func (client *KustoPoolDatabasesClient) NewListByKustoPoolPager(resourceGroupName string, workspaceName string, kustoPoolName string, options *KustoPoolDatabasesClientListByKustoPoolOptions) *runtime.Pager[KustoPoolDatabasesClientListByKustoPoolResponse]

NewListByKustoPoolPager - Returns the list of databases of the given Kusto pool.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • options - KustoPoolDatabasesClientListByKustoPoolOptions contains the optional parameters for the KustoPoolDatabasesClient.NewListByKustoPoolPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoDatabasesListByKustoPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKustoPoolDatabasesClient().NewListByKustoPoolPager("kustorptest", "synapseWorkspaceName", "kustoclusterrptest4", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DatabaseListResult = armsynapse.DatabaseListResult{
		// 	Value: []armsynapse.DatabaseClassification{
		// 		&armsynapse.ReadWriteDatabase{
		// 			Name: to.Ptr("KustoClusterRPTest4/KustoDatabase8"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/kustopools/Databases"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/kustorptest/kustopools/KustoClusterRPTest4/Databases/KustoDatabase8"),
		// 			Kind: to.Ptr(armsynapse.KindReadWrite),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armsynapse.ReadWriteDatabaseProperties{
		// 				ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
		// 				SoftDeletePeriod: to.Ptr("P1D"),
		// 			},
		// 		},
		// 		&armsynapse.ReadWriteDatabase{
		// 			Name: to.Ptr("KustoClusterRPTest4/KustoDatabase9"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/kustopools/Databases"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/kustorptest/kustopools/KustoClusterRPTest4/Databases/KustoDatabase9"),
		// 			Kind: to.Ptr(armsynapse.KindReadWrite),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armsynapse.ReadWriteDatabaseProperties{
		// 				ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
		// 				SoftDeletePeriod: to.Ptr("P1D"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type KustoPoolDatabasesClientBeginCreateOrUpdateOptions added in v0.2.0 

type KustoPoolDatabasesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolDatabasesClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolDatabasesClient.BeginCreateOrUpdate method.

type KustoPoolDatabasesClientBeginDeleteOptions added in v0.2.0 

type KustoPoolDatabasesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolDatabasesClientBeginDeleteOptions contains the optional parameters for the KustoPoolDatabasesClient.BeginDelete method.

type KustoPoolDatabasesClientBeginUpdateOptions added in v0.2.0 

type KustoPoolDatabasesClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolDatabasesClientBeginUpdateOptions contains the optional parameters for the KustoPoolDatabasesClient.BeginUpdate method.

type KustoPoolDatabasesClientCreateOrUpdateResponse added in v0.2.0 

type KustoPoolDatabasesClientCreateOrUpdateResponse struct {
	// Class representing a Kusto database.
	DatabaseClassification
}

KustoPoolDatabasesClientCreateOrUpdateResponse contains the response from method KustoPoolDatabasesClient.BeginCreateOrUpdate.

func (KustoPoolDatabasesClientCreateOrUpdateResponse) MarshalJSON added in v0.8.0 

func (k KustoPoolDatabasesClientCreateOrUpdateResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustoPoolDatabasesClientCreateOrUpdateResponse.

func (*KustoPoolDatabasesClientCreateOrUpdateResponse) UnmarshalJSON added in v0.3.0 

func (k *KustoPoolDatabasesClientCreateOrUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPoolDatabasesClientCreateOrUpdateResponse.

type KustoPoolDatabasesClientDeleteResponse added in v0.2.0 

type KustoPoolDatabasesClientDeleteResponse struct {
}

KustoPoolDatabasesClientDeleteResponse contains the response from method KustoPoolDatabasesClient.BeginDelete.

type KustoPoolDatabasesClientGetOptions added in v0.2.0 

type KustoPoolDatabasesClientGetOptions struct {
}

KustoPoolDatabasesClientGetOptions contains the optional parameters for the KustoPoolDatabasesClient.Get method.

type KustoPoolDatabasesClientGetResponse added in v0.2.0 

type KustoPoolDatabasesClientGetResponse struct {
	// Class representing a Kusto database.
	DatabaseClassification
}

KustoPoolDatabasesClientGetResponse contains the response from method KustoPoolDatabasesClient.Get.

func (*KustoPoolDatabasesClientGetResponse) UnmarshalJSON added in v0.3.0 

func (k *KustoPoolDatabasesClientGetResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPoolDatabasesClientGetResponse.

type KustoPoolDatabasesClientListByKustoPoolOptions added in v0.2.0 

type KustoPoolDatabasesClientListByKustoPoolOptions struct {
}

KustoPoolDatabasesClientListByKustoPoolOptions contains the optional parameters for the KustoPoolDatabasesClient.NewListByKustoPoolPager method.

type KustoPoolDatabasesClientListByKustoPoolResponse added in v0.2.0 

type KustoPoolDatabasesClientListByKustoPoolResponse struct {
	// The list Kusto databases operation response.
	DatabaseListResult
}

KustoPoolDatabasesClientListByKustoPoolResponse contains the response from method KustoPoolDatabasesClient.NewListByKustoPoolPager.

type KustoPoolDatabasesClientUpdateResponse added in v0.2.0 

type KustoPoolDatabasesClientUpdateResponse struct {
	// Class representing a Kusto database.
	DatabaseClassification
}

KustoPoolDatabasesClientUpdateResponse contains the response from method KustoPoolDatabasesClient.BeginUpdate.

func (KustoPoolDatabasesClientUpdateResponse) MarshalJSON added in v0.8.0 

func (k KustoPoolDatabasesClientUpdateResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustoPoolDatabasesClientUpdateResponse.

func (*KustoPoolDatabasesClientUpdateResponse) UnmarshalJSON added in v0.3.0 

func (k *KustoPoolDatabasesClientUpdateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPoolDatabasesClientUpdateResponse.

type KustoPoolListResult 

type KustoPoolListResult struct {
	// The list of Kusto pools.
	Value []*KustoPool
}

KustoPoolListResult - The list Kusto pools operation response.

func (KustoPoolListResult) MarshalJSON 

func (k KustoPoolListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustoPoolListResult.

func (*KustoPoolListResult) UnmarshalJSON added in v0.6.0 

func (k *KustoPoolListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPoolListResult.

type KustoPoolPrincipalAssignmentsClient 

type KustoPoolPrincipalAssignmentsClient struct {
	// contains filtered or unexported fields
}

KustoPoolPrincipalAssignmentsClient contains the methods for the KustoPoolPrincipalAssignments group. Don't use this type directly, use NewKustoPoolPrincipalAssignmentsClient() instead.

func NewKustoPoolPrincipalAssignmentsClient 

func NewKustoPoolPrincipalAssignmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*KustoPoolPrincipalAssignmentsClient, error)

NewKustoPoolPrincipalAssignmentsClient creates a new instance of KustoPoolPrincipalAssignmentsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*KustoPoolPrincipalAssignmentsClient) BeginCreateOrUpdate 

func (client *KustoPoolPrincipalAssignmentsClient) BeginCreateOrUpdate(ctx context.Context, workspaceName string, kustoPoolName string, principalAssignmentName string, resourceGroupName string, parameters ClusterPrincipalAssignment, options *KustoPoolPrincipalAssignmentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[KustoPoolPrincipalAssignmentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a Kusto pool principalAssignment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • parameters - The Kusto pool principalAssignment's parameters supplied for the operation.
  • options - KustoPoolPrincipalAssignmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolPrincipalAssignmentsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolPrincipalAssignmentsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolPrincipalAssignmentsClient().BeginCreateOrUpdate(ctx, "synapseWorkspaceName", "kustoclusterrptest4", "kustoprincipal1", "kustorptest", armsynapse.ClusterPrincipalAssignment{
		Properties: &armsynapse.ClusterPrincipalProperties{
			PrincipalID:   to.Ptr("87654321-1234-1234-1234-123456789123"),
			PrincipalType: to.Ptr(armsynapse.PrincipalTypeApp),
			Role:          to.Ptr(armsynapse.ClusterPrincipalRoleAllDatabasesAdmin),
			TenantID:      to.Ptr("12345678-1234-1234-1234-123456789123"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ClusterPrincipalAssignment = armsynapse.ClusterPrincipalAssignment{
	// 	Name: to.Ptr("synapseWorkspaceName/kustoclusterrptest4/kustoprincipal1"),
	// 	Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/PrincipalAssignments"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustoPools/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1"),
	// 	Properties: &armsynapse.ClusterPrincipalProperties{
	// 		AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
	// 		PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
	// 		PrincipalName: to.Ptr("TestApp"),
	// 		PrincipalType: to.Ptr(armsynapse.PrincipalTypeApp),
	// 		ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 		Role: to.Ptr(armsynapse.ClusterPrincipalRole("Admin")),
	// 		TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
	// 		TenantName: to.Ptr("tenantName"),
	// 	},
	// }
}

Output:

func (*KustoPoolPrincipalAssignmentsClient) BeginDelete 

func (client *KustoPoolPrincipalAssignmentsClient) BeginDelete(ctx context.Context, workspaceName string, kustoPoolName string, principalAssignmentName string, resourceGroupName string, options *KustoPoolPrincipalAssignmentsClientBeginDeleteOptions) (*runtime.Poller[KustoPoolPrincipalAssignmentsClientDeleteResponse], error)

BeginDelete - Deletes a Kusto pool principalAssignment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolPrincipalAssignmentsClientBeginDeleteOptions contains the optional parameters for the KustoPoolPrincipalAssignmentsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolPrincipalAssignmentsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolPrincipalAssignmentsClient().BeginDelete(ctx, "synapseWorkspaceName", "kustoclusterrptest4", "kustoprincipal1", "kustorptest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KustoPoolPrincipalAssignmentsClient) CheckNameAvailability 

func (client *KustoPoolPrincipalAssignmentsClient) CheckNameAvailability(ctx context.Context, workspaceName string, kustoPoolName string, resourceGroupName string, principalAssignmentName ClusterPrincipalAssignmentCheckNameRequest, options *KustoPoolPrincipalAssignmentsClientCheckNameAvailabilityOptions) (KustoPoolPrincipalAssignmentsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the principal assignment name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • principalAssignmentName - The name of the principal assignment.
  • options - KustoPoolPrincipalAssignmentsClientCheckNameAvailabilityOptions contains the optional parameters for the KustoPoolPrincipalAssignmentsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolPrincipalAssignmentsCheckNameAvailability.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolPrincipalAssignmentsClient().CheckNameAvailability(ctx, "synapseWorkspaceName", "kustoclusterrptest4", "kustorptest", armsynapse.ClusterPrincipalAssignmentCheckNameRequest{
		Name: to.Ptr("kustoprincipal1"),
		Type: to.Ptr("Microsoft.Synapse/workspaces/kustoPools/principalAssignments"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameResult = armsynapse.CheckNameResult{
	// 	Name: to.Ptr("kustoprincipal1"),
	// 	Message: to.Ptr("Name 'kustoprincipal1' is already taken. Please specify a different name"),
	// 	NameAvailable: to.Ptr(false),
	// }
}

Output:

func (*KustoPoolPrincipalAssignmentsClient) Get 

func (client *KustoPoolPrincipalAssignmentsClient) Get(ctx context.Context, workspaceName string, kustoPoolName string, principalAssignmentName string, resourceGroupName string, options *KustoPoolPrincipalAssignmentsClientGetOptions) (KustoPoolPrincipalAssignmentsClientGetResponse, error)

Get - Gets a Kusto pool principalAssignment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolPrincipalAssignmentsClientGetOptions contains the optional parameters for the KustoPoolPrincipalAssignmentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolPrincipalAssignmentsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolPrincipalAssignmentsClient().Get(ctx, "synapseWorkspaceName", "kustoclusterrptest4", "kustoprincipal1", "kustorptest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ClusterPrincipalAssignment = armsynapse.ClusterPrincipalAssignment{
	// 	Name: to.Ptr("synapseWorkspaceName/kustoclusterrptest4/kustoprincipal1"),
	// 	Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/PrincipalAssignments"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustoPools/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1"),
	// 	Properties: &armsynapse.ClusterPrincipalProperties{
	// 		AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
	// 		PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
	// 		PrincipalName: to.Ptr("TestApp"),
	// 		PrincipalType: to.Ptr(armsynapse.PrincipalTypeApp),
	// 		ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 		Role: to.Ptr(armsynapse.ClusterPrincipalRole("Admin")),
	// 		TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
	// 		TenantName: to.Ptr("tenantName"),
	// 	},
	// }
}

Output:

func (*KustoPoolPrincipalAssignmentsClient) NewListPager added in v0.4.0 

func (client *KustoPoolPrincipalAssignmentsClient) NewListPager(workspaceName string, kustoPoolName string, resourceGroupName string, options *KustoPoolPrincipalAssignmentsClientListOptions) *runtime.Pager[KustoPoolPrincipalAssignmentsClientListResponse]

NewListPager - Lists all Kusto pool principalAssignments.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolPrincipalAssignmentsClientListOptions contains the optional parameters for the KustoPoolPrincipalAssignmentsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolPrincipalAssignmentsList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKustoPoolPrincipalAssignmentsClient().NewListPager("synapseWorkspaceName", "kustoclusterrptest4", "kustorptest", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ClusterPrincipalAssignmentListResult = armsynapse.ClusterPrincipalAssignmentListResult{
		// 	Value: []*armsynapse.ClusterPrincipalAssignment{
		// 		{
		// 			Name: to.Ptr("synapseWorkspaceName/kustoclusterrptest4/kustoprincipal1"),
		// 			Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/PrincipalAssignments"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustoPools/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1"),
		// 			Properties: &armsynapse.ClusterPrincipalProperties{
		// 				AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
		// 				PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
		// 				PrincipalName: to.Ptr("TestApp"),
		// 				PrincipalType: to.Ptr(armsynapse.PrincipalTypeApp),
		// 				ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
		// 				Role: to.Ptr(armsynapse.ClusterPrincipalRole("Admin")),
		// 				TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
		// 				TenantName: to.Ptr("tenantName"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("synapseWorkspaceName/kustoclusterrptest4/kustoprincipal2"),
		// 			Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/PrincipalAssignments"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustoPools/kustoclusterrptest4/PrincipalAssignments/kustoprincipal2"),
		// 			Properties: &armsynapse.ClusterPrincipalProperties{
		// 				AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
		// 				PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
		// 				PrincipalName: to.Ptr("TestApp"),
		// 				PrincipalType: to.Ptr(armsynapse.PrincipalTypeApp),
		// 				ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
		// 				Role: to.Ptr(armsynapse.ClusterPrincipalRole("Admin")),
		// 				TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
		// 				TenantName: to.Ptr("tenantName"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type KustoPoolPrincipalAssignmentsClientBeginCreateOrUpdateOptions added in v0.2.0 

type KustoPoolPrincipalAssignmentsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolPrincipalAssignmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolPrincipalAssignmentsClient.BeginCreateOrUpdate method.

type KustoPoolPrincipalAssignmentsClientBeginDeleteOptions added in v0.2.0 

type KustoPoolPrincipalAssignmentsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolPrincipalAssignmentsClientBeginDeleteOptions contains the optional parameters for the KustoPoolPrincipalAssignmentsClient.BeginDelete method.

type KustoPoolPrincipalAssignmentsClientCheckNameAvailabilityOptions added in v0.2.0 

type KustoPoolPrincipalAssignmentsClientCheckNameAvailabilityOptions struct {
}

KustoPoolPrincipalAssignmentsClientCheckNameAvailabilityOptions contains the optional parameters for the KustoPoolPrincipalAssignmentsClient.CheckNameAvailability method.

type KustoPoolPrincipalAssignmentsClientCheckNameAvailabilityResponse added in v0.2.0 

type KustoPoolPrincipalAssignmentsClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

KustoPoolPrincipalAssignmentsClientCheckNameAvailabilityResponse contains the response from method KustoPoolPrincipalAssignmentsClient.CheckNameAvailability.

type KustoPoolPrincipalAssignmentsClientCreateOrUpdateResponse added in v0.2.0 

type KustoPoolPrincipalAssignmentsClientCreateOrUpdateResponse struct {
	// Class representing a cluster principal assignment.
	ClusterPrincipalAssignment
}

KustoPoolPrincipalAssignmentsClientCreateOrUpdateResponse contains the response from method KustoPoolPrincipalAssignmentsClient.BeginCreateOrUpdate.

type KustoPoolPrincipalAssignmentsClientDeleteResponse added in v0.2.0 

type KustoPoolPrincipalAssignmentsClientDeleteResponse struct {
}

KustoPoolPrincipalAssignmentsClientDeleteResponse contains the response from method KustoPoolPrincipalAssignmentsClient.BeginDelete.

type KustoPoolPrincipalAssignmentsClientGetOptions added in v0.2.0 

type KustoPoolPrincipalAssignmentsClientGetOptions struct {
}

KustoPoolPrincipalAssignmentsClientGetOptions contains the optional parameters for the KustoPoolPrincipalAssignmentsClient.Get method.

type KustoPoolPrincipalAssignmentsClientGetResponse added in v0.2.0 

type KustoPoolPrincipalAssignmentsClientGetResponse struct {
	// Class representing a cluster principal assignment.
	ClusterPrincipalAssignment
}

KustoPoolPrincipalAssignmentsClientGetResponse contains the response from method KustoPoolPrincipalAssignmentsClient.Get.

type KustoPoolPrincipalAssignmentsClientListOptions added in v0.2.0 

type KustoPoolPrincipalAssignmentsClientListOptions struct {
}

KustoPoolPrincipalAssignmentsClientListOptions contains the optional parameters for the KustoPoolPrincipalAssignmentsClient.NewListPager method.

type KustoPoolPrincipalAssignmentsClientListResponse added in v0.2.0 

type KustoPoolPrincipalAssignmentsClientListResponse struct {
	// The list Kusto cluster principal assignments operation response.
	ClusterPrincipalAssignmentListResult
}

KustoPoolPrincipalAssignmentsClientListResponse contains the response from method KustoPoolPrincipalAssignmentsClient.NewListPager.

type KustoPoolPrivateLinkResources added in v0.6.0 

type KustoPoolPrivateLinkResources struct {
	// The Private Link Resources.
	Properties *PrivateLinkResourcesProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

KustoPoolPrivateLinkResources - Class representing a Private Link Resources.

func (KustoPoolPrivateLinkResources) MarshalJSON added in v0.6.0 

func (k KustoPoolPrivateLinkResources) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustoPoolPrivateLinkResources.

func (*KustoPoolPrivateLinkResources) UnmarshalJSON added in v0.6.0 

func (k *KustoPoolPrivateLinkResources) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPoolPrivateLinkResources.

type KustoPoolPrivateLinkResourcesClient added in v0.6.0 

type KustoPoolPrivateLinkResourcesClient struct {
	// contains filtered or unexported fields
}

KustoPoolPrivateLinkResourcesClient contains the methods for the KustoPoolPrivateLinkResources group. Don't use this type directly, use NewKustoPoolPrivateLinkResourcesClient() instead.

func NewKustoPoolPrivateLinkResourcesClient added in v0.6.0 

func NewKustoPoolPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*KustoPoolPrivateLinkResourcesClient, error)

NewKustoPoolPrivateLinkResourcesClient creates a new instance of KustoPoolPrivateLinkResourcesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*KustoPoolPrivateLinkResourcesClient) NewListPager added in v0.6.0 

func (client *KustoPoolPrivateLinkResourcesClient) NewListPager(resourceGroupName string, workspaceName string, kustoPoolName string, options *KustoPoolPrivateLinkResourcesClientListOptions) *runtime.Pager[KustoPoolPrivateLinkResourcesClientListResponse]

NewListPager - Lists all Kusto pool PrivateLinkResources.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • options - KustoPoolPrivateLinkResourcesClientListOptions contains the optional parameters for the KustoPoolPrivateLinkResourcesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolPrivateLinkResourcesList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKustoPoolPrivateLinkResourcesClient().NewListPager("DP-900", "synapse-ws-ebi-data", "dataexplorerpool900", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateLinkResources = armsynapse.PrivateLinkResources{
		// 	Value: []*armsynapse.KustoPoolPrivateLinkResources{
		// 		{
		// 			Name: to.Ptr("synapseWorkspaceName/dataexplorerpool900/privateLinkResources"),
		// 			Type: to.Ptr("Microsoft.Synapse/Workspaces/KustoPools/privateLinkResources"),
		// 			ID: to.Ptr("/subscriptions/7a587823-959d-4ad0-85bd-cf2a7cef436a/resourceGroups/DP-900/providers/Microsoft.Synapse/workspaces/synapse-ws-ebi-data/kustoPools/dataexplorerpool900/privateLinkResources"),
		// 			Properties: &armsynapse.PrivateLinkResourcesProperties{
		// 				GroupID: to.Ptr("aaaaa"),
		// 				ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
		// 				RequiredMembers: []*string{
		// 					to.Ptr("Engine"),
		// 					to.Ptr("DataManagement"),
		// 					to.Ptr("blob-ne3kstrldkustoCluster00"),
		// 					to.Ptr("queue-ne3kstrldkustoCluster00"),
		// 					to.Ptr("table-ne3kstrldkustoCluster00"),
		// 					to.Ptr("blob-qmukstrldkustoCluster01"),
		// 					to.Ptr("queue-qmukstrldkustoCluster01"),
		// 					to.Ptr("table-qmukstrldkustoCluster01")},
		// 					RequiredZoneNames: []*string{
		// 						to.Ptr("privatelink.westus2.kusto.windows.net"),
		// 						to.Ptr("privatelink.blob.core.windows.net"),
		// 						to.Ptr("privatelink.queue.core.windows.net"),
		// 						to.Ptr("privatelink.table.core.windows.net")},
		// 					},
		// 			}},
		// 		}
	}
}

Output:

type KustoPoolPrivateLinkResourcesClientListOptions added in v0.6.0 

type KustoPoolPrivateLinkResourcesClientListOptions struct {
}

KustoPoolPrivateLinkResourcesClientListOptions contains the optional parameters for the KustoPoolPrivateLinkResourcesClient.NewListPager method.

type KustoPoolPrivateLinkResourcesClientListResponse added in v0.6.0 

type KustoPoolPrivateLinkResourcesClientListResponse struct {
	// The list Kusto Private Link Resources operation response.
	PrivateLinkResources
}

KustoPoolPrivateLinkResourcesClientListResponse contains the response from method KustoPoolPrivateLinkResourcesClient.NewListPager.

type KustoPoolProperties 

type KustoPoolProperties struct {
	// A boolean value that indicates if the purge operations are enabled.
	EnablePurge *bool

	// A boolean value that indicates if the streaming ingest is enabled.
	EnableStreamingIngest *bool

	// Optimized auto scale definition.
	OptimizedAutoscale *OptimizedAutoscale

	// The workspace unique identifier.
	WorkspaceUID *string

	// READ-ONLY; The Kusto Pool data ingestion URI.
	DataIngestionURI *string

	// READ-ONLY; List of the Kusto Pool's language extensions.
	LanguageExtensions *LanguageExtensionsList

	// READ-ONLY; The provisioned state of the resource.
	ProvisioningState *ResourceProvisioningState

	// READ-ONLY; The state of the resource.
	State *State

	// READ-ONLY; The reason for the Kusto Pool's current state.
	StateReason *string

	// READ-ONLY; The Kusto Pool URI.
	URI *string
}

KustoPoolProperties - Class representing the Kusto pool properties.

func (KustoPoolProperties) MarshalJSON added in v0.6.0 

func (k KustoPoolProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustoPoolProperties.

func (*KustoPoolProperties) UnmarshalJSON added in v0.6.0 

func (k *KustoPoolProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPoolProperties.

type KustoPoolUpdate 

type KustoPoolUpdate struct {
	// The kusto pool properties.
	Properties *KustoPoolProperties

	// The SKU of the kusto pool.
	SKU *AzureSKU

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

KustoPoolUpdate - Class representing an update to a Kusto kusto pool.

func (KustoPoolUpdate) MarshalJSON 

func (k KustoPoolUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustoPoolUpdate.

func (*KustoPoolUpdate) UnmarshalJSON 

func (k *KustoPoolUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KustoPoolUpdate.

type KustoPoolsClient 

type KustoPoolsClient struct {
	// contains filtered or unexported fields
}

KustoPoolsClient contains the methods for the KustoPools group. Don't use this type directly, use NewKustoPoolsClient() instead.

func NewKustoPoolsClient 

func NewKustoPoolsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*KustoPoolsClient, error)

NewKustoPoolsClient creates a new instance of KustoPoolsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*KustoPoolsClient) BeginAddLanguageExtensions 

func (client *KustoPoolsClient) BeginAddLanguageExtensions(ctx context.Context, workspaceName string, kustoPoolName string, resourceGroupName string, languageExtensionsToAdd LanguageExtensionsList, options *KustoPoolsClientBeginAddLanguageExtensionsOptions) (*runtime.Poller[KustoPoolsClientAddLanguageExtensionsResponse], error)

BeginAddLanguageExtensions - Add a list of language extensions that can run within KQL queries. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • languageExtensionsToAdd - The language extensions to add.
  • options - KustoPoolsClientBeginAddLanguageExtensionsOptions contains the optional parameters for the KustoPoolsClient.BeginAddLanguageExtensions method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolLanguageExtensionsAdd.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolsClient().BeginAddLanguageExtensions(ctx, "kustorptest", "kustoclusterrptest4", "kustorptest", armsynapse.LanguageExtensionsList{
		Value: []*armsynapse.LanguageExtension{
			{
				LanguageExtensionName: to.Ptr(armsynapse.LanguageExtensionNamePYTHON),
			},
			{
				LanguageExtensionName: to.Ptr(armsynapse.LanguageExtensionNameR),
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KustoPoolsClient) BeginCreateOrUpdate 

func (client *KustoPoolsClient) BeginCreateOrUpdate(ctx context.Context, workspaceName string, resourceGroupName string, kustoPoolName string, parameters KustoPool, options *KustoPoolsClientBeginCreateOrUpdateOptions) (*runtime.Poller[KustoPoolsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a Kusto pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • kustoPoolName - The name of the Kusto pool.
  • parameters - The Kusto pool parameters supplied to the CreateOrUpdate operation.
  • options - KustoPoolsClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolsCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolsClient().BeginCreateOrUpdate(ctx, "synapseWorkspaceName", "kustorptest", "kustoclusterrptest4", armsynapse.KustoPool{
		Location: to.Ptr("westus"),
		Properties: &armsynapse.KustoPoolProperties{
			EnablePurge:           to.Ptr(true),
			EnableStreamingIngest: to.Ptr(true),
			WorkspaceUID:          to.Ptr("11111111-2222-3333-444444444444"),
		},
		SKU: &armsynapse.AzureSKU{
			Name:     to.Ptr(armsynapse.SKUNameStorageOptimized),
			Capacity: to.Ptr[int32](2),
			Size:     to.Ptr(armsynapse.SKUSizeMedium),
		},
	}, &armsynapse.KustoPoolsClientBeginCreateOrUpdateOptions{IfMatch: nil,
		IfNoneMatch: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.KustoPool = armsynapse.KustoPool{
	// 	Name: to.Ptr("KustoClusterRPTest4"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/kustopools"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustopools/KustoClusterRPTest4"),
	// 	Location: to.Ptr("westus"),
	// 	Etag: to.Ptr("abcd"),
	// 	Properties: &armsynapse.KustoPoolProperties{
	// 		EnablePurge: to.Ptr(true),
	// 		EnableStreamingIngest: to.Ptr(true),
	// 		ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 	},
	// 	SKU: &armsynapse.AzureSKU{
	// 		Name: to.Ptr(armsynapse.SKUNameStorageOptimized),
	// 		Capacity: to.Ptr[int32](2),
	// 		Size: to.Ptr(armsynapse.SKUSizeMedium),
	// 	},
	// }
}

Output:

func (*KustoPoolsClient) BeginDelete 

func (client *KustoPoolsClient) BeginDelete(ctx context.Context, workspaceName string, resourceGroupName string, kustoPoolName string, options *KustoPoolsClientBeginDeleteOptions) (*runtime.Poller[KustoPoolsClientDeleteResponse], error)

BeginDelete - Deletes a Kusto pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • kustoPoolName - The name of the Kusto pool.
  • options - KustoPoolsClientBeginDeleteOptions contains the optional parameters for the KustoPoolsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolsClient().BeginDelete(ctx, "kustorptest", "kustorptest", "kustoclusterrptest4", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KustoPoolsClient) BeginDetachFollowerDatabases 

func (client *KustoPoolsClient) BeginDetachFollowerDatabases(ctx context.Context, workspaceName string, kustoPoolName string, resourceGroupName string, followerDatabaseToRemove FollowerDatabaseDefinition, options *KustoPoolsClientBeginDetachFollowerDatabasesOptions) (*runtime.Poller[KustoPoolsClientDetachFollowerDatabasesResponse], error)

BeginDetachFollowerDatabases - Detaches all followers of a database owned by this Kusto Pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • followerDatabaseToRemove - The follower databases properties to remove.
  • options - KustoPoolsClientBeginDetachFollowerDatabasesOptions contains the optional parameters for the KustoPoolsClient.BeginDetachFollowerDatabases method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolFollowerDatabasesDetach.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolsClient().BeginDetachFollowerDatabases(ctx, "kustorptest", "kustoclusterrptest4", "kustorptest", armsynapse.FollowerDatabaseDefinition{
		AttachedDatabaseConfigurationName: to.Ptr("myAttachedDatabaseConfiguration"),
		KustoPoolResourceID:               to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/kustorptest/kustoPools/leader4"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KustoPoolsClient) BeginRemoveLanguageExtensions 

func (client *KustoPoolsClient) BeginRemoveLanguageExtensions(ctx context.Context, workspaceName string, kustoPoolName string, resourceGroupName string, languageExtensionsToRemove LanguageExtensionsList, options *KustoPoolsClientBeginRemoveLanguageExtensionsOptions) (*runtime.Poller[KustoPoolsClientRemoveLanguageExtensionsResponse], error)

BeginRemoveLanguageExtensions - Remove a list of language extensions that can run within KQL queries. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • languageExtensionsToRemove - The language extensions to remove.
  • options - KustoPoolsClientBeginRemoveLanguageExtensionsOptions contains the optional parameters for the KustoPoolsClient.BeginRemoveLanguageExtensions method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolLanguageExtensionsRemove.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolsClient().BeginRemoveLanguageExtensions(ctx, "kustorptest", "kustoclusterrptest4", "kustorptest", armsynapse.LanguageExtensionsList{
		Value: []*armsynapse.LanguageExtension{
			{
				LanguageExtensionName: to.Ptr(armsynapse.LanguageExtensionNamePYTHON),
			},
			{
				LanguageExtensionName: to.Ptr(armsynapse.LanguageExtensionNameR),
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KustoPoolsClient) BeginStart 

func (client *KustoPoolsClient) BeginStart(ctx context.Context, workspaceName string, kustoPoolName string, resourceGroupName string, options *KustoPoolsClientBeginStartOptions) (*runtime.Poller[KustoPoolsClientStartResponse], error)

BeginStart - Starts a Kusto pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolsClientBeginStartOptions contains the optional parameters for the KustoPoolsClient.BeginStart method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolsStart.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolsClient().BeginStart(ctx, "kustorptest", "kustoclusterrptest4", "kustorptest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KustoPoolsClient) BeginStop 

func (client *KustoPoolsClient) BeginStop(ctx context.Context, workspaceName string, kustoPoolName string, resourceGroupName string, options *KustoPoolsClientBeginStopOptions) (*runtime.Poller[KustoPoolsClientStopResponse], error)

BeginStop - Stops a Kusto pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolsClientBeginStopOptions contains the optional parameters for the KustoPoolsClient.BeginStop method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolsStop.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolsClient().BeginStop(ctx, "kustorptest", "kustoclusterrptest4", "kustorptest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*KustoPoolsClient) BeginUpdate 

func (client *KustoPoolsClient) BeginUpdate(ctx context.Context, workspaceName string, resourceGroupName string, kustoPoolName string, parameters KustoPoolUpdate, options *KustoPoolsClientBeginUpdateOptions) (*runtime.Poller[KustoPoolsClientUpdateResponse], error)

BeginUpdate - Update a Kusto Kusto Pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • kustoPoolName - The name of the Kusto pool.
  • parameters - The Kusto pool parameters supplied to the Update operation.
  • options - KustoPoolsClientBeginUpdateOptions contains the optional parameters for the KustoPoolsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolsUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewKustoPoolsClient().BeginUpdate(ctx, "synapseWorkspaceName", "kustorptest", "kustoclusterrptest4", armsynapse.KustoPoolUpdate{
		Properties: &armsynapse.KustoPoolProperties{
			EnablePurge:           to.Ptr(true),
			EnableStreamingIngest: to.Ptr(true),
			WorkspaceUID:          to.Ptr("11111111-2222-3333-444444444444"),
		},
		SKU: &armsynapse.AzureSKU{
			Name:     to.Ptr(armsynapse.SKUNameStorageOptimized),
			Capacity: to.Ptr[int32](2),
			Size:     to.Ptr(armsynapse.SKUSizeMedium),
		},
	}, &armsynapse.KustoPoolsClientBeginUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.KustoPool = armsynapse.KustoPool{
	// 	Name: to.Ptr("KustoClusterRPTest4"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/kustopools"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustopools/KustoClusterRPTest4"),
	// 	Location: to.Ptr("westus"),
	// 	Etag: to.Ptr("abcd"),
	// 	Properties: &armsynapse.KustoPoolProperties{
	// 		EnablePurge: to.Ptr(true),
	// 		EnableStreamingIngest: to.Ptr(true),
	// 		ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 	},
	// 	SKU: &armsynapse.AzureSKU{
	// 		Name: to.Ptr(armsynapse.SKUNameStorageOptimized),
	// 		Capacity: to.Ptr[int32](2),
	// 		Size: to.Ptr(armsynapse.SKUSizeMedium),
	// 	},
	// }
}

Output:

func (*KustoPoolsClient) CheckNameAvailability 

func (client *KustoPoolsClient) CheckNameAvailability(ctx context.Context, location string, kustoPoolName KustoPoolCheckNameRequest, options *KustoPoolsClientCheckNameAvailabilityOptions) (KustoPoolsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the kusto pool name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • location - The name of Azure region.
  • kustoPoolName - The name of the cluster.
  • options - KustoPoolsClientCheckNameAvailabilityOptions contains the optional parameters for the KustoPoolsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolsCheckNameAvailability.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolsClient().CheckNameAvailability(ctx, "westus", armsynapse.KustoPoolCheckNameRequest{
		Name: to.Ptr("kustoclusterrptest4"),
		Type: to.Ptr("Microsoft.Synapse/workspaces/kustoPools"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameResult = armsynapse.CheckNameResult{
	// 	Name: to.Ptr("kustoclusterrptest4"),
	// 	Message: to.Ptr("Name 'kustoclusterrptest4' is already taken. Please specify a different name"),
	// 	NameAvailable: to.Ptr(false),
	// }
}

Output:

func (*KustoPoolsClient) Get 

func (client *KustoPoolsClient) Get(ctx context.Context, workspaceName string, kustoPoolName string, resourceGroupName string, options *KustoPoolsClientGetOptions) (KustoPoolsClientGetResponse, error)

Get - Gets a Kusto pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolsClientGetOptions contains the optional parameters for the KustoPoolsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolsClient().Get(ctx, "synapseWorkspaceName", "kustoclusterrptest4", "kustorptest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.KustoPool = armsynapse.KustoPool{
	// 	Name: to.Ptr("KustoClusterRPTest5"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/kustopools"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/synapseWorkspaceName/kustopools/KustoClusterRPTest5"),
	// 	Location: to.Ptr("westus"),
	// 	Etag: to.Ptr("abcd123"),
	// 	Properties: &armsynapse.KustoPoolProperties{
	// 		ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 	},
	// 	SKU: &armsynapse.AzureSKU{
	// 		Name: to.Ptr(armsynapse.SKUNameStorageOptimized),
	// 		Capacity: to.Ptr[int32](2),
	// 		Size: to.Ptr(armsynapse.SKUSizeMedium),
	// 	},
	// }
}

Output:

func (*KustoPoolsClient) ListByWorkspace 

func (client *KustoPoolsClient) ListByWorkspace(ctx context.Context, resourceGroupName string, workspaceName string, options *KustoPoolsClientListByWorkspaceOptions) (KustoPoolsClientListByWorkspaceResponse, error)

ListByWorkspace - List all Kusto pools If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - KustoPoolsClientListByWorkspaceOptions contains the optional parameters for the KustoPoolsClient.ListByWorkspace method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolsListByWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKustoPoolsClient().ListByWorkspace(ctx, "kustorptest", "kustorptest", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.KustoPoolListResult = armsynapse.KustoPoolListResult{
	// 	Value: []*armsynapse.KustoPool{
	// 		{
	// 			Name: to.Ptr("KustoClusterRPTest4"),
	// 			Type: to.Ptr("Microsoft.Synapse/workspaces/kustopools"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/kustorptest/kustopools/KustoClusterRPTest4"),
	// 			Location: to.Ptr("westus"),
	// 			Etag: to.Ptr("abcd123"),
	// 			Properties: &armsynapse.KustoPoolProperties{
	// 				ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 			},
	// 			SKU: &armsynapse.AzureSKU{
	// 				Name: to.Ptr(armsynapse.SKUNameStorageOptimized),
	// 				Capacity: to.Ptr[int32](2),
	// 				Size: to.Ptr(armsynapse.SKUSizeMedium),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("KustoClusterRPTest3"),
	// 			Type: to.Ptr("Microsoft.Synapse/workspaces/kustopools"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/kustorptest/kustopools/KustoClusterRPTest3"),
	// 			Location: to.Ptr("westus"),
	// 			Etag: to.Ptr("abcd123"),
	// 			Properties: &armsynapse.KustoPoolProperties{
	// 				ProvisioningState: to.Ptr(armsynapse.ResourceProvisioningStateSucceeded),
	// 			},
	// 			SKU: &armsynapse.AzureSKU{
	// 				Name: to.Ptr(armsynapse.SKUNameComputeOptimized),
	// 				Capacity: to.Ptr[int32](2),
	// 				Size: to.Ptr(armsynapse.SKUSizeSmall),
	// 			},
	// 	}},
	// }
}

Output:

func (*KustoPoolsClient) NewListFollowerDatabasesPager added in v0.4.0 

func (client *KustoPoolsClient) NewListFollowerDatabasesPager(workspaceName string, kustoPoolName string, resourceGroupName string, options *KustoPoolsClientListFollowerDatabasesOptions) *runtime.Pager[KustoPoolsClientListFollowerDatabasesResponse]

NewListFollowerDatabasesPager - Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolsClientListFollowerDatabasesOptions contains the optional parameters for the KustoPoolsClient.NewListFollowerDatabasesPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolFollowerDatabasesList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKustoPoolsClient().NewListFollowerDatabasesPager("kustorptest", "kustoclusterrptest4", "kustorptest", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.FollowerDatabaseListResult = armsynapse.FollowerDatabaseListResult{
		// 	Value: []*armsynapse.FollowerDatabaseDefinition{
		// 		{
		// 			AttachedDatabaseConfigurationName: to.Ptr("attachedDbConfiguration"),
		// 			KustoPoolResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/kustorptest/kustoPools/follower1"),
		// 			DatabaseName: to.Ptr("*"),
		// 		},
		// 		{
		// 			AttachedDatabaseConfigurationName: to.Ptr("attachedDbConfiguration2"),
		// 			KustoPoolResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Synapse/workspaces/kustorptest/kustoPools/follower4"),
		// 			DatabaseName: to.Ptr("db1"),
		// 	}},
		// }
	}
}

Output:

func (*KustoPoolsClient) NewListLanguageExtensionsPager added in v0.4.0 

func (client *KustoPoolsClient) NewListLanguageExtensionsPager(workspaceName string, kustoPoolName string, resourceGroupName string, options *KustoPoolsClientListLanguageExtensionsOptions) *runtime.Pager[KustoPoolsClientListLanguageExtensionsResponse]

NewListLanguageExtensionsPager - Returns a list of language extensions that can run within KQL queries.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolsClientListLanguageExtensionsOptions contains the optional parameters for the KustoPoolsClient.NewListLanguageExtensionsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolLanguageExtensionsList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKustoPoolsClient().NewListLanguageExtensionsPager("kustorptest", "kustoclusterrptest4", "kustorptest", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.LanguageExtensionsList = armsynapse.LanguageExtensionsList{
		// 	Value: []*armsynapse.LanguageExtension{
		// 		{
		// 			LanguageExtensionName: to.Ptr(armsynapse.LanguageExtensionNamePYTHON),
		// 		},
		// 		{
		// 			LanguageExtensionName: to.Ptr(armsynapse.LanguageExtensionNameR),
		// 	}},
		// }
	}
}

Output:

func (*KustoPoolsClient) NewListSKUsByResourcePager added in v0.4.0 

func (client *KustoPoolsClient) NewListSKUsByResourcePager(workspaceName string, kustoPoolName string, resourceGroupName string, options *KustoPoolsClientListSKUsByResourceOptions) *runtime.Pager[KustoPoolsClientListSKUsByResourceResponse]

NewListSKUsByResourcePager - Returns the SKUs available for the provided resource.

Generated from API version 2021-06-01-preview

  • workspaceName - The name of the workspace.
  • kustoPoolName - The name of the Kusto pool.
  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - KustoPoolsClientListSKUsByResourceOptions contains the optional parameters for the KustoPoolsClient.NewListSKUsByResourcePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolsListResourceSkus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKustoPoolsClient().NewListSKUsByResourcePager("synapseWorkspaceName", "kustoclusterrptest4", "kustorptest", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListResourceSKUsResult = armsynapse.ListResourceSKUsResult{
		// 	Value: []*armsynapse.AzureResourceSKU{
		// 		{
		// 			Capacity: &armsynapse.AzureCapacity{
		// 				Default: to.Ptr[int32](2),
		// 				Maximum: to.Ptr[int32](100),
		// 				Minimum: to.Ptr[int32](2),
		// 				ScaleType: to.Ptr(armsynapse.AzureScaleTypeAutomatic),
		// 			},
		// 			ResourceType: to.Ptr("workspaces/kustoPools"),
		// 			SKU: &armsynapse.AzureSKU{
		// 				Name: to.Ptr(armsynapse.SKUNameComputeOptimized),
		// 				Size: to.Ptr(armsynapse.SKUSizeMedium),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armsynapse.AzureCapacity{
		// 				Default: to.Ptr[int32](2),
		// 				Maximum: to.Ptr[int32](100),
		// 				Minimum: to.Ptr[int32](2),
		// 				ScaleType: to.Ptr(armsynapse.AzureScaleTypeAutomatic),
		// 			},
		// 			ResourceType: to.Ptr("workspaces/kustoPools"),
		// 			SKU: &armsynapse.AzureSKU{
		// 				Name: to.Ptr(armsynapse.SKUNameComputeOptimized),
		// 				Size: to.Ptr(armsynapse.SKUSizeLarge),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armsynapse.AzureCapacity{
		// 				Default: to.Ptr[int32](2),
		// 				Maximum: to.Ptr[int32](100),
		// 				Minimum: to.Ptr[int32](2),
		// 				ScaleType: to.Ptr(armsynapse.AzureScaleTypeAutomatic),
		// 			},
		// 			ResourceType: to.Ptr("workspaces/kustoPools"),
		// 			SKU: &armsynapse.AzureSKU{
		// 				Name: to.Ptr(armsynapse.SKUNameStorageOptimized),
		// 				Size: to.Ptr(armsynapse.SKUSizeMedium),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armsynapse.AzureCapacity{
		// 				Default: to.Ptr[int32](2),
		// 				Maximum: to.Ptr[int32](100),
		// 				Minimum: to.Ptr[int32](2),
		// 				ScaleType: to.Ptr(armsynapse.AzureScaleTypeAutomatic),
		// 			},
		// 			ResourceType: to.Ptr("workspaces/kustoPools"),
		// 			SKU: &armsynapse.AzureSKU{
		// 				Name: to.Ptr(armsynapse.SKUNameStorageOptimized),
		// 				Size: to.Ptr(armsynapse.SKUSizeLarge),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*KustoPoolsClient) NewListSKUsPager added in v0.4.0 

func (client *KustoPoolsClient) NewListSKUsPager(options *KustoPoolsClientListSKUsOptions) *runtime.Pager[KustoPoolsClientListSKUsResponse]

NewListSKUsPager - Lists eligible SKUs for Kusto Pool resource.

Generated from API version 2021-06-01-preview

  • options - KustoPoolsClientListSKUsOptions contains the optional parameters for the KustoPoolsClient.NewListSKUsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/KustoPoolsListSkus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewKustoPoolsClient().NewListSKUsPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SKUDescriptionList = armsynapse.SKUDescriptionList{
		// 	Value: []*armsynapse.SKUDescription{
		// 		{
		// 			Name: to.Ptr("Compute optimized"),
		// 			LocationInfo: []*armsynapse.SKULocationInfoItem{
		// 				{
		// 					Location: to.Ptr("West US"),
		// 					Zones: []*string{
		// 						to.Ptr("1"),
		// 						to.Ptr("2"),
		// 						to.Ptr("3")},
		// 					},
		// 					{
		// 						Location: to.Ptr("West Europe"),
		// 						Zones: []*string{
		// 						},
		// 				}},
		// 				Locations: []*string{
		// 					to.Ptr("West US"),
		// 					to.Ptr("West Europe")},
		// 					Size: to.Ptr("Medium"),
		// 				},
		// 				{
		// 					Name: to.Ptr("Compute optimized"),
		// 					LocationInfo: []*armsynapse.SKULocationInfoItem{
		// 						{
		// 							Location: to.Ptr("West US"),
		// 							Zones: []*string{
		// 								to.Ptr("1"),
		// 								to.Ptr("2"),
		// 								to.Ptr("3")},
		// 							},
		// 							{
		// 								Location: to.Ptr("West Europe"),
		// 								Zones: []*string{
		// 								},
		// 						}},
		// 						Locations: []*string{
		// 							to.Ptr("West US"),
		// 							to.Ptr("West Europe")},
		// 							Size: to.Ptr("Large"),
		// 						},
		// 						{
		// 							Name: to.Ptr("Storage optimized"),
		// 							LocationInfo: []*armsynapse.SKULocationInfoItem{
		// 								{
		// 									Location: to.Ptr("West US"),
		// 									Zones: []*string{
		// 										to.Ptr("1"),
		// 										to.Ptr("2"),
		// 										to.Ptr("3")},
		// 									},
		// 									{
		// 										Location: to.Ptr("West Europe"),
		// 										Zones: []*string{
		// 										},
		// 								}},
		// 								Locations: []*string{
		// 									to.Ptr("West US"),
		// 									to.Ptr("West Europe")},
		// 									Size: to.Ptr("Medium"),
		// 								},
		// 								{
		// 									Name: to.Ptr("Storage optimized"),
		// 									LocationInfo: []*armsynapse.SKULocationInfoItem{
		// 										{
		// 											Location: to.Ptr("West US"),
		// 											Zones: []*string{
		// 												to.Ptr("1"),
		// 												to.Ptr("2"),
		// 												to.Ptr("3")},
		// 											},
		// 											{
		// 												Location: to.Ptr("West Europe"),
		// 												Zones: []*string{
		// 												},
		// 										}},
		// 										Locations: []*string{
		// 											to.Ptr("West US"),
		// 											to.Ptr("West Europe")},
		// 											Size: to.Ptr("Large"),
		// 									}},
		// 								}
	}
}

Output:

type KustoPoolsClientAddLanguageExtensionsResponse added in v0.2.0 

type KustoPoolsClientAddLanguageExtensionsResponse struct {
}

KustoPoolsClientAddLanguageExtensionsResponse contains the response from method KustoPoolsClient.BeginAddLanguageExtensions.

type KustoPoolsClientBeginAddLanguageExtensionsOptions added in v0.2.0 

type KustoPoolsClientBeginAddLanguageExtensionsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolsClientBeginAddLanguageExtensionsOptions contains the optional parameters for the KustoPoolsClient.BeginAddLanguageExtensions method.

type KustoPoolsClientBeginCreateOrUpdateOptions added in v0.2.0 

type KustoPoolsClientBeginCreateOrUpdateOptions struct {
	// The ETag of the Kusto Pool. Omit this value to always overwrite the current Kusto Pool. Specify the last-seen ETag value
	// to prevent accidentally overwriting concurrent changes.
	IfMatch *string

	// Set to '*' to allow a new Kusto Pool to be created, but to prevent updating an existing Kusto Pool. Other values will result
	// in a 412 Pre-condition Failed response.
	IfNoneMatch *string

	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolsClientBeginCreateOrUpdateOptions contains the optional parameters for the KustoPoolsClient.BeginCreateOrUpdate method.

type KustoPoolsClientBeginDeleteOptions added in v0.2.0 

type KustoPoolsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolsClientBeginDeleteOptions contains the optional parameters for the KustoPoolsClient.BeginDelete method.

type KustoPoolsClientBeginDetachFollowerDatabasesOptions added in v0.2.0 

type KustoPoolsClientBeginDetachFollowerDatabasesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolsClientBeginDetachFollowerDatabasesOptions contains the optional parameters for the KustoPoolsClient.BeginDetachFollowerDatabases method.

type KustoPoolsClientBeginRemoveLanguageExtensionsOptions added in v0.2.0 

type KustoPoolsClientBeginRemoveLanguageExtensionsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolsClientBeginRemoveLanguageExtensionsOptions contains the optional parameters for the KustoPoolsClient.BeginRemoveLanguageExtensions method.

type KustoPoolsClientBeginStartOptions added in v0.2.0 

type KustoPoolsClientBeginStartOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolsClientBeginStartOptions contains the optional parameters for the KustoPoolsClient.BeginStart method.

type KustoPoolsClientBeginStopOptions added in v0.2.0 

type KustoPoolsClientBeginStopOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolsClientBeginStopOptions contains the optional parameters for the KustoPoolsClient.BeginStop method.

type KustoPoolsClientBeginUpdateOptions added in v0.2.0 

type KustoPoolsClientBeginUpdateOptions struct {
	// The ETag of the Kusto Pool. Omit this value to always overwrite the current Kusto Pool. Specify the last-seen ETag value
	// to prevent accidentally overwriting concurrent changes.
	IfMatch *string

	// Resumes the LRO from the provided token.
	ResumeToken string
}

KustoPoolsClientBeginUpdateOptions contains the optional parameters for the KustoPoolsClient.BeginUpdate method.

type KustoPoolsClientCheckNameAvailabilityOptions added in v0.2.0 

type KustoPoolsClientCheckNameAvailabilityOptions struct {
}

KustoPoolsClientCheckNameAvailabilityOptions contains the optional parameters for the KustoPoolsClient.CheckNameAvailability method.

type KustoPoolsClientCheckNameAvailabilityResponse added in v0.2.0 

type KustoPoolsClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

KustoPoolsClientCheckNameAvailabilityResponse contains the response from method KustoPoolsClient.CheckNameAvailability.

type KustoPoolsClientCreateOrUpdateResponse added in v0.2.0 

type KustoPoolsClientCreateOrUpdateResponse struct {
	// Class representing a Kusto kusto pool.
	KustoPool
}

KustoPoolsClientCreateOrUpdateResponse contains the response from method KustoPoolsClient.BeginCreateOrUpdate.

type KustoPoolsClientDeleteResponse added in v0.2.0 

type KustoPoolsClientDeleteResponse struct {
}

KustoPoolsClientDeleteResponse contains the response from method KustoPoolsClient.BeginDelete.

type KustoPoolsClientDetachFollowerDatabasesResponse added in v0.2.0 

type KustoPoolsClientDetachFollowerDatabasesResponse struct {
}

KustoPoolsClientDetachFollowerDatabasesResponse contains the response from method KustoPoolsClient.BeginDetachFollowerDatabases.

type KustoPoolsClientGetOptions added in v0.2.0 

type KustoPoolsClientGetOptions struct {
}

KustoPoolsClientGetOptions contains the optional parameters for the KustoPoolsClient.Get method.

type KustoPoolsClientGetResponse added in v0.2.0 

type KustoPoolsClientGetResponse struct {
	// Class representing a Kusto kusto pool.
	KustoPool
}

KustoPoolsClientGetResponse contains the response from method KustoPoolsClient.Get.

type KustoPoolsClientListByWorkspaceOptions added in v0.2.0 

type KustoPoolsClientListByWorkspaceOptions struct {
}

KustoPoolsClientListByWorkspaceOptions contains the optional parameters for the KustoPoolsClient.ListByWorkspace method.

type KustoPoolsClientListByWorkspaceResponse added in v0.2.0 

type KustoPoolsClientListByWorkspaceResponse struct {
	// The list Kusto pools operation response.
	KustoPoolListResult
}

KustoPoolsClientListByWorkspaceResponse contains the response from method KustoPoolsClient.ListByWorkspace.

type KustoPoolsClientListFollowerDatabasesOptions added in v0.2.0 

type KustoPoolsClientListFollowerDatabasesOptions struct {
}

KustoPoolsClientListFollowerDatabasesOptions contains the optional parameters for the KustoPoolsClient.NewListFollowerDatabasesPager method.

type KustoPoolsClientListFollowerDatabasesResponse added in v0.2.0 

type KustoPoolsClientListFollowerDatabasesResponse struct {
	// The list Kusto database principals operation response.
	FollowerDatabaseListResult
}

KustoPoolsClientListFollowerDatabasesResponse contains the response from method KustoPoolsClient.NewListFollowerDatabasesPager.

type KustoPoolsClientListLanguageExtensionsOptions added in v0.2.0 

type KustoPoolsClientListLanguageExtensionsOptions struct {
}

KustoPoolsClientListLanguageExtensionsOptions contains the optional parameters for the KustoPoolsClient.NewListLanguageExtensionsPager method.

type KustoPoolsClientListLanguageExtensionsResponse added in v0.2.0 

type KustoPoolsClientListLanguageExtensionsResponse struct {
	// The list of language extension objects.
	LanguageExtensionsList
}

KustoPoolsClientListLanguageExtensionsResponse contains the response from method KustoPoolsClient.NewListLanguageExtensionsPager.

type KustoPoolsClientListSKUsByResourceOptions added in v0.2.0 

type KustoPoolsClientListSKUsByResourceOptions struct {
}

KustoPoolsClientListSKUsByResourceOptions contains the optional parameters for the KustoPoolsClient.NewListSKUsByResourcePager method.

type KustoPoolsClientListSKUsByResourceResponse added in v0.2.0 

type KustoPoolsClientListSKUsByResourceResponse struct {
	// List of available SKUs for a Kusto Pool.
	ListResourceSKUsResult
}

KustoPoolsClientListSKUsByResourceResponse contains the response from method KustoPoolsClient.NewListSKUsByResourcePager.

type KustoPoolsClientListSKUsOptions added in v0.2.0 

type KustoPoolsClientListSKUsOptions struct {
}

KustoPoolsClientListSKUsOptions contains the optional parameters for the KustoPoolsClient.NewListSKUsPager method.

type KustoPoolsClientListSKUsResponse added in v0.2.0 

type KustoPoolsClientListSKUsResponse struct {
	// The list of the SKU descriptions
	SKUDescriptionList
}

KustoPoolsClientListSKUsResponse contains the response from method KustoPoolsClient.NewListSKUsPager.

type KustoPoolsClientRemoveLanguageExtensionsResponse added in v0.2.0 

type KustoPoolsClientRemoveLanguageExtensionsResponse struct {
}

KustoPoolsClientRemoveLanguageExtensionsResponse contains the response from method KustoPoolsClient.BeginRemoveLanguageExtensions.

type KustoPoolsClientStartResponse added in v0.2.0 

type KustoPoolsClientStartResponse struct {
}

KustoPoolsClientStartResponse contains the response from method KustoPoolsClient.BeginStart.

type KustoPoolsClientStopResponse added in v0.2.0 

type KustoPoolsClientStopResponse struct {
}

KustoPoolsClientStopResponse contains the response from method KustoPoolsClient.BeginStop.

type KustoPoolsClientUpdateResponse added in v0.2.0 

type KustoPoolsClientUpdateResponse struct {
	// Class representing a Kusto kusto pool.
	KustoPool
}

KustoPoolsClientUpdateResponse contains the response from method KustoPoolsClient.BeginUpdate.

type LanguageExtension 

type LanguageExtension struct {
	// The language extension name.
	LanguageExtensionName *LanguageExtensionName
}

LanguageExtension - The language extension object.

func (LanguageExtension) MarshalJSON added in v0.6.0 

func (l LanguageExtension) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LanguageExtension.

func (*LanguageExtension) UnmarshalJSON added in v0.6.0 

func (l *LanguageExtension) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LanguageExtension.

type LanguageExtensionName 

type LanguageExtensionName string

LanguageExtensionName - Language extension that can run within KQL query. 

const (
	LanguageExtensionNamePYTHON LanguageExtensionName = "PYTHON"
	LanguageExtensionNameR      LanguageExtensionName = "R"
)

func PossibleLanguageExtensionNameValues 

func PossibleLanguageExtensionNameValues() []LanguageExtensionName

PossibleLanguageExtensionNameValues returns the possible values for the LanguageExtensionName const type.

type LanguageExtensionsList 

type LanguageExtensionsList struct {
	// The list of language extensions.
	Value []*LanguageExtension
}

LanguageExtensionsList - The list of language extension objects.

func (LanguageExtensionsList) MarshalJSON 

func (l LanguageExtensionsList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LanguageExtensionsList.

func (*LanguageExtensionsList) UnmarshalJSON added in v0.6.0 

func (l *LanguageExtensionsList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LanguageExtensionsList.

type LibrariesClient 

type LibrariesClient struct {
	// contains filtered or unexported fields
}

LibrariesClient contains the methods for the Libraries group. Don't use this type directly, use NewLibrariesClient() instead.

func NewLibrariesClient 

func NewLibrariesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*LibrariesClient, error)

NewLibrariesClient creates a new instance of LibrariesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*LibrariesClient) NewListByWorkspacePager added in v0.4.0 

func (client *LibrariesClient) NewListByWorkspacePager(resourceGroupName string, workspaceName string, options *LibrariesClientListByWorkspaceOptions) *runtime.Pager[LibrariesClientListByWorkspaceResponse]

NewListByWorkspacePager - List libraries in a workspace.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - LibrariesClientListByWorkspaceOptions contains the optional parameters for the LibrariesClient.NewListByWorkspacePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/Libraries_ListByWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewLibrariesClient().NewListByWorkspacePager("exampleResourceGroup", "exampleWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.LibraryListResponse = armsynapse.LibraryListResponse{
		// 	Value: []*armsynapse.LibraryResource{
		// 		{
		// 			Name: to.Ptr("exampleLibraryName1.jar"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/libraries"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/libraries/exampleLibraryName1.jar"),
		// 			Etag: to.Ptr("1500474f-0000-0200-0000-5cbe090d0000"),
		// 			Properties: &armsynapse.LibraryInfo{
		// 				Name: to.Ptr("exampleLibraryName1.jar"),
		// 				Type: to.Ptr("jar"),
		// 				Path: to.Ptr("exampleWorkspace/libraries/exampleLibraryName1.jar"),
		// 				ContainerName: to.Ptr("exampleContainer"),
		// 				CreatorID: to.Ptr("2222222e-222d-222f-2222-22a2f222d2f2"),
		// 				ProvisioningStatus: to.Ptr("Succeeded"),
		// 				UploadedTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-23T07:59:29.157Z"); return t}()),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("exampleLibraryName2.jar"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/libraries"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/libraries/exampleLibraryName2.jar"),
		// 			Etag: to.Ptr("1500474f-0000-0200-0000-5cbe090d0000"),
		// 			Properties: &armsynapse.LibraryInfo{
		// 				Name: to.Ptr("exampleLibraryName2.jar"),
		// 				Type: to.Ptr("jar"),
		// 				Path: to.Ptr("exampleWorkspace/libraries/exampleLibraryName2.jar"),
		// 				ContainerName: to.Ptr("exampleContainer"),
		// 				CreatorID: to.Ptr("2222222e-222d-222f-2222-22a2f222d2f2"),
		// 				ProvisioningStatus: to.Ptr("Succeeded"),
		// 				UploadedTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-23T07:59:29.157Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

Output:

type LibrariesClientListByWorkspaceOptions added in v0.2.0 

type LibrariesClientListByWorkspaceOptions struct {
}

LibrariesClientListByWorkspaceOptions contains the optional parameters for the LibrariesClient.NewListByWorkspacePager method.

type LibrariesClientListByWorkspaceResponse added in v0.2.0 

type LibrariesClientListByWorkspaceResponse struct {
	// A list of Library resources.
	LibraryListResponse
}

LibrariesClientListByWorkspaceResponse contains the response from method LibrariesClient.NewListByWorkspacePager.

type LibraryClient 

type LibraryClient struct {
	// contains filtered or unexported fields
}

LibraryClient contains the methods for the Library group. Don't use this type directly, use NewLibraryClient() instead.

func NewLibraryClient 

func NewLibraryClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*LibraryClient, error)

NewLibraryClient creates a new instance of LibraryClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*LibraryClient) Get 

func (client *LibraryClient) Get(ctx context.Context, resourceGroupName string, libraryName string, workspaceName string, options *LibraryClientGetOptions) (LibraryClientGetResponse, error)

Get - Get library by name in a workspace. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • libraryName - Library name
  • workspaceName - The name of the workspace.
  • options - LibraryClientGetOptions contains the optional parameters for the LibraryClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewLibraryClient().Get(ctx, "exampleResourceGroup", "exampleLibraryName.jar", "exampleWorkspace", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.LibraryResource = armsynapse.LibraryResource{
	// 	Name: to.Ptr("exampleLibraryName.jar"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/libraries"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/libraries/exampleLibraryName.jar"),
	// 	Etag: to.Ptr("1500474f-0000-0200-0000-5cbe090d0000"),
	// 	Properties: &armsynapse.LibraryInfo{
	// 		Name: to.Ptr("exampleLibraryName.jar"),
	// 		Type: to.Ptr("jar"),
	// 		Path: to.Ptr("exampleWorkspace/libraries/exampleLibraryName.jar"),
	// 		ContainerName: to.Ptr("exampleContainer"),
	// 		CreatorID: to.Ptr("2222222e-222d-222f-2222-22a2f222d2f2"),
	// 		ProvisioningStatus: to.Ptr("Succeeded"),
	// 		UploadedTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-23T07:59:29.157Z"); return t}()),
	// 	},
	// }
}

Output:

type LibraryClientGetOptions added in v0.2.0 

type LibraryClientGetOptions struct {
}

LibraryClientGetOptions contains the optional parameters for the LibraryClient.Get method.

type LibraryClientGetResponse added in v0.2.0 

type LibraryClientGetResponse struct {
	// Library response details
	LibraryResource
}

LibraryClientGetResponse contains the response from method LibraryClient.Get.

type LibraryInfo 

type LibraryInfo struct {
	// Storage blob container name.
	ContainerName *string

	// Name of the library.
	Name *string

	// Storage blob path of library.
	Path *string

	// Type of the library.
	Type *string

	// The last update time of the library.
	UploadedTimestamp *time.Time

	// READ-ONLY; Creator Id of the library/package.
	CreatorID *string

	// READ-ONLY; Provisioning status of the library/package.
	ProvisioningStatus *string
}

LibraryInfo - Library/package information of a Big Data pool powered by Apache Spark

func (LibraryInfo) MarshalJSON 

func (l LibraryInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LibraryInfo.

func (*LibraryInfo) UnmarshalJSON 

func (l *LibraryInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LibraryInfo.

type LibraryListResponse 

type LibraryListResponse struct {
	// REQUIRED; List of Library.
	Value []*LibraryResource

	// The link to the next page of results, if any remaining results exist.
	NextLink *string
}

LibraryListResponse - A list of Library resources.

func (LibraryListResponse) MarshalJSON 

func (l LibraryListResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LibraryListResponse.

func (*LibraryListResponse) UnmarshalJSON added in v0.6.0 

func (l *LibraryListResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LibraryListResponse.

type LibraryRequirements 

type LibraryRequirements struct {
	// The library requirements.
	Content *string

	// The filename of the library requirements file.
	Filename *string

	// READ-ONLY; The last update time of the library requirements file.
	Time *time.Time
}

LibraryRequirements - Library requirements for a Big Data pool powered by Apache Spark

func (LibraryRequirements) MarshalJSON 

func (l LibraryRequirements) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LibraryRequirements.

func (*LibraryRequirements) UnmarshalJSON 

func (l *LibraryRequirements) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LibraryRequirements.

type LibraryResource 

type LibraryResource struct {
	// REQUIRED; Library/package properties.
	Properties *LibraryInfo

	// READ-ONLY; Resource Etag.
	Etag *string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

LibraryResource - Library response details

func (LibraryResource) MarshalJSON 

func (l LibraryResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LibraryResource.

func (*LibraryResource) UnmarshalJSON 

func (l *LibraryResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LibraryResource.

type LicensedComponentSetupTypeProperties 

type LicensedComponentSetupTypeProperties struct {
	// REQUIRED; The name of the 3rd party component.
	ComponentName *string

	// The license key to activate the component.
	LicenseKey SecretBaseClassification
}

LicensedComponentSetupTypeProperties - Installation of licensed component setup type properties.

func (LicensedComponentSetupTypeProperties) MarshalJSON 

func (l LicensedComponentSetupTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LicensedComponentSetupTypeProperties.

func (*LicensedComponentSetupTypeProperties) UnmarshalJSON 

func (l *LicensedComponentSetupTypeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LicensedComponentSetupTypeProperties.

type LinkedIntegrationRuntime 

type LinkedIntegrationRuntime struct {
	// READ-ONLY; The creating time of the linked integration runtime.
	CreateTime *time.Time

	// READ-ONLY; The location of the workspace for which the linked integration runtime belong to.
	DataFactoryLocation *string

	// READ-ONLY; The name of the workspace for which the linked integration runtime belong to.
	DataFactoryName *string

	// READ-ONLY; The name of the linked integration runtime.
	Name *string

	// READ-ONLY; The subscription ID for which the linked integration runtime belong to.
	SubscriptionID *string
}

LinkedIntegrationRuntime - The linked integration runtime information.

func (LinkedIntegrationRuntime) MarshalJSON 

func (l LinkedIntegrationRuntime) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LinkedIntegrationRuntime.

func (*LinkedIntegrationRuntime) UnmarshalJSON 

func (l *LinkedIntegrationRuntime) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LinkedIntegrationRuntime.

type LinkedIntegrationRuntimeKeyAuthorization 

type LinkedIntegrationRuntimeKeyAuthorization struct {
	// REQUIRED; The authorization type for integration runtime sharing.
	AuthorizationType *string

	// REQUIRED; The key used for authorization.
	Key *SecureString
}

LinkedIntegrationRuntimeKeyAuthorization - The key authorization type integration runtime.

func (*LinkedIntegrationRuntimeKeyAuthorization) GetLinkedIntegrationRuntimeType added in v0.2.0 

func (l *LinkedIntegrationRuntimeKeyAuthorization) GetLinkedIntegrationRuntimeType() *LinkedIntegrationRuntimeType

GetLinkedIntegrationRuntimeType implements the LinkedIntegrationRuntimeTypeClassification interface for type LinkedIntegrationRuntimeKeyAuthorization.

func (LinkedIntegrationRuntimeKeyAuthorization) MarshalJSON 

func (l LinkedIntegrationRuntimeKeyAuthorization) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LinkedIntegrationRuntimeKeyAuthorization.

func (*LinkedIntegrationRuntimeKeyAuthorization) UnmarshalJSON 

func (l *LinkedIntegrationRuntimeKeyAuthorization) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LinkedIntegrationRuntimeKeyAuthorization.

type LinkedIntegrationRuntimeRbacAuthorization 

type LinkedIntegrationRuntimeRbacAuthorization struct {
	// REQUIRED; The authorization type for integration runtime sharing.
	AuthorizationType *string

	// REQUIRED; The resource identifier of the integration runtime to be shared.
	ResourceID *string
}

LinkedIntegrationRuntimeRbacAuthorization - The role based access control (RBAC) authorization type integration runtime.

func (*LinkedIntegrationRuntimeRbacAuthorization) GetLinkedIntegrationRuntimeType added in v0.2.0 

func (l *LinkedIntegrationRuntimeRbacAuthorization) GetLinkedIntegrationRuntimeType() *LinkedIntegrationRuntimeType

GetLinkedIntegrationRuntimeType implements the LinkedIntegrationRuntimeTypeClassification interface for type LinkedIntegrationRuntimeRbacAuthorization.

func (LinkedIntegrationRuntimeRbacAuthorization) MarshalJSON 

func (l LinkedIntegrationRuntimeRbacAuthorization) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LinkedIntegrationRuntimeRbacAuthorization.

func (*LinkedIntegrationRuntimeRbacAuthorization) UnmarshalJSON 

func (l *LinkedIntegrationRuntimeRbacAuthorization) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LinkedIntegrationRuntimeRbacAuthorization.

type LinkedIntegrationRuntimeType 

type LinkedIntegrationRuntimeType struct {
	// REQUIRED; The authorization type for integration runtime sharing.
	AuthorizationType *string
}

LinkedIntegrationRuntimeType - The base definition of a linked integration runtime.

func (*LinkedIntegrationRuntimeType) GetLinkedIntegrationRuntimeType 

func (l *LinkedIntegrationRuntimeType) GetLinkedIntegrationRuntimeType() *LinkedIntegrationRuntimeType

GetLinkedIntegrationRuntimeType implements the LinkedIntegrationRuntimeTypeClassification interface for type LinkedIntegrationRuntimeType.

func (LinkedIntegrationRuntimeType) MarshalJSON added in v0.6.0 

func (l LinkedIntegrationRuntimeType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LinkedIntegrationRuntimeType.

func (*LinkedIntegrationRuntimeType) UnmarshalJSON 

func (l *LinkedIntegrationRuntimeType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LinkedIntegrationRuntimeType.

type LinkedIntegrationRuntimeTypeClassification 

type LinkedIntegrationRuntimeTypeClassification interface {
	// GetLinkedIntegrationRuntimeType returns the LinkedIntegrationRuntimeType content of the underlying type.
	GetLinkedIntegrationRuntimeType() *LinkedIntegrationRuntimeType
}

LinkedIntegrationRuntimeTypeClassification provides polymorphic access to related types. Call the interface's GetLinkedIntegrationRuntimeType() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *LinkedIntegrationRuntimeKeyAuthorization, *LinkedIntegrationRuntimeRbacAuthorization, *LinkedIntegrationRuntimeType

type ListResourceSKUsResult 

type ListResourceSKUsResult struct {
	// The collection of available SKUs for an existing resource.
	Value []*AzureResourceSKU
}

ListResourceSKUsResult - List of available SKUs for a Kusto Pool.

func (ListResourceSKUsResult) MarshalJSON 

func (l ListResourceSKUsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListResourceSKUsResult.

func (*ListResourceSKUsResult) UnmarshalJSON added in v0.6.0 

func (l *ListResourceSKUsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListResourceSKUsResult.

type ListSQLPoolSecurityAlertPolicies 

type ListSQLPoolSecurityAlertPolicies struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*SQLPoolSecurityAlertPolicy
}

ListSQLPoolSecurityAlertPolicies - A list of SQL pool security alert policies.

func (ListSQLPoolSecurityAlertPolicies) MarshalJSON 

func (l ListSQLPoolSecurityAlertPolicies) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListSQLPoolSecurityAlertPolicies.

func (*ListSQLPoolSecurityAlertPolicies) UnmarshalJSON added in v0.6.0 

func (l *ListSQLPoolSecurityAlertPolicies) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListSQLPoolSecurityAlertPolicies.

type MaintenanceWindowOptions 

type MaintenanceWindowOptions struct {
	// Resource properties.
	Properties *MaintenanceWindowOptionsProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

MaintenanceWindowOptions - Maintenance window options.

func (MaintenanceWindowOptions) MarshalJSON 

func (m MaintenanceWindowOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MaintenanceWindowOptions.

func (*MaintenanceWindowOptions) UnmarshalJSON 

func (m *MaintenanceWindowOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MaintenanceWindowOptions.

type MaintenanceWindowOptionsProperties 

type MaintenanceWindowOptionsProperties struct {
	// Whether we allow multiple maintenance windows per cycle.
	AllowMultipleMaintenanceWindowsPerCycle *bool

	// Default duration for maintenance window.
	DefaultDurationInMinutes *int32

	// Whether maintenance windows are enabled for the database.
	IsEnabled *bool

	// Available maintenance cycles e.g. {Saturday, 0, 4860}, {Wednesday, 0, 2460}.
	MaintenanceWindowCycles []*MaintenanceWindowTimeRange

	// Minimum number of maintenance windows cycles to be set on the database.
	MinCycles *int32

	// Minimum duration of maintenance window.
	MinDurationInMinutes *int32

	// Time granularity in minutes for maintenance windows.
	TimeGranularityInMinutes *int32
}

MaintenanceWindowOptionsProperties - Maintenance window options properties.

func (MaintenanceWindowOptionsProperties) MarshalJSON 

func (m MaintenanceWindowOptionsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MaintenanceWindowOptionsProperties.

func (*MaintenanceWindowOptionsProperties) UnmarshalJSON added in v0.6.0 

func (m *MaintenanceWindowOptionsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MaintenanceWindowOptionsProperties.

type MaintenanceWindowTimeRange 

type MaintenanceWindowTimeRange struct {
	// Day of maintenance window.
	DayOfWeek *DayOfWeek

	// Duration of maintenance window in minutes.
	Duration *string

	// Start time minutes offset from 12am.
	StartTime *string
}

MaintenanceWindowTimeRange - Maintenance window time range.

func (MaintenanceWindowTimeRange) MarshalJSON added in v0.6.0 

func (m MaintenanceWindowTimeRange) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MaintenanceWindowTimeRange.

func (*MaintenanceWindowTimeRange) UnmarshalJSON added in v0.6.0 

func (m *MaintenanceWindowTimeRange) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MaintenanceWindowTimeRange.

type MaintenanceWindows 

type MaintenanceWindows struct {
	// Resource properties.
	Properties *MaintenanceWindowsProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

MaintenanceWindows - Maintenance windows.

func (MaintenanceWindows) MarshalJSON 

func (m MaintenanceWindows) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MaintenanceWindows.

func (*MaintenanceWindows) UnmarshalJSON 

func (m *MaintenanceWindows) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MaintenanceWindows.

type MaintenanceWindowsProperties 

type MaintenanceWindowsProperties struct {
	TimeRanges []*MaintenanceWindowTimeRange
}

MaintenanceWindowsProperties - Maintenance windows resource properties.

func (MaintenanceWindowsProperties) MarshalJSON 

func (m MaintenanceWindowsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MaintenanceWindowsProperties.

func (*MaintenanceWindowsProperties) UnmarshalJSON added in v0.6.0 

func (m *MaintenanceWindowsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MaintenanceWindowsProperties.

type ManagedIdentity 

type ManagedIdentity struct {
	// The type of managed identity for the workspace
	Type *ResourceIdentityType

	// The user assigned managed identities.
	UserAssignedIdentities map[string]*UserAssignedManagedIdentity

	// READ-ONLY; The principal ID of the workspace managed identity
	PrincipalID *string

	// READ-ONLY; The tenant ID of the workspace managed identity
	TenantID *string
}

ManagedIdentity - The workspace managed identity

func (ManagedIdentity) MarshalJSON 

func (m ManagedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIdentity.

func (*ManagedIdentity) UnmarshalJSON added in v0.6.0 

func (m *ManagedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIdentity.

type ManagedIdentitySQLControlSettingsModel 

type ManagedIdentitySQLControlSettingsModel struct {
	// Sql Control Settings for workspace managed identity
	Properties *ManagedIdentitySQLControlSettingsModelProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ManagedIdentitySQLControlSettingsModel - Sql Control Settings for workspace managed identity

func (ManagedIdentitySQLControlSettingsModel) MarshalJSON 

func (m ManagedIdentitySQLControlSettingsModel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIdentitySQLControlSettingsModel.

func (*ManagedIdentitySQLControlSettingsModel) UnmarshalJSON 

func (m *ManagedIdentitySQLControlSettingsModel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIdentitySQLControlSettingsModel.

type ManagedIdentitySQLControlSettingsModelProperties 

type ManagedIdentitySQLControlSettingsModelProperties struct {
	// Grant sql control to managed identity
	GrantSQLControlToManagedIdentity *ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity
}

ManagedIdentitySQLControlSettingsModelProperties - Sql Control Settings for workspace managed identity

func (ManagedIdentitySQLControlSettingsModelProperties) MarshalJSON added in v0.6.0 

func (m ManagedIdentitySQLControlSettingsModelProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIdentitySQLControlSettingsModelProperties.

func (*ManagedIdentitySQLControlSettingsModelProperties) UnmarshalJSON added in v0.6.0 

func (m *ManagedIdentitySQLControlSettingsModelProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIdentitySQLControlSettingsModelProperties.

type ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity 

type ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity struct {
	// Desired state
	DesiredState *DesiredState

	// READ-ONLY; Actual state
	ActualState *ActualState
}

ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity - Grant sql control to managed identity

func (ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity) MarshalJSON added in v0.6.0 

func (m ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity.

func (*ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity) UnmarshalJSON added in v0.6.0 

func (m *ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity.

type ManagedIntegrationRuntime 

type ManagedIntegrationRuntime struct {
	// REQUIRED; Type of integration runtime.
	Type *IntegrationRuntimeType

	// REQUIRED; Managed integration runtime properties.
	TypeProperties *ManagedIntegrationRuntimeTypeProperties

	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// Integration runtime description.
	Description *string

	// Managed integration runtime managed virtual network.
	ManagedVirtualNetwork *ManagedIntegrationRuntimeManagedVirtualNetworkReference

	// READ-ONLY; Integration runtime state, only valid for managed dedicated integration runtime.
	State *IntegrationRuntimeState
}

ManagedIntegrationRuntime - Managed integration runtime, including managed elastic and managed dedicated integration runtimes.

func (*ManagedIntegrationRuntime) GetIntegrationRuntime added in v0.2.0 

func (m *ManagedIntegrationRuntime) GetIntegrationRuntime() *IntegrationRuntime

GetIntegrationRuntime implements the IntegrationRuntimeClassification interface for type ManagedIntegrationRuntime.

func (ManagedIntegrationRuntime) MarshalJSON 

func (m ManagedIntegrationRuntime) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIntegrationRuntime.

func (*ManagedIntegrationRuntime) UnmarshalJSON 

func (m *ManagedIntegrationRuntime) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIntegrationRuntime.

type ManagedIntegrationRuntimeError 

type ManagedIntegrationRuntimeError struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// READ-ONLY; Error code.
	Code *string

	// READ-ONLY; Error message.
	Message *string

	// READ-ONLY; Managed integration runtime error parameters.
	Parameters []*string

	// READ-ONLY; The time when the error occurred.
	Time *time.Time
}

ManagedIntegrationRuntimeError - Error definition for managed integration runtime.

func (ManagedIntegrationRuntimeError) MarshalJSON 

func (m ManagedIntegrationRuntimeError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIntegrationRuntimeError.

func (*ManagedIntegrationRuntimeError) UnmarshalJSON 

func (m *ManagedIntegrationRuntimeError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIntegrationRuntimeError.

type ManagedIntegrationRuntimeManagedVirtualNetworkReference added in v0.2.0 

type ManagedIntegrationRuntimeManagedVirtualNetworkReference struct {
	// The id of the managed virtual network.
	ID *string

	// The reference name of the managed virtual network.
	ReferenceName *string

	// The type of the managed virtual network.
	Type *string
}

ManagedIntegrationRuntimeManagedVirtualNetworkReference - Managed integration runtime managed virtual network reference.

func (ManagedIntegrationRuntimeManagedVirtualNetworkReference) MarshalJSON added in v0.6.0 

func (m ManagedIntegrationRuntimeManagedVirtualNetworkReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIntegrationRuntimeManagedVirtualNetworkReference.

func (*ManagedIntegrationRuntimeManagedVirtualNetworkReference) UnmarshalJSON added in v0.6.0 

func (m *ManagedIntegrationRuntimeManagedVirtualNetworkReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIntegrationRuntimeManagedVirtualNetworkReference.

type ManagedIntegrationRuntimeNode 

type ManagedIntegrationRuntimeNode struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// The errors that occurred on this integration runtime node.
	Errors []*ManagedIntegrationRuntimeError

	// READ-ONLY; The managed integration runtime node id.
	NodeID *string

	// READ-ONLY; The managed integration runtime node status.
	Status *ManagedIntegrationRuntimeNodeStatus
}

ManagedIntegrationRuntimeNode - Properties of integration runtime node.

func (ManagedIntegrationRuntimeNode) MarshalJSON 

func (m ManagedIntegrationRuntimeNode) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIntegrationRuntimeNode.

func (*ManagedIntegrationRuntimeNode) UnmarshalJSON 

func (m *ManagedIntegrationRuntimeNode) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIntegrationRuntimeNode.

type ManagedIntegrationRuntimeNodeStatus 

type ManagedIntegrationRuntimeNodeStatus string

ManagedIntegrationRuntimeNodeStatus - The managed integration runtime node status. 

const (
	ManagedIntegrationRuntimeNodeStatusAvailable   ManagedIntegrationRuntimeNodeStatus = "Available"
	ManagedIntegrationRuntimeNodeStatusRecycling   ManagedIntegrationRuntimeNodeStatus = "Recycling"
	ManagedIntegrationRuntimeNodeStatusStarting    ManagedIntegrationRuntimeNodeStatus = "Starting"
	ManagedIntegrationRuntimeNodeStatusUnavailable ManagedIntegrationRuntimeNodeStatus = "Unavailable"
)

func PossibleManagedIntegrationRuntimeNodeStatusValues 

func PossibleManagedIntegrationRuntimeNodeStatusValues() []ManagedIntegrationRuntimeNodeStatus

PossibleManagedIntegrationRuntimeNodeStatusValues returns the possible values for the ManagedIntegrationRuntimeNodeStatus const type.

type ManagedIntegrationRuntimeOperationResult 

type ManagedIntegrationRuntimeOperationResult struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// READ-ONLY; The activity id for the operation request.
	ActivityID *string

	// READ-ONLY; The error code.
	ErrorCode *string

	// READ-ONLY; Managed integration runtime error parameters.
	Parameters []*string

	// READ-ONLY; The operation result.
	Result *string

	// READ-ONLY; The start time of the operation.
	StartTime *time.Time

	// READ-ONLY; The operation type. Could be start or stop.
	Type *string
}

ManagedIntegrationRuntimeOperationResult - Properties of managed integration runtime operation result.

func (ManagedIntegrationRuntimeOperationResult) MarshalJSON 

func (m ManagedIntegrationRuntimeOperationResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIntegrationRuntimeOperationResult.

func (*ManagedIntegrationRuntimeOperationResult) UnmarshalJSON 

func (m *ManagedIntegrationRuntimeOperationResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIntegrationRuntimeOperationResult.

type ManagedIntegrationRuntimeStatus 

type ManagedIntegrationRuntimeStatus struct {
	// REQUIRED; Type of integration runtime.
	Type *IntegrationRuntimeType

	// REQUIRED; Managed integration runtime status type properties.
	TypeProperties *ManagedIntegrationRuntimeStatusTypeProperties

	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// READ-ONLY; The workspace name which the integration runtime belong to.
	DataFactoryName *string

	// READ-ONLY; The state of integration runtime.
	State *IntegrationRuntimeState
}

ManagedIntegrationRuntimeStatus - Managed integration runtime status.

func (*ManagedIntegrationRuntimeStatus) GetIntegrationRuntimeStatus added in v0.2.0 

func (m *ManagedIntegrationRuntimeStatus) GetIntegrationRuntimeStatus() *IntegrationRuntimeStatus

GetIntegrationRuntimeStatus implements the IntegrationRuntimeStatusClassification interface for type ManagedIntegrationRuntimeStatus.

func (ManagedIntegrationRuntimeStatus) MarshalJSON 

func (m ManagedIntegrationRuntimeStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIntegrationRuntimeStatus.

func (*ManagedIntegrationRuntimeStatus) UnmarshalJSON 

func (m *ManagedIntegrationRuntimeStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIntegrationRuntimeStatus.

type ManagedIntegrationRuntimeStatusTypeProperties 

type ManagedIntegrationRuntimeStatusTypeProperties struct {
	// READ-ONLY; The time at which the integration runtime was created, in ISO8601 format.
	CreateTime *time.Time

	// READ-ONLY; The last operation result that occurred on this integration runtime.
	LastOperation *ManagedIntegrationRuntimeOperationResult

	// READ-ONLY; The list of nodes for managed integration runtime.
	Nodes []*ManagedIntegrationRuntimeNode

	// READ-ONLY; The errors that occurred on this integration runtime.
	OtherErrors []*ManagedIntegrationRuntimeError
}

ManagedIntegrationRuntimeStatusTypeProperties - Managed integration runtime status type properties.

func (ManagedIntegrationRuntimeStatusTypeProperties) MarshalJSON 

func (m ManagedIntegrationRuntimeStatusTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIntegrationRuntimeStatusTypeProperties.

func (*ManagedIntegrationRuntimeStatusTypeProperties) UnmarshalJSON 

func (m *ManagedIntegrationRuntimeStatusTypeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIntegrationRuntimeStatusTypeProperties.

type ManagedIntegrationRuntimeTypeProperties 

type ManagedIntegrationRuntimeTypeProperties struct {
	// The compute resource for managed integration runtime.
	ComputeProperties *IntegrationRuntimeComputeProperties

	// SSIS properties for managed integration runtime.
	SsisProperties *IntegrationRuntimeSsisProperties
}

ManagedIntegrationRuntimeTypeProperties - Managed integration runtime type properties.

func (ManagedIntegrationRuntimeTypeProperties) MarshalJSON added in v0.6.0 

func (m ManagedIntegrationRuntimeTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIntegrationRuntimeTypeProperties.

func (*ManagedIntegrationRuntimeTypeProperties) UnmarshalJSON added in v0.6.0 

func (m *ManagedIntegrationRuntimeTypeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIntegrationRuntimeTypeProperties.

type ManagedVirtualNetworkSettings 

type ManagedVirtualNetworkSettings struct {
	// Allowed Aad Tenant Ids For Linking
	AllowedAADTenantIDsForLinking []*string

	// Linked Access Check On Target Resource
	LinkedAccessCheckOnTargetResource *bool

	// Prevent Data Exfiltration
	PreventDataExfiltration *bool
}

ManagedVirtualNetworkSettings - Managed Virtual Network Settings

func (ManagedVirtualNetworkSettings) MarshalJSON 

func (m ManagedVirtualNetworkSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedVirtualNetworkSettings.

func (*ManagedVirtualNetworkSettings) UnmarshalJSON added in v0.6.0 

func (m *ManagedVirtualNetworkSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedVirtualNetworkSettings.

type ManagementOperationState 

type ManagementOperationState string

ManagementOperationState - The operation state. 

const (
	ManagementOperationStateCancelInProgress ManagementOperationState = "CancelInProgress"
	ManagementOperationStateCancelled        ManagementOperationState = "Cancelled"
	ManagementOperationStateFailed           ManagementOperationState = "Failed"
	ManagementOperationStateInProgress       ManagementOperationState = "InProgress"
	ManagementOperationStatePending          ManagementOperationState = "Pending"
	ManagementOperationStateSucceeded        ManagementOperationState = "Succeeded"
)

func PossibleManagementOperationStateValues 

func PossibleManagementOperationStateValues() []ManagementOperationState

PossibleManagementOperationStateValues returns the possible values for the ManagementOperationState const type.

type MetadataSyncConfig 

type MetadataSyncConfig struct {
	// Metadata Sync Config properties
	Properties *MetadataSyncConfigProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

MetadataSyncConfig - Configuration for metadata sync

func (MetadataSyncConfig) MarshalJSON 

func (m MetadataSyncConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetadataSyncConfig.

func (*MetadataSyncConfig) UnmarshalJSON 

func (m *MetadataSyncConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetadataSyncConfig.

type MetadataSyncConfigProperties 

type MetadataSyncConfigProperties struct {
	// Indicates whether the metadata sync is enabled or disabled
	Enabled *bool

	// The Sync Interval in minutes.
	SyncIntervalInMinutes *int32
}

MetadataSyncConfigProperties - Metadata Sync Config properties

func (MetadataSyncConfigProperties) MarshalJSON added in v0.6.0 

func (m MetadataSyncConfigProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetadataSyncConfigProperties.

func (*MetadataSyncConfigProperties) UnmarshalJSON added in v0.6.0 

func (m *MetadataSyncConfigProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MetadataSyncConfigProperties.

type NodeSize 

type NodeSize string

NodeSize - The level of compute power that each node in the Big Data pool has. 

const (
	NodeSizeLarge    NodeSize = "Large"
	NodeSizeMedium   NodeSize = "Medium"
	NodeSizeNone     NodeSize = "None"
	NodeSizeSmall    NodeSize = "Small"
	NodeSizeXLarge   NodeSize = "XLarge"
	NodeSizeXXLarge  NodeSize = "XXLarge"
	NodeSizeXXXLarge NodeSize = "XXXLarge"
)

func PossibleNodeSizeValues 

func PossibleNodeSizeValues() []NodeSize

PossibleNodeSizeValues returns the possible values for the NodeSize const type.

type NodeSizeFamily 

type NodeSizeFamily string

NodeSizeFamily - The kind of nodes that the Big Data pool provides. 

const (
	NodeSizeFamilyHardwareAcceleratedFPGA NodeSizeFamily = "HardwareAcceleratedFPGA"
	NodeSizeFamilyHardwareAcceleratedGPU  NodeSizeFamily = "HardwareAcceleratedGPU"
	NodeSizeFamilyMemoryOptimized         NodeSizeFamily = "MemoryOptimized"
	NodeSizeFamilyNone                    NodeSizeFamily = "None"
)

func PossibleNodeSizeFamilyValues 

func PossibleNodeSizeFamilyValues() []NodeSizeFamily

PossibleNodeSizeFamilyValues returns the possible values for the NodeSizeFamily const type.

type Operation 

type Operation struct {
	// The object that describes the operation.
	Display *OperationDisplay

	// This is of the format {provider}/{resource}/{operation}.
	Name *string

	// The intended executor of the operation.
	Origin *string

	// Properties of the operation.
	Properties any
}

Operation - A REST API operation

func (Operation) MarshalJSON added in v0.6.0 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON added in v0.6.0 

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay 

type OperationDisplay struct {
	// The friendly name of the operation.
	Description *string

	// For example: read, write, delete.
	Operation *string

	// Friendly name of the resource provider.
	Provider *string

	// The resource type on which the operation is performed.
	Resource *string
}

OperationDisplay - The object that describes the operation.

func (OperationDisplay) MarshalJSON added in v0.6.0 

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON added in v0.6.0 

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	// The list of operations supported by the resource provider.
	Value []*Operation

	// READ-ONLY; The URL to get the next set of operation list results if there are any.
	NextLink *string
}

OperationListResult - Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

func (OperationListResult) MarshalJSON 

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

func (*OperationListResult) UnmarshalJSON added in v0.6.0 

func (o *OperationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.

type OperationMetaLogSpecification 

type OperationMetaLogSpecification struct {
	// Time range the log covers
	BlobDuration *string

	// Log display name
	DisplayName *string

	// Log unique name
	Name *string
}

OperationMetaLogSpecification - What is this?

func (OperationMetaLogSpecification) MarshalJSON added in v0.6.0 

func (o OperationMetaLogSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaLogSpecification.

func (*OperationMetaLogSpecification) UnmarshalJSON added in v0.6.0 

func (o *OperationMetaLogSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaLogSpecification.

type OperationMetaMetricDimensionSpecification 

type OperationMetaMetricDimensionSpecification struct {
	// Dimension display name
	DisplayName *string

	// Dimension unique name
	Name *string

	// Whether this metric should be exported for Shoebox
	ToBeExportedForShoebox *bool
}

OperationMetaMetricDimensionSpecification - What is this?

func (OperationMetaMetricDimensionSpecification) MarshalJSON added in v0.6.0 

func (o OperationMetaMetricDimensionSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaMetricDimensionSpecification.

func (*OperationMetaMetricDimensionSpecification) UnmarshalJSON added in v0.6.0 

func (o *OperationMetaMetricDimensionSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaMetricDimensionSpecification.

type OperationMetaMetricSpecification 

type OperationMetaMetricSpecification struct {
	// Metric aggregation type
	AggregationType *string

	// Metric dimensions
	Dimensions []*OperationMetaMetricDimensionSpecification

	// Metric description
	DisplayDescription *string

	// Metric display name
	DisplayName *string

	// Whether the regional MDM account is enabled
	EnableRegionalMdmAccount *bool

	// Metric filter
	MetricFilterPattern *string

	// Metric unique name
	Name *string

	// The source MDM account
	SourceMdmAccount *string

	// The source MDM namespace
	SourceMdmNamespace *string

	// Whether the metric supports instance-level aggregation
	SupportsInstanceLevelAggregation *bool

	// Metric units
	Unit *string
}

OperationMetaMetricSpecification - What is this?

func (OperationMetaMetricSpecification) MarshalJSON 

func (o OperationMetaMetricSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaMetricSpecification.

func (*OperationMetaMetricSpecification) UnmarshalJSON added in v0.6.0 

func (o *OperationMetaMetricSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaMetricSpecification.

type OperationMetaPropertyInfo 

type OperationMetaPropertyInfo struct {
	// Operation service specification
	ServiceSpecification *OperationMetaServiceSpecification
}

OperationMetaPropertyInfo - What is this?

func (OperationMetaPropertyInfo) MarshalJSON added in v0.6.0 

func (o OperationMetaPropertyInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaPropertyInfo.

func (*OperationMetaPropertyInfo) UnmarshalJSON added in v0.6.0 

func (o *OperationMetaPropertyInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaPropertyInfo.

type OperationMetaServiceSpecification 

type OperationMetaServiceSpecification struct {
	// Service log specifications
	LogSpecifications []*OperationMetaLogSpecification

	// Service metric specifications
	MetricSpecifications []*OperationMetaMetricSpecification
}

OperationMetaServiceSpecification - What is this?

func (OperationMetaServiceSpecification) MarshalJSON 

func (o OperationMetaServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaServiceSpecification.

func (*OperationMetaServiceSpecification) UnmarshalJSON added in v0.6.0 

func (o *OperationMetaServiceSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaServiceSpecification.

type OperationResource 

type OperationResource struct {
	// Operation start time
	EndTime *time.Time

	// Errors from the operation
	Error *ErrorDetail

	// Operation ID
	ID *string

	// Operation name
	Name *string

	// Completion percentage of the operation
	PercentComplete *float32

	// Operation properties
	Properties any

	// Operation start time
	StartTime *time.Time

	// Operation status
	Status *OperationStatus
}

OperationResource - An operation

func (OperationResource) MarshalJSON 

func (o OperationResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResource.

func (*OperationResource) UnmarshalJSON 

func (o *OperationResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResource.

type OperationStatus 

type OperationStatus string

OperationStatus - Operation status 

const (
	OperationStatusCanceled   OperationStatus = "Canceled"
	OperationStatusFailed     OperationStatus = "Failed"
	OperationStatusInProgress OperationStatus = "InProgress"
	OperationStatusSucceeded  OperationStatus = "Succeeded"
)

func PossibleOperationStatusValues 

func PossibleOperationStatusValues() []OperationStatus

PossibleOperationStatusValues returns the possible values for the OperationStatus const type.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) CheckNameAvailability 

func (client *OperationsClient) CheckNameAvailability(ctx context.Context, request CheckNameAvailabilityRequest, options *OperationsClientCheckNameAvailabilityOptions) (OperationsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Check whether a workspace name is available If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • request - The check request
  • options - OperationsClientCheckNameAvailabilityOptions contains the optional parameters for the OperationsClient.CheckNameAvailability method.
Example (CheckForAWorkspaceNameThatAlreadyExists)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CheckNameAvailabilityWorkspaceAlreadyExists.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOperationsClient().CheckNameAvailability(ctx, armsynapse.CheckNameAvailabilityRequest{
		Name: to.Ptr("workspace1"),
		Type: to.Ptr("Microsoft.Synapse/workspaces"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameAvailabilityResponse = armsynapse.CheckNameAvailabilityResponse{
	// 	Name: to.Ptr("workspace1"),
	// 	Available: to.Ptr(false),
	// 	Message: to.Ptr("Specified workspace name is already used"),
	// 	Reason: to.Ptr("AlreadyExists"),
	// }
}

Output:
Example (CheckForAWorkspaceNameThatIsAvailable)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CheckNameAvailabilityWorkspaceAvailable.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOperationsClient().CheckNameAvailability(ctx, armsynapse.CheckNameAvailabilityRequest{
		Name: to.Ptr("workspace1"),
		Type: to.Ptr("Microsoft.ProjectArcadia/workspaces"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameAvailabilityResponse = armsynapse.CheckNameAvailabilityResponse{
	// 	Name: to.Ptr("workspace1"),
	// 	Available: to.Ptr(true),
	// }
}

Output:

func (*OperationsClient) GetAzureAsyncHeaderResult 

func (client *OperationsClient) GetAzureAsyncHeaderResult(ctx context.Context, resourceGroupName string, workspaceName string, operationID string, options *OperationsClientGetAzureAsyncHeaderResultOptions) (OperationsClientGetAzureAsyncHeaderResultResponse, error)

GetAzureAsyncHeaderResult - Get the status of an operation If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • operationID - Operation ID
  • options - OperationsClientGetAzureAsyncHeaderResultOptions contains the optional parameters for the OperationsClient.GetAzureAsyncHeaderResult method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetAzureAsyncOperationHeader.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOperationsClient().GetAzureAsyncHeaderResult(ctx, "resourceGroup1", "workspace1", "01234567-89ab-4def-0123-456789abcdef", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OperationResource = armsynapse.OperationResource{
	// 	Status: to.Ptr(armsynapse.OperationStatusInProgress),
	// }
}

Output:

func (*OperationsClient) GetLocationHeaderResult 

func (client *OperationsClient) GetLocationHeaderResult(ctx context.Context, resourceGroupName string, workspaceName string, operationID string, options *OperationsClientGetLocationHeaderResultOptions) (OperationsClientGetLocationHeaderResultResponse, error)

GetLocationHeaderResult - Get the result of an operation If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • operationID - Operation ID
  • options - OperationsClientGetLocationHeaderResultOptions contains the optional parameters for the OperationsClient.GetLocationHeaderResult method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetLocationHeader.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewOperationsClient().GetLocationHeaderResult(ctx, "resourceGroup1", "workspace1", "01234567-89ab-4def-0123-456789abcdef", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*OperationsClient) List 

func (client *OperationsClient) List(ctx context.Context, options *OperationsClientListOptions) (OperationsClientListResponse, error)

List - Get all available operations If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetAvailableOperations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOperationsClient().List(ctx, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AvailableRpOperationArray = []*armsynapse.AvailableRpOperation{
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Get any Integration Runtime."),
	// 			Operation: to.Ptr("Get Integration Runtime Operation result."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Update Managed Identity SQL Control Settings on the workspace"),
	// 			Operation: to.Ptr("Update Managed Identity SQL Control Settings"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Managed Identity SQL Control Settings"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Get Managed Identity SQL Control Settings"),
	// 			Operation: to.Ptr("Get Managed Identity SQL Control Settings"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Managed Identity SQL Control Settings"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/operations/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read Available Operations from the Analytics 365 Resource Provider."),
	// 			Operation: to.Ptr("Read Available Operations."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Available Operations"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/nodes/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Get any Integration Runtime Node."),
	// 			Operation: to.Ptr("Get Integration Runtime Node."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/nodes/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Delete any Integration Runtime Node."),
	// 			Operation: to.Ptr("Delete Integration Runtime Node."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/nodes/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Patch any Integration Runtime Node."),
	// 			Operation: to.Ptr("Patch Integration Runtime Node."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/nodes/ipAddress/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Get Integration Runtime Ip Address"),
	// 			Operation: to.Ptr("Get Integration Runtime Ip Address"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationruntimes/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update any Integration Runtimes."),
	// 			Operation: to.Ptr("Create or Update Integration Runtimes."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Delete any Integration Runtime"),
	// 			Operation: to.Ptr("Delete Integration Runtimes"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/getStatus/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Get any Integration Runtime's Status"),
	// 			Operation: to.Ptr("Get an Integration Runtime Status"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/start/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Start any Integration Runtime"),
	// 			Operation: to.Ptr("Start an Integration Runtime"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/stop/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Stop any Integration Runtime"),
	// 			Operation: to.Ptr("Stop an Integration Runtime"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/getConnectionInfo/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Get Connection Info of any Integration Runtime"),
	// 			Operation: to.Ptr("Get Connection Info of an Integration Runtime"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/regenerateAuthKey/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Regenerate auth key of any Integration Runtime"),
	// 			Operation: to.Ptr("Regenerate auth key of an Integration Runtime"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/listAuthKeys/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("List Auth Keys of any Integration Runtime"),
	// 			Operation: to.Ptr("List Auth Keys of an Integration Runtime"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/removeNode/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Remove any Integration Runtime node"),
	// 			Operation: to.Ptr("Remove an Integration Runtime node"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/monitoringData/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Get any Integration Runtime's monitoring data"),
	// 			Operation: to.Ptr("Get an Integration Runtime's monitoring data"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/syncCredentials/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Sync credential on any Integration Runtime"),
	// 			Operation: to.Ptr("Sync credential on an Integration Runtime"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/upgrade/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Upgrade any Integration Runtime"),
	// 			Operation: to.Ptr("Upgrade an Integration Runtime"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/removeLinks/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Remove any Integration Runtime link"),
	// 			Operation: to.Ptr("Remove an Integration Runtime link"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/enableInteractiveQuery/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Enable Interactive query on any Integration Runtime"),
	// 			Operation: to.Ptr("Enable Interactive query on an Integration Runtime"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/disableInteractiveQuery/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Disable Interactive query on any Integration Runtime"),
	// 			Operation: to.Ptr("Disable Interactive query on an Integration Runtime"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/refreshObjectMetadata/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Refresh Object metadata on any Intergration Runtime"),
	// 			Operation: to.Ptr("Refresh Object metadata on an Intergration Runtime"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/integrationRuntimes/getObjectMetadata/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Get Object metadata on any Intergration Runtime"),
	// 			Operation: to.Ptr("Get Object metadata on an Intergration Runtime"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Integration Runtimes."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/firewallRules/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or update any IP Firewall Rule."),
	// 			Operation: to.Ptr("Create or update IP Firewall Rule."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("IP Firewall Rule."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/firewallRules/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read IP Firewall Rule"),
	// 			Operation: to.Ptr("Read IP Firewall Rule"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("IP Firewall Rule."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/firewallRules/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Delete any IP Firewall Rule."),
	// 			Operation: to.Ptr("Delete IP Firewall Rule"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("IP Firewall Rule."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/replaceAllIpFirewallRules/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Replaces all Ip Firewall Rules for the Workspace."),
	// 			Operation: to.Ptr("Replace all Ip Firewall Rules for the Workspace."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Workspaces"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update any SQL Analytics pools."),
	// 			Operation: to.Ptr("Create or Update SQL Analytics pools."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pools"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pools."),
	// 			Operation: to.Ptr("Read SQL Analytics pools."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pools"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataWarehouseQueries/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Queries."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Queries."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Queries"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Geo Backup Policies."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Geo Backup Policies."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Geo Backup Policies"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataWarehouseUserActivities/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool User Activities."),
	// 			Operation: to.Ptr("Read SQL Analytics pool User Activities."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool User Activities"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/restorePoints/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Restore Points."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Restore Points."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Restore Points"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataWarehouseQueries/dataWarehouseQuerySteps/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Query Steps."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Query Steps."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Query Steps"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/maintenanceWindows/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Maintenance Windows."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Maintenance Windows."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Maintenance Windows"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/maintenanceWindowOptions/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Maintenance Window Options."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Maintenance Window Options."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Maintenance Window Options"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/replicationLinks/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Replication Links."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Replication Links."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Replication Links"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Transparent Data Encryption Configuration."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Transparent Data Encryption Configuration."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Transparent Data Encryption Configuration"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption/operationResults/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Transparent Data Encryption Configuration Operation Results."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Transparent Data Encryption Configuration Operation Results."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Transparent Data Encryption Configuration Operation Results"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/auditingSettings/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Auditing Settings."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Auditing Settings."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Auditing Settings"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/operations/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Operations."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Operations."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Operations"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/usages/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Usages."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Usages."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Usages"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/currentSensitivityLabels/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Current Sensitivity Labels."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Current Sensitivity Labels."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Current Sensitivity Labels"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/recommendedSensitivityLabels/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Recommended Sensitivity Labels."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Recommended Sensitivity Labels."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Recommended Sensitivity Labels"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Schemas."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Schemas."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Schemas"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Schema Tables."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Schema Tables."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Schema Tables"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Schema Table Columns."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Schema Table Columns."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Schema Table Columns"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/connectionPolicies/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Connection Policies."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Connection Policies."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Connection Policies"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Vulnerability Assessment."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Vulnerability Assessment."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Vulnerability Assessment"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Vulnerability Assessment Scan Records."),
	// 			Operation: to.Ptr("Read SQL Analytics pool Vulnerability Assessment Scan Records."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Vulnerability Assessment Scan Records"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any Sql Analytics pool Threat Detection Policies."),
	// 			Operation: to.Ptr("Read Sql Analytics pool Threat Detection Policies."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Security Alert Policies"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Delete any SQL Analytics pools."),
	// 			Operation: to.Ptr("Delete SQL Analytics pools."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pools"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/pause/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Pause any SQL Analytics pools."),
	// 			Operation: to.Ptr("Pause SQL Analytics pools."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pools"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/resume/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Resume any SQL Analytics pools."),
	// 			Operation: to.Ptr("Resume SQL Analytics pools."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pools"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/restorePoints/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create a SQL Analytics pool Restore Point."),
	// 			Operation: to.Ptr("Create SQL Analytics pool Restore Point."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Restore Points"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/move/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Rename any SQL Analytics pools."),
	// 			Operation: to.Ptr("Rename SQL Analytics pools."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pools"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/enable/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Enable any SQL Analytics pool Sensitivity Labels."),
	// 			Operation: to.Ptr("Enable SQL Analytics pool Sensitivity Labels."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Sensitivity Labels"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/disable/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Disable any SQL Analytics pool Sensitivity Labels."),
	// 			Operation: to.Ptr("Disable SQL Analytics pool Sensitivity Labels."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Sensitivity Labels"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/initiateScan/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Initiate any SQL Analytics pool Vulnerability Assessment Scan Records."),
	// 			Operation: to.Ptr("Initiate SQL Analytics pool Vulnerability Assessment Scan Records."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Vulnerability Assessment Scan Records"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/export/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Export any SQL Analytics pool Vulnerability Assessment Scan Records."),
	// 			Operation: to.Ptr("Export SQL Analytics pool Vulnerability Assessment Scan Records."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Vulnerability Assessment Scan Records"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/maintenanceWindows/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any SQL Analytics pool Maintenance Windows."),
	// 			Operation: to.Ptr("Create or Update SQL Analytics pool Maintenance Windows."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Maintenance Windows"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/auditingSettings/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update any SQL Analytics pool Auditing Settings."),
	// 			Operation: to.Ptr("Create or Update SQL Analytics pool Auditing Settings."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Auditing Settings"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update any SQL Analytics pool Sensitivity Labels."),
	// 			Operation: to.Ptr("Create or update SQL Analytics pool Sensitivity Labels."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Sensitivity Labels"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update any SQL Analytics pool Transparent Data Encryption Configuration."),
	// 			Operation: to.Ptr("Create or Update SQL Analytics pool Transparent Data Encryption Configuration."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Transparent Data Encryption Configuration"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update any SQL Analytics pool Threat Detection Policies."),
	// 			Operation: to.Ptr("Create or Update SQL Analytics pool Threat Detection Policies."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Security Alert Policies"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update any SQL Analytics pool Vulnerability Assessment Rule Baseline."),
	// 			Operation: to.Ptr("Create or Update SQL Analytics pool Vulnerability Assessment Rule Baseline."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Vulnerability Assessment Rule Baseline"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Delete any SQL Analytics pool Sensitivity Labels."),
	// 			Operation: to.Ptr("Delete SQL Analytics pool Sensitivity Labels.2"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Sensitivity Labels"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Delete any SQL Analytics pool Vulnerability Assessment."),
	// 			Operation: to.Ptr("Delete SQL Analytics pool Vulnerability Assessment."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Vulnerability Assessment"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Delete any SQL Analytics pool Vulnerability Assessment Rule Baseline."),
	// 			Operation: to.Ptr("Delete SQL Analytics pool Vulnerability Assessment Rule Baseline."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Vulnerability Assessment Rule Baseline"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/operationStatus/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any Async Operation Status."),
	// 			Operation: to.Ptr("Read Async Operation Status."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Async Operation Status."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/operationResults/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any Async Operation Result."),
	// 			Operation: to.Ptr("Read Async Operation Result."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Async Operation Result"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/operationResults/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any Async Operation Result."),
	// 			Operation: to.Ptr("Read Async Operation Result."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Async Operation Result"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/checkNameAvailability/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Checks Workspace name availability."),
	// 			Operation: to.Ptr("Checks Workspace name availability."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Check Name Availability"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update any Spark pools."),
	// 			Operation: to.Ptr("Create or Update Spark pools."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Spark pools"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any Spark pools."),
	// 			Operation: to.Ptr("Read Spark pools."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Spark pools"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Delete any Spark pools."),
	// 			Operation: to.Ptr("Delete Spark pools."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Spark pools"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/metadataSync/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read SQL Analytics pool Metadata Sync Config"),
	// 			Operation: to.Ptr("Read SQL Analytics pool Metadata Sync Config"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Metadata Sync Config"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/metadataSync/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update SQL Analytics pool Metadata Sync Config"),
	// 			Operation: to.Ptr("Create or Update SQL Analytics pool Metadata Sync Config"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Metadata Sync Config"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/register/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Registers the Analytics 365 Resource Provider and enables the creation of Workspaces."),
	// 			Operation: to.Ptr("Registers the Analytics 365 Resource Provider."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Analytics 365 Resource Provider."),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/administrators/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Set Active Directory Administrator on the Workspace"),
	// 			Operation: to.Ptr("Set Active Directory Administrator"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Administrators"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/administrators/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Get Workspace Active Directory Administrator"),
	// 			Operation: to.Ptr("Get Workspace Active Directory Administrator"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Administrators"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/administrators/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Delete Workspace Active Directory Administrator"),
	// 			Operation: to.Ptr("Delete Workspace Active Directory Administrator"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Administrators"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update any Workspaces."),
	// 			Operation: to.Ptr("Create or Update Workspaces."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Workspaces"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any Workspaces."),
	// 			Operation: to.Ptr("Read Workspaces."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Workspaces"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Delete any Workspaces."),
	// 			Operation: to.Ptr("Delete Workspaces."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Workspaces"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/privateEndpointConnectionProxies/validate/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Validates Private Endpoint Connection Proxy"),
	// 			Operation: to.Ptr("Validates Private Endpoint Connection Proxy"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Validate Private Endpoint Connection Proxy"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/privateEndpointConnectionProxies/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update Private Endpoint Connection Proxy"),
	// 			Operation: to.Ptr("Create or Update Private Endpoint Connection Proxy"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Private Endpoint Connection Proxy"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/privateEndpointConnectionProxies/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read any Private Endpoint Connection Proxy"),
	// 			Operation: to.Ptr("Read Private Endpoint Connection Proxies"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Private Endpoint Connection Proxy"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/privateLinkResources/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Get a list of Private Link Resources"),
	// 			Operation: to.Ptr("Get Private Link Resources"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Private Link Resources"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/serverKeys/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Creates or updates a server key"),
	// 			Operation: to.Ptr("Creates or updates a server key"),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Key"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/serverKeys/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Deletes the server key with the given name."),
	// 			Operation: to.Ptr("Deletes the server key with the given name."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Key"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/extendedAuditingSettings/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update SQL server extended auditing settings."),
	// 			Operation: to.Ptr("Create or Update SQL server extended auditing settings."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Extended Auditing Settings"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/extendedAuditingSettings/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read SQL server extended auditing settings."),
	// 			Operation: to.Ptr("Read SQL server extended auditing settings."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Extended Auditing Settings"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/auditingSettings/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update SQL server auditing settings."),
	// 			Operation: to.Ptr("Create or Update SQL server auditing settings."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Auditing Settings"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/auditingSettings/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read SQL server auditing settings."),
	// 			Operation: to.Ptr("Read SQL server auditing settings."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Auditing Settings"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/securityAlertPolicies/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update SQL server security alert policies."),
	// 			Operation: to.Ptr("Create or Update SQL server security alert policies."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Security Alert Policy"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/securityAlertPolicies/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read SQL server security alert policies."),
	// 			Operation: to.Ptr("Read SQL server security alert policies."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Security Alert Policy"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/vulnerabilityAssessments/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Create or Update SQL server vulnerability assement report."),
	// 			Operation: to.Ptr("Create or Update SQL server vulnerability assement report."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Vulnerability Assesment"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/vulnerabilityAssessments/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Read SQL server vulnerability assement report."),
	// 			Operation: to.Ptr("Read SQL server vulnerability assement report."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Vulnerability Assesment"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/vulnerabilityAssessments/delete"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Delete SQL server vulnerability assement report."),
	// 			Operation: to.Ptr("Delete SQL server vulnerability assement report."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Vulnerability Assesment"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/encryptionProtector/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Update the properties for the specified Server Encryption Protector."),
	// 			Operation: to.Ptr("Update the properties for the specified Server Encryption Protector."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Encryption Protector"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/encryptionProtector/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Returns a list of server encryption protectors or gets the properties for the specified server encryption protector."),
	// 			Operation: to.Ptr("Returns a list of server encryption protectors or gets the properties for the specified server encryption protector."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Encryption Protector"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/encryptionProtector/revalidate/action"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Revalidates an existing encryption protector."),
	// 			Operation: to.Ptr("Revalidates an existing encryption protector."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Server Encryption Protector"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/providers/Microsoft.Insights/metricDefinitions/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Gets the available metrics for workspace"),
	// 			Operation: to.Ptr("Read workspace metric definitions"),
	// 			Provider: to.Ptr("Microsoft Azure Synapse Analytics"),
	// 			Resource: to.Ptr("Workspace"),
	// 		},
	// 		Origin: to.Ptr("system"),
	// 		Properties: &armsynapse.OperationMetaPropertyInfo{
	// 			ServiceSpecification: &armsynapse.OperationMetaServiceSpecification{
	// 				MetricSpecifications: []*armsynapse.OperationMetaMetricSpecification{
	// 					{
	// 						Name: to.Ptr("PipelineFailedRuns"),
	// 						AggregationType: to.Ptr("Total"),
	// 						Dimensions: []*armsynapse.OperationMetaMetricDimensionSpecification{
	// 							{
	// 								Name: to.Ptr("FailureType"),
	// 								DisplayName: to.Ptr("Failure Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("Name"),
	// 								DisplayName: to.Ptr("Pipeline"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 						}},
	// 						DisplayName: to.Ptr("Failed pipeline runs"),
	// 						SourceMdmAccount: to.Ptr("MicrosoftDataFactoryProdShoebox"),
	// 						SourceMdmNamespace: to.Ptr("ADFMetrics"),
	// 						Unit: to.Ptr("Count"),
	// 					},
	// 					{
	// 						Name: to.Ptr("PipelineSucceededRuns"),
	// 						AggregationType: to.Ptr("Total"),
	// 						Dimensions: []*armsynapse.OperationMetaMetricDimensionSpecification{
	// 							{
	// 								Name: to.Ptr("FailureType"),
	// 								DisplayName: to.Ptr("Failure Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("Name"),
	// 								DisplayName: to.Ptr("Pipeline"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 						}},
	// 						DisplayName: to.Ptr("Succeeded pipeline runs"),
	// 						SourceMdmAccount: to.Ptr("MicrosoftDataFactoryProdShoebox"),
	// 						SourceMdmNamespace: to.Ptr("ADFMetrics"),
	// 						Unit: to.Ptr("Count"),
	// 					},
	// 					{
	// 						Name: to.Ptr("PipelineCancelledRuns"),
	// 						AggregationType: to.Ptr("Total"),
	// 						Dimensions: []*armsynapse.OperationMetaMetricDimensionSpecification{
	// 							{
	// 								Name: to.Ptr("FailureType"),
	// 								DisplayName: to.Ptr("Failure Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("Name"),
	// 								DisplayName: to.Ptr("Pipeline"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 						}},
	// 						DisplayName: to.Ptr("Cancelled pipeline runs"),
	// 						SourceMdmAccount: to.Ptr("MicrosoftDataFactoryProdShoebox"),
	// 						SourceMdmNamespace: to.Ptr("ADFMetrics"),
	// 						Unit: to.Ptr("Count"),
	// 					},
	// 					{
	// 						Name: to.Ptr("ActivityFailedRuns"),
	// 						AggregationType: to.Ptr("Total"),
	// 						Dimensions: []*armsynapse.OperationMetaMetricDimensionSpecification{
	// 							{
	// 								Name: to.Ptr("ActivityType"),
	// 								DisplayName: to.Ptr("Activity Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("PipelineName"),
	// 								DisplayName: to.Ptr("Pipeline"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("FailureType"),
	// 								DisplayName: to.Ptr("Failure Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("Name"),
	// 								DisplayName: to.Ptr("Activity"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 						}},
	// 						DisplayName: to.Ptr("Failed activity runs"),
	// 						SourceMdmAccount: to.Ptr("MicrosoftDataFactoryProdShoebox"),
	// 						SourceMdmNamespace: to.Ptr("ADFMetrics"),
	// 						Unit: to.Ptr("Count"),
	// 					},
	// 					{
	// 						Name: to.Ptr("ActivitySucceededRuns"),
	// 						AggregationType: to.Ptr("Total"),
	// 						Dimensions: []*armsynapse.OperationMetaMetricDimensionSpecification{
	// 							{
	// 								Name: to.Ptr("ActivityType"),
	// 								DisplayName: to.Ptr("Activity Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("PipelineName"),
	// 								DisplayName: to.Ptr("Pipeline"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("FailureType"),
	// 								DisplayName: to.Ptr("Failure Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("Name"),
	// 								DisplayName: to.Ptr("Activity"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 						}},
	// 						DisplayName: to.Ptr("Succeeded activity runs"),
	// 						SourceMdmAccount: to.Ptr("MicrosoftDataFactoryProdShoebox"),
	// 						SourceMdmNamespace: to.Ptr("ADFMetrics"),
	// 						Unit: to.Ptr("Count"),
	// 					},
	// 					{
	// 						Name: to.Ptr("ActivityCancelledRuns"),
	// 						AggregationType: to.Ptr("Total"),
	// 						Dimensions: []*armsynapse.OperationMetaMetricDimensionSpecification{
	// 							{
	// 								Name: to.Ptr("ActivityType"),
	// 								DisplayName: to.Ptr("Activity Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("PipelineName"),
	// 								DisplayName: to.Ptr("Pipeline"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("FailureType"),
	// 								DisplayName: to.Ptr("Failure Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("Name"),
	// 								DisplayName: to.Ptr("Activity"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 						}},
	// 						DisplayName: to.Ptr("Cancelled activity runs"),
	// 						SourceMdmAccount: to.Ptr("MicrosoftDataFactoryProdShoebox"),
	// 						SourceMdmNamespace: to.Ptr("ADFMetrics"),
	// 						Unit: to.Ptr("Count"),
	// 					},
	// 					{
	// 						Name: to.Ptr("TriggerFailedRuns"),
	// 						AggregationType: to.Ptr("Total"),
	// 						Dimensions: []*armsynapse.OperationMetaMetricDimensionSpecification{
	// 							{
	// 								Name: to.Ptr("Name"),
	// 								DisplayName: to.Ptr("Trigger"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("FailureType"),
	// 								DisplayName: to.Ptr("Failure Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 						}},
	// 						DisplayName: to.Ptr("Failed trigger runs"),
	// 						SourceMdmAccount: to.Ptr("MicrosoftDataFactoryProdShoebox"),
	// 						SourceMdmNamespace: to.Ptr("ADFMetrics"),
	// 						Unit: to.Ptr("Count"),
	// 					},
	// 					{
	// 						Name: to.Ptr("TriggerSucceededRuns"),
	// 						AggregationType: to.Ptr("Total"),
	// 						Dimensions: []*armsynapse.OperationMetaMetricDimensionSpecification{
	// 							{
	// 								Name: to.Ptr("Name"),
	// 								DisplayName: to.Ptr("Trigger"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("FailureType"),
	// 								DisplayName: to.Ptr("Failure Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 						}},
	// 						DisplayName: to.Ptr("Succeeded trigger runs"),
	// 						SourceMdmAccount: to.Ptr("MicrosoftDataFactoryProdShoebox"),
	// 						SourceMdmNamespace: to.Ptr("ADFMetrics"),
	// 						Unit: to.Ptr("Count"),
	// 					},
	// 					{
	// 						Name: to.Ptr("TriggerCancelledRuns"),
	// 						AggregationType: to.Ptr("Total"),
	// 						Dimensions: []*armsynapse.OperationMetaMetricDimensionSpecification{
	// 							{
	// 								Name: to.Ptr("Name"),
	// 								DisplayName: to.Ptr("Trigger"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 							},
	// 							{
	// 								Name: to.Ptr("FailureType"),
	// 								DisplayName: to.Ptr("Failure Type"),
	// 								ToBeExportedForShoebox: to.Ptr(true),
	// 						}},
	// 						DisplayName: to.Ptr("Cancelled trigger runs"),
	// 						SourceMdmAccount: to.Ptr("MicrosoftDataFactoryProdShoebox"),
	// 						SourceMdmNamespace: to.Ptr("ADFMetrics"),
	// 						Unit: to.Ptr("Count"),
	// 				}},
	// 			},
	// 		},
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/providers/Microsoft.Insights/diagnosticSettings/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Gets the diagnostic setting for the resource"),
	// 			Operation: to.Ptr("Read diagnostic setting"),
	// 			Provider: to.Ptr("Microsoft Azure Synapse Analytics"),
	// 			Resource: to.Ptr("Workspace"),
	// 		},
	// 		Origin: to.Ptr("system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/providers/Microsoft.Insights/diagnosticSettings/write"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Creates or updates the diagnostic setting for the resource"),
	// 			Operation: to.Ptr("Write diagnostic setting"),
	// 			Provider: to.Ptr("Microsoft Azure Synapse Analytics"),
	// 			Resource: to.Ptr("Workspace"),
	// 		},
	// 		Origin: to.Ptr("system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/providers/Microsoft.Insights/logDefinitions/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Gets the available logs for workspace"),
	// 			Operation: to.Ptr("Read workspace log definitions"),
	// 			Provider: to.Ptr("Microsoft Azure Synapse Analytics"),
	// 			Resource: to.Ptr("The log definition of workspace"),
	// 		},
	// 		Origin: to.Ptr("system"),
	// 		Properties: &armsynapse.OperationMetaPropertyInfo{
	// 			ServiceSpecification: &armsynapse.OperationMetaServiceSpecification{
	// 				LogSpecifications: []*armsynapse.OperationMetaLogSpecification{
	// 					{
	// 						Name: to.Ptr("ActivityRuns"),
	// 						BlobDuration: to.Ptr("PT1H"),
	// 						DisplayName: to.Ptr("Activity runs"),
	// 					},
	// 					{
	// 						Name: to.Ptr("PipelineRuns"),
	// 						BlobDuration: to.Ptr("PT1H"),
	// 						DisplayName: to.Ptr("Pipeline runs"),
	// 					},
	// 					{
	// 						Name: to.Ptr("TriggerRuns"),
	// 						BlobDuration: to.Ptr("PT1H"),
	// 						DisplayName: to.Ptr("Trigger runs"),
	// 				}},
	// 			},
	// 		},
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/recoverableSqlPools/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Gets recoverable SQL Analytics Pools, which are the resources representing geo backups of SQL Analytics Pools."),
	// 			Operation: to.Ptr("Gets recoverable SQL Analytics Pools."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("Recoverable Sql Analytics Pools"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Synapse/workspaces/sqlUsages/read"),
	// 		Display: &armsynapse.AvailableRpOperationDisplayInfo{
	// 			Description: to.Ptr("Gets usage limits available for SQL Analytics Pools."),
	// 			Operation: to.Ptr("Gets usage limits available for SQL Analytics Pools."),
	// 			Provider: to.Ptr("Analytics 365 Resource Provider."),
	// 			Resource: to.Ptr("SQL Analytics pool Usages"),
	// 		},
	// 		IsDataAction: to.Ptr("false"),
	// 		Origin: to.Ptr("user, system"),
	// }}
}

Output:

type OperationsClientCheckNameAvailabilityOptions added in v0.2.0 

type OperationsClientCheckNameAvailabilityOptions struct {
}

OperationsClientCheckNameAvailabilityOptions contains the optional parameters for the OperationsClient.CheckNameAvailability method.

type OperationsClientCheckNameAvailabilityResponse added in v0.2.0 

type OperationsClientCheckNameAvailabilityResponse struct {
	// A response saying whether the workspace name is available
	CheckNameAvailabilityResponse
}

OperationsClientCheckNameAvailabilityResponse contains the response from method OperationsClient.CheckNameAvailability.

type OperationsClientGetAzureAsyncHeaderResultOptions added in v0.2.0 

type OperationsClientGetAzureAsyncHeaderResultOptions struct {
}

OperationsClientGetAzureAsyncHeaderResultOptions contains the optional parameters for the OperationsClient.GetAzureAsyncHeaderResult method.

type OperationsClientGetAzureAsyncHeaderResultResponse added in v0.2.0 

type OperationsClientGetAzureAsyncHeaderResultResponse struct {
	// An operation
	OperationResource
}

OperationsClientGetAzureAsyncHeaderResultResponse contains the response from method OperationsClient.GetAzureAsyncHeaderResult.

type OperationsClientGetLocationHeaderResultOptions added in v0.2.0 

type OperationsClientGetLocationHeaderResultOptions struct {
}

OperationsClientGetLocationHeaderResultOptions contains the optional parameters for the OperationsClient.GetLocationHeaderResult method.

type OperationsClientGetLocationHeaderResultResponse added in v0.2.0 

type OperationsClientGetLocationHeaderResultResponse struct {
}

OperationsClientGetLocationHeaderResultResponse contains the response from method OperationsClient.GetLocationHeaderResult.

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.2.0 

type OperationsClientListResponse struct {
	// Array of AvailableRpOperation
	AvailableRpOperationArray []*AvailableRpOperation
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OptimizedAutoscale 

type OptimizedAutoscale struct {
	// REQUIRED; A boolean value that indicate if the optimized autoscale feature is enabled or not.
	IsEnabled *bool

	// REQUIRED; Maximum allowed instances count.
	Maximum *int32

	// REQUIRED; Minimum allowed instances count.
	Minimum *int32

	// REQUIRED; The version of the template defined, for instance 1.
	Version *int32
}

OptimizedAutoscale - A class that contains the optimized auto scale definition.

func (OptimizedAutoscale) MarshalJSON added in v0.6.0 

func (o OptimizedAutoscale) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OptimizedAutoscale.

func (*OptimizedAutoscale) UnmarshalJSON added in v0.6.0 

func (o *OptimizedAutoscale) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OptimizedAutoscale.

type PrincipalType 

type PrincipalType string

PrincipalType - Principal type. 

const (
	PrincipalTypeApp   PrincipalType = "App"
	PrincipalTypeGroup PrincipalType = "Group"
	PrincipalTypeUser  PrincipalType = "User"
)

func PossiblePrincipalTypeValues 

func PossiblePrincipalTypeValues() []PrincipalType

PossiblePrincipalTypeValues returns the possible values for the PrincipalType const type.

type PrincipalsModificationKind added in v0.2.0 

type PrincipalsModificationKind string

PrincipalsModificationKind - The principals modification kind of the database 

const (
	PrincipalsModificationKindNone    PrincipalsModificationKind = "None"
	PrincipalsModificationKindReplace PrincipalsModificationKind = "Replace"
	PrincipalsModificationKindUnion   PrincipalsModificationKind = "Union"
)

func PossiblePrincipalsModificationKindValues added in v0.2.0 

func PossiblePrincipalsModificationKindValues() []PrincipalsModificationKind

PossiblePrincipalsModificationKindValues returns the possible values for the PrincipalsModificationKind const type.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// READ-ONLY; Resource id of the private endpoint.
	ID *string
}

PrivateEndpoint - Private endpoint details

func (PrivateEndpoint) MarshalJSON added in v0.6.0 

func (p PrivateEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpoint.

func (*PrivateEndpoint) UnmarshalJSON added in v0.6.0 

func (p *PrivateEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpoint.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// Private endpoint connection properties.
	Properties *PrivateEndpointConnectionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

PrivateEndpointConnection - A private endpoint connection

func (PrivateEndpointConnection) MarshalJSON 

func (p PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON 

func (p *PrivateEndpointConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionForPrivateLinkHub 

type PrivateEndpointConnectionForPrivateLinkHub struct {
	ID   *string
	Name *string

	// Properties of a private endpoint connection.
	Properties *PrivateEndpointConnectionProperties
	Type       *string
}

func (PrivateEndpointConnectionForPrivateLinkHub) MarshalJSON added in v0.6.0 

func (p PrivateEndpointConnectionForPrivateLinkHub) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionForPrivateLinkHub.

func (*PrivateEndpointConnectionForPrivateLinkHub) UnmarshalJSON added in v0.6.0 

func (p *PrivateEndpointConnectionForPrivateLinkHub) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionForPrivateLinkHub.

type PrivateEndpointConnectionForPrivateLinkHubBasic 

type PrivateEndpointConnectionForPrivateLinkHubBasic struct {
	// Properties of private endpoint connection for private link hub
	Properties *PrivateEndpointConnectionProperties

	// READ-ONLY; identifier
	ID *string
}

PrivateEndpointConnectionForPrivateLinkHubBasic - Private Endpoint Connection For Private Link Hub - Basic

func (PrivateEndpointConnectionForPrivateLinkHubBasic) MarshalJSON added in v0.6.0 

func (p PrivateEndpointConnectionForPrivateLinkHubBasic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionForPrivateLinkHubBasic.

func (*PrivateEndpointConnectionForPrivateLinkHubBasic) UnmarshalJSON added in v0.6.0 

func (p *PrivateEndpointConnectionForPrivateLinkHubBasic) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionForPrivateLinkHubBasic.

type PrivateEndpointConnectionForPrivateLinkHubBasicAutoGenerated 

type PrivateEndpointConnectionForPrivateLinkHubBasicAutoGenerated struct {
	ID *string

	// Properties of a private endpoint connection.
	Properties *PrivateEndpointConnectionProperties
}

func (PrivateEndpointConnectionForPrivateLinkHubBasicAutoGenerated) MarshalJSON added in v0.6.0 

func (p PrivateEndpointConnectionForPrivateLinkHubBasicAutoGenerated) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionForPrivateLinkHubBasicAutoGenerated.

func (*PrivateEndpointConnectionForPrivateLinkHubBasicAutoGenerated) UnmarshalJSON added in v0.6.0 

func (p *PrivateEndpointConnectionForPrivateLinkHubBasicAutoGenerated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionForPrivateLinkHubBasicAutoGenerated.

type PrivateEndpointConnectionForPrivateLinkHubResourceCollectionResponse 

type PrivateEndpointConnectionForPrivateLinkHubResourceCollectionResponse struct {
	NextLink *string
	Value    []*PrivateEndpointConnectionForPrivateLinkHub
}

func (PrivateEndpointConnectionForPrivateLinkHubResourceCollectionResponse) MarshalJSON 

func (p PrivateEndpointConnectionForPrivateLinkHubResourceCollectionResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionForPrivateLinkHubResourceCollectionResponse.

func (*PrivateEndpointConnectionForPrivateLinkHubResourceCollectionResponse) UnmarshalJSON added in v0.6.0 

func (p *PrivateEndpointConnectionForPrivateLinkHubResourceCollectionResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionForPrivateLinkHubResourceCollectionResponse.

type PrivateEndpointConnectionList 

type PrivateEndpointConnectionList struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*PrivateEndpointConnection
}

PrivateEndpointConnectionList - A list of private endpoint connections

func (PrivateEndpointConnectionList) MarshalJSON 

func (p PrivateEndpointConnectionList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionList.

func (*PrivateEndpointConnectionList) UnmarshalJSON added in v0.6.0 

func (p *PrivateEndpointConnectionList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionList.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// The private endpoint which the connection belongs to.
	PrivateEndpoint *PrivateEndpoint

	// Connection state of the private endpoint connection.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState

	// READ-ONLY; Provisioning state of the private endpoint connection.
	ProvisioningState *string
}

PrivateEndpointConnectionProperties - Properties of a private endpoint connection.

func (PrivateEndpointConnectionProperties) MarshalJSON added in v0.6.0 

func (p PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.

func (*PrivateEndpointConnectionProperties) UnmarshalJSON added in v0.6.0 

func (p *PrivateEndpointConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) BeginCreate 

func (client *PrivateEndpointConnectionsClient) BeginCreate(ctx context.Context, resourceGroupName string, workspaceName string, privateEndpointConnectionName string, request PrivateEndpointConnection, options *PrivateEndpointConnectionsClientBeginCreateOptions) (*runtime.Poller[PrivateEndpointConnectionsClientCreateResponse], error)

BeginCreate - Approve or reject a private endpoint connection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • privateEndpointConnectionName - The name of the private endpoint connection.
  • request - Request body of private endpoint connection to create.
  • options - PrivateEndpointConnectionsClientBeginCreateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ApprovePrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginCreate(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExamplePrivateEndpointConnection", armsynapse.PrivateEndpointConnection{
		Properties: &armsynapse.PrivateEndpointConnectionProperties{
			PrivateLinkServiceConnectionState: &armsynapse.PrivateLinkServiceConnectionState{
				Description: to.Ptr("Approved by abc@example.com"),
				Status:      to.Ptr("Approved"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateEndpointConnection = armsynapse.PrivateEndpointConnection{
	// 	Name: to.Ptr("sql"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/privateEndpointConnections"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection"),
	// 	Properties: &armsynapse.PrivateEndpointConnectionProperties{
	// 		PrivateEndpoint: &armsynapse.PrivateEndpoint{
	// 			ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armsynapse.PrivateLinkServiceConnectionState{
	// 			Description: to.Ptr("Auto-approved"),
	// 			ActionsRequired: to.Ptr("None"),
	// 			Status: to.Ptr("Approved"),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

Output:

func (*PrivateEndpointConnectionsClient) BeginDelete 

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointConnectionsClientDeleteResponse], error)

BeginDelete - Delete a private endpoint connection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • privateEndpointConnectionName - The name of the private endpoint connection.
  • options - PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeletePrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginDelete(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExamplePrivateEndpointConnection", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*PrivateEndpointConnectionsClient) Get 

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Gets a private endpoint connection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • privateEndpointConnectionName - The name of the private endpoint connection.
  • options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateEndpointConnectionsClient().Get(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExamplePrivateEndpointConnection", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateEndpointConnection = armsynapse.PrivateEndpointConnection{
	// 	Name: to.Ptr("sql"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/privateEndpointConnections"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection"),
	// 	Properties: &armsynapse.PrivateEndpointConnectionProperties{
	// 		PrivateEndpoint: &armsynapse.PrivateEndpoint{
	// 			ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armsynapse.PrivateLinkServiceConnectionState{
	// 			Description: to.Ptr("Auto-approved"),
	// 			ActionsRequired: to.Ptr("None"),
	// 			Status: to.Ptr("Approved"),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

Output:

func (*PrivateEndpointConnectionsClient) NewListPager added in v0.4.0 

func (client *PrivateEndpointConnectionsClient) NewListPager(resourceGroupName string, workspaceName string, options *PrivateEndpointConnectionsClientListOptions) *runtime.Pager[PrivateEndpointConnectionsClientListResponse]

NewListPager - Lists private endpoint connection in workspace.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListPrivateEndpointConnections.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListPager("ExampleResourceGroup", "ExampleWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateEndpointConnectionList = armsynapse.PrivateEndpointConnectionList{
		// 	Value: []*armsynapse.PrivateEndpointConnection{
		// 		{
		// 			Name: to.Ptr("sql"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/privateEndpointConnections"),
		// 			ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection"),
		// 			Properties: &armsynapse.PrivateEndpointConnectionProperties{
		// 				PrivateEndpoint: &armsynapse.PrivateEndpoint{
		// 					ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"),
		// 				},
		// 				PrivateLinkServiceConnectionState: &armsynapse.PrivateLinkServiceConnectionState{
		// 					Description: to.Ptr("Auto-approved"),
		// 					ActionsRequired: to.Ptr("None"),
		// 					Status: to.Ptr("Approved"),
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type PrivateEndpointConnectionsClientBeginCreateOptions added in v0.2.0 

type PrivateEndpointConnectionsClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointConnectionsClientBeginCreateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreate method.

type PrivateEndpointConnectionsClientBeginDeleteOptions added in v0.2.0 

type PrivateEndpointConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientCreateResponse added in v0.2.0 

type PrivateEndpointConnectionsClientCreateResponse struct {
	// A private endpoint connection
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateResponse contains the response from method PrivateEndpointConnectionsClient.BeginCreate.

type PrivateEndpointConnectionsClientDeleteResponse added in v0.2.0 

type PrivateEndpointConnectionsClientDeleteResponse struct {
	// An operation
	OperationResource
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.BeginDelete.

type PrivateEndpointConnectionsClientGetOptions added in v0.2.0 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.2.0 

type PrivateEndpointConnectionsClientGetResponse struct {
	// A private endpoint connection
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListOptions added in v0.2.0 

type PrivateEndpointConnectionsClientListOptions struct {
}

PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListPager method.

type PrivateEndpointConnectionsClientListResponse added in v0.2.0 

type PrivateEndpointConnectionsClientListResponse struct {
	// A list of private endpoint connections
	PrivateEndpointConnectionList
}

PrivateEndpointConnectionsClientListResponse contains the response from method PrivateEndpointConnectionsClient.NewListPager.

type PrivateEndpointConnectionsPrivateLinkHubClient 

type PrivateEndpointConnectionsPrivateLinkHubClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionsPrivateLinkHubClient contains the methods for the PrivateEndpointConnectionsPrivateLinkHub group. Don't use this type directly, use NewPrivateEndpointConnectionsPrivateLinkHubClient() instead.

func NewPrivateEndpointConnectionsPrivateLinkHubClient 

func NewPrivateEndpointConnectionsPrivateLinkHubClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsPrivateLinkHubClient, error)

NewPrivateEndpointConnectionsPrivateLinkHubClient creates a new instance of PrivateEndpointConnectionsPrivateLinkHubClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsPrivateLinkHubClient) Get 

func (client *PrivateEndpointConnectionsPrivateLinkHubClient) Get(ctx context.Context, resourceGroupName string, privateLinkHubName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsPrivateLinkHubClientGetOptions) (PrivateEndpointConnectionsPrivateLinkHubClientGetResponse, error)

Get - Get all PrivateEndpointConnection in the PrivateLinkHub by name If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • privateLinkHubName - Name of the privateLinkHub
  • privateEndpointConnectionName - Name of the privateEndpointConnection
  • options - PrivateEndpointConnectionsPrivateLinkHubClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsPrivateLinkHubClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/PrivateEndpointConnectionsPrivateLinkHub_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateEndpointConnectionsPrivateLinkHubClient().Get(ctx, "gh-res-grp", "pe0", "pe0-f3ed30f5-338c-4855-a542-24a403694ad2", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateEndpointConnectionForPrivateLinkHub = armsynapse.PrivateEndpointConnectionForPrivateLinkHub{
	// 	ID: to.Ptr("/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Synapse/privateLinkHubs/plh900/privateEndpointConnections/pe0-f3ed30f5-338c-4855-a542-24a403694ad2"),
	// 	Properties: &armsynapse.PrivateEndpointConnectionProperties{
	// 		PrivateEndpoint: &armsynapse.PrivateEndpoint{
	// 			ID: to.Ptr("/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Network/privateEndpoints/pe0"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armsynapse.PrivateLinkServiceConnectionState{
	// 			Status: to.Ptr("Approved"),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// 	Name: to.Ptr("pe0-f3ed30f5-338c-4855-a542-24a403694ad2"),
	// 	Type: to.Ptr("Microsoft.Synapse/privateLinkHubs/privateEndpointConnections"),
	// }
}

Output:

func (*PrivateEndpointConnectionsPrivateLinkHubClient) NewListPager added in v0.4.0 

func (client *PrivateEndpointConnectionsPrivateLinkHubClient) NewListPager(resourceGroupName string, privateLinkHubName string, options *PrivateEndpointConnectionsPrivateLinkHubClientListOptions) *runtime.Pager[PrivateEndpointConnectionsPrivateLinkHubClientListResponse]

NewListPager - Get all PrivateEndpointConnections in the PrivateLinkHub

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • privateLinkHubName - Name of the privateLinkHub
  • options - PrivateEndpointConnectionsPrivateLinkHubClientListOptions contains the optional parameters for the PrivateEndpointConnectionsPrivateLinkHubClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/PrivateEndpointConnectionsPrivateLinkHub_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateEndpointConnectionsPrivateLinkHubClient().NewListPager("gh-res-grp", "pe0", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateEndpointConnectionForPrivateLinkHubResourceCollectionResponse = armsynapse.PrivateEndpointConnectionForPrivateLinkHubResourceCollectionResponse{
		// 	Value: []*armsynapse.PrivateEndpointConnectionForPrivateLinkHub{
		// 		{
		// 			ID: to.Ptr("/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Synapse/privateLinkHubs/plh900/privateEndpointConnections/pe0-f3ed30f5-338c-4855-a542-24a403694ad2"),
		// 			Properties: &armsynapse.PrivateEndpointConnectionProperties{
		// 				PrivateEndpoint: &armsynapse.PrivateEndpoint{
		// 					ID: to.Ptr("/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Network/privateEndpoints/pe0"),
		// 				},
		// 				PrivateLinkServiceConnectionState: &armsynapse.PrivateLinkServiceConnectionState{
		// 					Status: to.Ptr("Approved"),
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 			},
		// 			Name: to.Ptr("pe0-f3ed30f5-338c-4855-a542-24a403694ad2"),
		// 			Type: to.Ptr("Microsoft.Synapse/privateLinkHubs/privateEndpointConnections"),
		// 		},
		// 		{
		// 			ID: to.Ptr("/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Synapse/privateLinkHubs/plh900/privateEndpointConnections/pe-xbox-3e425dc3-edd9-434c-9bca-3ac6cecbc7e4"),
		// 			Properties: &armsynapse.PrivateEndpointConnectionProperties{
		// 				PrivateEndpoint: &armsynapse.PrivateEndpoint{
		// 					ID: to.Ptr("/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Network/privateEndpoints/pe-xbox"),
		// 				},
		// 				PrivateLinkServiceConnectionState: &armsynapse.PrivateLinkServiceConnectionState{
		// 					Status: to.Ptr("Approved"),
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 			},
		// 			Name: to.Ptr("pe-xbox-3e425dc3-edd9-434c-9bca-3ac6cecbc7e4"),
		// 			Type: to.Ptr("Microsoft.Synapse/privateLinkHubs/privateEndpointConnections"),
		// 	}},
		// }
	}
}

Output:

type PrivateEndpointConnectionsPrivateLinkHubClientGetOptions added in v0.2.0 

type PrivateEndpointConnectionsPrivateLinkHubClientGetOptions struct {
}

PrivateEndpointConnectionsPrivateLinkHubClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsPrivateLinkHubClient.Get method.

type PrivateEndpointConnectionsPrivateLinkHubClientGetResponse added in v0.2.0 

type PrivateEndpointConnectionsPrivateLinkHubClientGetResponse struct {
	PrivateEndpointConnectionForPrivateLinkHub
}

PrivateEndpointConnectionsPrivateLinkHubClientGetResponse contains the response from method PrivateEndpointConnectionsPrivateLinkHubClient.Get.

type PrivateEndpointConnectionsPrivateLinkHubClientListOptions added in v0.2.0 

type PrivateEndpointConnectionsPrivateLinkHubClientListOptions struct {
}

PrivateEndpointConnectionsPrivateLinkHubClientListOptions contains the optional parameters for the PrivateEndpointConnectionsPrivateLinkHubClient.NewListPager method.

type PrivateEndpointConnectionsPrivateLinkHubClientListResponse added in v0.2.0 

type PrivateEndpointConnectionsPrivateLinkHubClientListResponse struct {
	PrivateEndpointConnectionForPrivateLinkHubResourceCollectionResponse
}

PrivateEndpointConnectionsPrivateLinkHubClientListResponse contains the response from method PrivateEndpointConnectionsPrivateLinkHubClient.NewListPager.

type PrivateLinkHub 

type PrivateLinkHub struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// PrivateLinkHub resource properties
	Properties *PrivateLinkHubProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

PrivateLinkHub - A privateLinkHub

func (PrivateLinkHub) MarshalJSON 

func (p PrivateLinkHub) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkHub.

func (*PrivateLinkHub) UnmarshalJSON 

func (p *PrivateLinkHub) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkHub.

type PrivateLinkHubInfoListResult 

type PrivateLinkHubInfoListResult struct {
	// Link to the next page of results
	NextLink *string

	// List of privateLinkHubs
	Value []*PrivateLinkHub
}

PrivateLinkHubInfoListResult - List of privateLinkHubs

func (PrivateLinkHubInfoListResult) MarshalJSON 

func (p PrivateLinkHubInfoListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkHubInfoListResult.

func (*PrivateLinkHubInfoListResult) UnmarshalJSON added in v0.6.0 

func (p *PrivateLinkHubInfoListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkHubInfoListResult.

type PrivateLinkHubPatchInfo 

type PrivateLinkHubPatchInfo struct {
	// Resource tags
	Tags map[string]*string
}

PrivateLinkHubPatchInfo - PrivateLinkHub patch details

func (PrivateLinkHubPatchInfo) MarshalJSON 

func (p PrivateLinkHubPatchInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkHubPatchInfo.

func (*PrivateLinkHubPatchInfo) UnmarshalJSON added in v0.6.0 

func (p *PrivateLinkHubPatchInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkHubPatchInfo.

type PrivateLinkHubPrivateLinkResourcesClient 

type PrivateLinkHubPrivateLinkResourcesClient struct {
	// contains filtered or unexported fields
}

PrivateLinkHubPrivateLinkResourcesClient contains the methods for the PrivateLinkHubPrivateLinkResources group. Don't use this type directly, use NewPrivateLinkHubPrivateLinkResourcesClient() instead.

func NewPrivateLinkHubPrivateLinkResourcesClient 

func NewPrivateLinkHubPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkHubPrivateLinkResourcesClient, error)

NewPrivateLinkHubPrivateLinkResourcesClient creates a new instance of PrivateLinkHubPrivateLinkResourcesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateLinkHubPrivateLinkResourcesClient) Get 

func (client *PrivateLinkHubPrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, privateLinkHubName string, privateLinkResourceName string, options *PrivateLinkHubPrivateLinkResourcesClientGetOptions) (PrivateLinkHubPrivateLinkResourcesClientGetResponse, error)

Get - Get private link resource in private link hub If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • privateLinkHubName - The name of the private link hub
  • privateLinkResourceName - The name of the private link resource
  • options - PrivateLinkHubPrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkHubPrivateLinkResourcesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetPrivateLinkHubPrivateLinkResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateLinkHubPrivateLinkResourcesClient().Get(ctx, "ExampleResourceGroup", "ExamplePrivateLinkHub", "sql", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateLinkResource = armsynapse.PrivateLinkResource{
	// 	Name: to.Ptr("sql"),
	// 	Type: to.Ptr("Microsoft.Synapse/privateLinkHubs/privateLinkResources"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/privateLinkHubs/ExamplePrivateLinkHub/privateLinkResources/sql"),
	// 	Properties: &armsynapse.PrivateLinkResourceProperties{
	// 		GroupID: to.Ptr("sql"),
	// 		RequiredMembers: []*string{
	// 			to.Ptr("sql")},
	// 			RequiredZoneNames: []*string{
	// 				to.Ptr("privatelink.sql.azuresynapse.net")},
	// 			},
	// 		}
}

Output:

func (*PrivateLinkHubPrivateLinkResourcesClient) NewListPager added in v0.4.0 

func (client *PrivateLinkHubPrivateLinkResourcesClient) NewListPager(resourceGroupName string, privateLinkHubName string, options *PrivateLinkHubPrivateLinkResourcesClientListOptions) *runtime.Pager[PrivateLinkHubPrivateLinkResourcesClientListResponse]

NewListPager - Get all private link resources for a private link hub

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • privateLinkHubName - The name of the private link hub
  • options - PrivateLinkHubPrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkHubPrivateLinkResourcesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListPrivateLinkHubPrivateLinkResources.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateLinkHubPrivateLinkResourcesClient().NewListPager("ExampleResourceGroup", "ExamplePrivateLinkHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateLinkResourceListResult = armsynapse.PrivateLinkResourceListResult{
		// 	Value: []*armsynapse.PrivateLinkResource{
		// 		{
		// 			Name: to.Ptr("sql"),
		// 			Type: to.Ptr("Microsoft.Synapse/privateLinkHubs/privateLinkResources"),
		// 			ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/privateLinkHubs/ExamplePrivateLinkHub/privateLinkResources/sql"),
		// 			Properties: &armsynapse.PrivateLinkResourceProperties{
		// 				GroupID: to.Ptr("sql"),
		// 				RequiredMembers: []*string{
		// 					to.Ptr("sql")},
		// 					RequiredZoneNames: []*string{
		// 						to.Ptr("privatelink.sql.azuresynapse.net")},
		// 					},
		// 			}},
		// 		}
	}
}

Output:

type PrivateLinkHubPrivateLinkResourcesClientGetOptions added in v0.2.0 

type PrivateLinkHubPrivateLinkResourcesClientGetOptions struct {
}

PrivateLinkHubPrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkHubPrivateLinkResourcesClient.Get method.

type PrivateLinkHubPrivateLinkResourcesClientGetResponse added in v0.2.0 

type PrivateLinkHubPrivateLinkResourcesClientGetResponse struct {
	// A private link resource
	PrivateLinkResource
}

PrivateLinkHubPrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkHubPrivateLinkResourcesClient.Get.

type PrivateLinkHubPrivateLinkResourcesClientListOptions added in v0.2.0 

type PrivateLinkHubPrivateLinkResourcesClientListOptions struct {
}

PrivateLinkHubPrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkHubPrivateLinkResourcesClient.NewListPager method.

type PrivateLinkHubPrivateLinkResourcesClientListResponse added in v0.2.0 

type PrivateLinkHubPrivateLinkResourcesClientListResponse struct {
	// A list of private link resources
	PrivateLinkResourceListResult
}

PrivateLinkHubPrivateLinkResourcesClientListResponse contains the response from method PrivateLinkHubPrivateLinkResourcesClient.NewListPager.

type PrivateLinkHubProperties 

type PrivateLinkHubProperties struct {
	// PrivateLinkHub provisioning state
	ProvisioningState *string

	// READ-ONLY; List of private endpoint connections
	PrivateEndpointConnections []*PrivateEndpointConnectionForPrivateLinkHubBasic
}

PrivateLinkHubProperties - PrivateLinkHub properties

func (PrivateLinkHubProperties) MarshalJSON 

func (p PrivateLinkHubProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkHubProperties.

func (*PrivateLinkHubProperties) UnmarshalJSON added in v0.6.0 

func (p *PrivateLinkHubProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkHubProperties.

type PrivateLinkHubsClient 

type PrivateLinkHubsClient struct {
	// contains filtered or unexported fields
}

PrivateLinkHubsClient contains the methods for the PrivateLinkHubs group. Don't use this type directly, use NewPrivateLinkHubsClient() instead.

func NewPrivateLinkHubsClient 

func NewPrivateLinkHubsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkHubsClient, error)

NewPrivateLinkHubsClient creates a new instance of PrivateLinkHubsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateLinkHubsClient) BeginDelete 

func (client *PrivateLinkHubsClient) BeginDelete(ctx context.Context, resourceGroupName string, privateLinkHubName string, options *PrivateLinkHubsClientBeginDeleteOptions) (*runtime.Poller[PrivateLinkHubsClientDeleteResponse], error)

BeginDelete - Deletes a privateLinkHub If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • privateLinkHubName - Name of the privateLinkHub
  • options - PrivateLinkHubsClientBeginDeleteOptions contains the optional parameters for the PrivateLinkHubsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeletePrivateLinkHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPrivateLinkHubsClient().BeginDelete(ctx, "resourceGroup1", "privateLinkHub1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*PrivateLinkHubsClient) CreateOrUpdate 

func (client *PrivateLinkHubsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, privateLinkHubName string, privateLinkHubInfo PrivateLinkHub, options *PrivateLinkHubsClientCreateOrUpdateOptions) (PrivateLinkHubsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a privateLinkHub If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • privateLinkHubName - Name of the privateLinkHub
  • privateLinkHubInfo - PrivateLinkHub create or update request properties
  • options - PrivateLinkHubsClientCreateOrUpdateOptions contains the optional parameters for the PrivateLinkHubsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdatePrivateLinkHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateLinkHubsClient().CreateOrUpdate(ctx, "resourceGroup1", "privateLinkHub1", armsynapse.PrivateLinkHub{
		Location: to.Ptr("East US"),
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
		Properties: &armsynapse.PrivateLinkHubProperties{},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateLinkHub = armsynapse.PrivateLinkHub{
	// 	Name: to.Ptr("privateLinkHub1"),
	// 	Type: to.Ptr("Microsoft.Synapse/privateLinkHubs"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armsynapse.PrivateLinkHubProperties{
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

Output:

func (*PrivateLinkHubsClient) Get 

func (client *PrivateLinkHubsClient) Get(ctx context.Context, resourceGroupName string, privateLinkHubName string, options *PrivateLinkHubsClientGetOptions) (PrivateLinkHubsClientGetResponse, error)

Get - Gets a privateLinkHub If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • privateLinkHubName - Name of the privateLinkHub
  • options - PrivateLinkHubsClientGetOptions contains the optional parameters for the PrivateLinkHubsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetPrivateLinkHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateLinkHubsClient().Get(ctx, "resourceGroup1", "privateLinkHub1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateLinkHub = armsynapse.PrivateLinkHub{
	// 	Name: to.Ptr("privateLinkHub1"),
	// 	Type: to.Ptr("Microsoft.Synapse/privateLinkHubs"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armsynapse.PrivateLinkHubProperties{
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

Output:

func (*PrivateLinkHubsClient) NewListByResourceGroupPager added in v0.4.0 

func (client *PrivateLinkHubsClient) NewListByResourceGroupPager(resourceGroupName string, options *PrivateLinkHubsClientListByResourceGroupOptions) *runtime.Pager[PrivateLinkHubsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Returns a list of privateLinkHubs in a resource group

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - PrivateLinkHubsClientListByResourceGroupOptions contains the optional parameters for the PrivateLinkHubsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListPrivateLinkHubsInResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateLinkHubsClient().NewListByResourceGroupPager("resourceGroup1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateLinkHubInfoListResult = armsynapse.PrivateLinkHubInfoListResult{
		// 	Value: []*armsynapse.PrivateLinkHub{
		// 		{
		// 			Name: to.Ptr("privateLinkHub1"),
		// 			Type: to.Ptr("Microsoft.Synapse/privateLinkHubs"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armsynapse.PrivateLinkHubProperties{
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("privateLinkHub2"),
		// 			Type: to.Ptr("Microsoft.Synapse/privateLinkHubs"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub2"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armsynapse.PrivateLinkHubProperties{
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*PrivateLinkHubsClient) NewListPager added in v0.4.0 

func (client *PrivateLinkHubsClient) NewListPager(options *PrivateLinkHubsClientListOptions) *runtime.Pager[PrivateLinkHubsClientListResponse]

NewListPager - Returns a list of privateLinkHubs in a subscription

Generated from API version 2021-06-01

  • options - PrivateLinkHubsClientListOptions contains the optional parameters for the PrivateLinkHubsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListPrivateLinkHubsInSubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateLinkHubsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateLinkHubInfoListResult = armsynapse.PrivateLinkHubInfoListResult{
		// 	Value: []*armsynapse.PrivateLinkHub{
		// 		{
		// 			Name: to.Ptr("privateLinkHub1"),
		// 			Type: to.Ptr("Microsoft.Synapse/privateLinkHubs"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armsynapse.PrivateLinkHubProperties{
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("privateLinkHub2"),
		// 			Type: to.Ptr("Microsoft.Synapse/privateLinkHubs"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub2"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armsynapse.PrivateLinkHubProperties{
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*PrivateLinkHubsClient) Update 

func (client *PrivateLinkHubsClient) Update(ctx context.Context, resourceGroupName string, privateLinkHubName string, privateLinkHubPatchInfo PrivateLinkHubPatchInfo, options *PrivateLinkHubsClientUpdateOptions) (PrivateLinkHubsClientUpdateResponse, error)

Update - Updates a privateLinkHub If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • privateLinkHubName - Name of the privateLinkHub
  • privateLinkHubPatchInfo - PrivateLinkHub patch request properties
  • options - PrivateLinkHubsClientUpdateOptions contains the optional parameters for the PrivateLinkHubsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdatePrivateLinkHub.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateLinkHubsClient().Update(ctx, "resourceGroup1", "privateLinkHub1", armsynapse.PrivateLinkHubPatchInfo{
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateLinkHub = armsynapse.PrivateLinkHub{
	// 	Name: to.Ptr("privateLinkHub1"),
	// 	Type: to.Ptr("Microsoft.Synapse/privateLinkHubs"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armsynapse.PrivateLinkHubProperties{
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

Output:

type PrivateLinkHubsClientBeginDeleteOptions added in v0.2.0 

type PrivateLinkHubsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateLinkHubsClientBeginDeleteOptions contains the optional parameters for the PrivateLinkHubsClient.BeginDelete method.

type PrivateLinkHubsClientCreateOrUpdateOptions added in v0.2.0 

type PrivateLinkHubsClientCreateOrUpdateOptions struct {
}

PrivateLinkHubsClientCreateOrUpdateOptions contains the optional parameters for the PrivateLinkHubsClient.CreateOrUpdate method.

type PrivateLinkHubsClientCreateOrUpdateResponse added in v0.2.0 

type PrivateLinkHubsClientCreateOrUpdateResponse struct {
	// A privateLinkHub
	PrivateLinkHub
}

PrivateLinkHubsClientCreateOrUpdateResponse contains the response from method PrivateLinkHubsClient.CreateOrUpdate.

type PrivateLinkHubsClientDeleteResponse added in v0.2.0 

type PrivateLinkHubsClientDeleteResponse struct {
}

PrivateLinkHubsClientDeleteResponse contains the response from method PrivateLinkHubsClient.BeginDelete.

type PrivateLinkHubsClientGetOptions added in v0.2.0 

type PrivateLinkHubsClientGetOptions struct {
}

PrivateLinkHubsClientGetOptions contains the optional parameters for the PrivateLinkHubsClient.Get method.

type PrivateLinkHubsClientGetResponse added in v0.2.0 

type PrivateLinkHubsClientGetResponse struct {
	// A privateLinkHub
	PrivateLinkHub
}

PrivateLinkHubsClientGetResponse contains the response from method PrivateLinkHubsClient.Get.

type PrivateLinkHubsClientListByResourceGroupOptions added in v0.2.0 

type PrivateLinkHubsClientListByResourceGroupOptions struct {
}

PrivateLinkHubsClientListByResourceGroupOptions contains the optional parameters for the PrivateLinkHubsClient.NewListByResourceGroupPager method.

type PrivateLinkHubsClientListByResourceGroupResponse added in v0.2.0 

type PrivateLinkHubsClientListByResourceGroupResponse struct {
	// List of privateLinkHubs
	PrivateLinkHubInfoListResult
}

PrivateLinkHubsClientListByResourceGroupResponse contains the response from method PrivateLinkHubsClient.NewListByResourceGroupPager.

type PrivateLinkHubsClientListOptions added in v0.2.0 

type PrivateLinkHubsClientListOptions struct {
}

PrivateLinkHubsClientListOptions contains the optional parameters for the PrivateLinkHubsClient.NewListPager method.

type PrivateLinkHubsClientListResponse added in v0.2.0 

type PrivateLinkHubsClientListResponse struct {
	// List of privateLinkHubs
	PrivateLinkHubInfoListResult
}

PrivateLinkHubsClientListResponse contains the response from method PrivateLinkHubsClient.NewListPager.

type PrivateLinkHubsClientUpdateOptions added in v0.2.0 

type PrivateLinkHubsClientUpdateOptions struct {
}

PrivateLinkHubsClientUpdateOptions contains the optional parameters for the PrivateLinkHubsClient.Update method.

type PrivateLinkHubsClientUpdateResponse added in v0.2.0 

type PrivateLinkHubsClientUpdateResponse struct {
	// A privateLinkHub
	PrivateLinkHub
}

PrivateLinkHubsClientUpdateResponse contains the response from method PrivateLinkHubsClient.Update.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The private link resource properties.
	Properties *PrivateLinkResourceProperties

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

PrivateLinkResource - A private link resource

func (PrivateLinkResource) MarshalJSON 

func (p PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON 

func (p *PrivateLinkResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResource.

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*PrivateLinkResource
}

PrivateLinkResourceListResult - A list of private link resources

func (PrivateLinkResourceListResult) MarshalJSON 

func (p PrivateLinkResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceListResult.

func (*PrivateLinkResourceListResult) UnmarshalJSON added in v0.6.0 

func (p *PrivateLinkResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceListResult.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// READ-ONLY; The private link resource group id.
	GroupID *string

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string

	// READ-ONLY; Required DNS zone names of the the private link resource.
	RequiredZoneNames []*string
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

func (*PrivateLinkResourceProperties) UnmarshalJSON added in v0.6.0 

func (p *PrivateLinkResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResources added in v0.6.0 

type PrivateLinkResources struct {
	// The list of Kusto Private Link Resources.
	Value []*KustoPoolPrivateLinkResources
}

PrivateLinkResources - The list Kusto Private Link Resources operation response.

func (PrivateLinkResources) MarshalJSON added in v0.6.0 

func (p PrivateLinkResources) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResources.

func (*PrivateLinkResources) UnmarshalJSON added in v0.6.0 

func (p *PrivateLinkResources) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResources.

type PrivateLinkResourcesClient 

type PrivateLinkResourcesClient struct {
	// contains filtered or unexported fields
}

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkResourcesClient, error)

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) Get 

func (client *PrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, privateLinkResourceName string, options *PrivateLinkResourcesClientGetOptions) (PrivateLinkResourcesClientGetResponse, error)

Get - Get private link resource in workspace If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • privateLinkResourceName - The name of the private link resource
  • options - PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetPrivateLinkResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateLinkResourcesClient().Get(ctx, "ExampleResourceGroup", "ExampleWorkspace", "sql", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateLinkResource = armsynapse.PrivateLinkResource{
	// 	Name: to.Ptr("sql"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/privateLinkResources"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateLinkResources/sql"),
	// 	Properties: &armsynapse.PrivateLinkResourceProperties{
	// 		GroupID: to.Ptr("sql"),
	// 		RequiredMembers: []*string{
	// 			to.Ptr("sql")},
	// 			RequiredZoneNames: []*string{
	// 				to.Ptr("privatelink.sql.azuresynapse.net")},
	// 			},
	// 		}
}

Output:

func (*PrivateLinkResourcesClient) NewListPager added in v0.4.0 

func (client *PrivateLinkResourcesClient) NewListPager(resourceGroupName string, workspaceName string, options *PrivateLinkResourcesClientListOptions) *runtime.Pager[PrivateLinkResourcesClientListResponse]

NewListPager - Get all private link resources for a workspaces

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListPrivateLinkResources.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateLinkResourcesClient().NewListPager("ExampleResourceGroup", "ExampleWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateLinkResourceListResult = armsynapse.PrivateLinkResourceListResult{
		// 	Value: []*armsynapse.PrivateLinkResource{
		// 		{
		// 			Name: to.Ptr("sql"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/privateLinkResources"),
		// 			ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateLinkResources/sql"),
		// 			Properties: &armsynapse.PrivateLinkResourceProperties{
		// 				GroupID: to.Ptr("sql"),
		// 				RequiredMembers: []*string{
		// 					to.Ptr("sql")},
		// 					RequiredZoneNames: []*string{
		// 						to.Ptr("privatelink.sql.azuresynapse.net")},
		// 					},
		// 			}},
		// 		}
	}
}

Output:

type PrivateLinkResourcesClientGetOptions added in v0.2.0 

type PrivateLinkResourcesClientGetOptions struct {
}

PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

type PrivateLinkResourcesClientGetResponse added in v0.2.0 

type PrivateLinkResourcesClientGetResponse struct {
	// A private link resource
	PrivateLinkResource
}

PrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientListOptions added in v0.2.0 

type PrivateLinkResourcesClientListOptions struct {
}

PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.NewListPager method.

type PrivateLinkResourcesClientListResponse added in v0.2.0 

type PrivateLinkResourcesClientListResponse struct {
	// A list of private link resources
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientListResponse contains the response from method PrivateLinkResourcesClient.NewListPager.

type PrivateLinkResourcesProperties added in v0.6.0 

type PrivateLinkResourcesProperties struct {
	// READ-ONLY; The Private link resources GroupId
	GroupID *string

	// READ-ONLY; The provisioned state of the resource.
	ProvisioningState *ResourceProvisioningState

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string

	// READ-ONLY; The private link resource required zone names.
	RequiredZoneNames []*string
}

PrivateLinkResourcesProperties - Private Link Resources Properties.

func (PrivateLinkResourcesProperties) MarshalJSON added in v0.6.0 

func (p PrivateLinkResourcesProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourcesProperties.

func (*PrivateLinkResourcesProperties) UnmarshalJSON added in v0.6.0 

func (p *PrivateLinkResourcesProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourcesProperties.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// The private link service connection description.
	Description *string

	// The private link service connection status.
	Status *string

	// READ-ONLY; The actions required for private link service connection.
	ActionsRequired *string
}

PrivateLinkServiceConnectionState - Connection state details of the private endpoint

func (PrivateLinkServiceConnectionState) MarshalJSON added in v0.6.0 

func (p PrivateLinkServiceConnectionState) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceConnectionState.

func (*PrivateLinkServiceConnectionState) UnmarshalJSON added in v0.6.0 

func (p *PrivateLinkServiceConnectionState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceConnectionState.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Resource provisioning state 

const (
	ProvisioningStateDeleteError  ProvisioningState = "DeleteError"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON added in v0.6.0 

func (p ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyResource.

func (*ProxyResource) UnmarshalJSON added in v0.6.0 

func (p *ProxyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyResource.

type PurviewConfiguration 

type PurviewConfiguration struct {
	// Purview Resource ID
	PurviewResourceID *string
}

PurviewConfiguration - Purview Configuration

func (PurviewConfiguration) MarshalJSON added in v0.6.0 

func (p PurviewConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PurviewConfiguration.

func (*PurviewConfiguration) UnmarshalJSON added in v0.6.0 

func (p *PurviewConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PurviewConfiguration.

type QueryAggregationFunction 

type QueryAggregationFunction string

QueryAggregationFunction - The function that is used to aggregate each query's metrics. 

const (
	QueryAggregationFunctionAvg QueryAggregationFunction = "avg"
	QueryAggregationFunctionMax QueryAggregationFunction = "max"
	QueryAggregationFunctionMin QueryAggregationFunction = "min"
	QueryAggregationFunctionSum QueryAggregationFunction = "sum"
)

func PossibleQueryAggregationFunctionValues 

func PossibleQueryAggregationFunctionValues() []QueryAggregationFunction

PossibleQueryAggregationFunctionValues returns the possible values for the QueryAggregationFunction const type.

type QueryExecutionType 

type QueryExecutionType string

QueryExecutionType - The execution type that is used to filter the query instances that are returned. 

const (
	QueryExecutionTypeAborted   QueryExecutionType = "aborted"
	QueryExecutionTypeAny       QueryExecutionType = "any"
	QueryExecutionTypeException QueryExecutionType = "exception"
	QueryExecutionTypeIrregular QueryExecutionType = "irregular"
	QueryExecutionTypeRegular   QueryExecutionType = "regular"
)

func PossibleQueryExecutionTypeValues 

func PossibleQueryExecutionTypeValues() []QueryExecutionType

PossibleQueryExecutionTypeValues returns the possible values for the QueryExecutionType const type.

type QueryInterval 

type QueryInterval struct {
	// READ-ONLY; The number of times the query was executed during this interval.
	ExecutionCount *int32

	// READ-ONLY; The start time of the measurement interval (ISO8601 format).
	IntervalStartTime *time.Time

	// READ-ONLY; The list of query metrics during this interval.
	Metrics []*QueryMetric
}

QueryInterval - A database query.

func (QueryInterval) MarshalJSON 

func (q QueryInterval) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QueryInterval.

func (*QueryInterval) UnmarshalJSON 

func (q *QueryInterval) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QueryInterval.

type QueryMetric 

type QueryMetric struct {
	// READ-ONLY; The name of the metric for display in user interface
	DisplayName *string

	// READ-ONLY; The name of the metric
	Name *string

	// READ-ONLY; The unit of measurement
	Unit *QueryMetricUnit

	// READ-ONLY; The measured value
	Value *float64
}

QueryMetric - A database query.

func (QueryMetric) MarshalJSON added in v0.6.0 

func (q QueryMetric) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QueryMetric.

func (*QueryMetric) UnmarshalJSON added in v0.6.0 

func (q *QueryMetric) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QueryMetric.

type QueryMetricUnit 

type QueryMetricUnit string

QueryMetricUnit - The unit of measurement 

const (
	QueryMetricUnitKB           QueryMetricUnit = "KB"
	QueryMetricUnitMicroseconds QueryMetricUnit = "microseconds"
	QueryMetricUnitPercentage   QueryMetricUnit = "percentage"
)

func PossibleQueryMetricUnitValues 

func PossibleQueryMetricUnitValues() []QueryMetricUnit

PossibleQueryMetricUnitValues returns the possible values for the QueryMetricUnit const type.

type QueryObservedMetricType 

type QueryObservedMetricType string

QueryObservedMetricType - The type of metric to use for ordering the top metrics. 

const (
	QueryObservedMetricTypeCPU            QueryObservedMetricType = "cpu"
	QueryObservedMetricTypeDuration       QueryObservedMetricType = "duration"
	QueryObservedMetricTypeExecutionCount QueryObservedMetricType = "executionCount"
	QueryObservedMetricTypeIo             QueryObservedMetricType = "io"
	QueryObservedMetricTypeLogio          QueryObservedMetricType = "logio"
)

func PossibleQueryObservedMetricTypeValues 

func PossibleQueryObservedMetricTypeValues() []QueryObservedMetricType

PossibleQueryObservedMetricTypeValues returns the possible values for the QueryObservedMetricType const type.

type QueryStatistic 

type QueryStatistic struct {
	// READ-ONLY; The list of query intervals.
	Intervals []*QueryInterval

	// READ-ONLY; The id of the query
	QueryID *string
}

QueryStatistic - A database query.

func (QueryStatistic) MarshalJSON 

func (q QueryStatistic) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QueryStatistic.

func (*QueryStatistic) UnmarshalJSON added in v0.6.0 

func (q *QueryStatistic) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QueryStatistic.

type ReadOnlyFollowingDatabase added in v0.2.0 

type ReadOnlyFollowingDatabase struct {
	// REQUIRED; Kind of the database
	Kind *Kind

	// Resource location.
	Location *string

	// The database properties.
	Properties *ReadOnlyFollowingDatabaseProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ReadOnlyFollowingDatabase - Class representing a read only following database.

func (*ReadOnlyFollowingDatabase) GetDatabase added in v0.2.0 

func (r *ReadOnlyFollowingDatabase) GetDatabase() *Database

GetDatabase implements the DatabaseClassification interface for type ReadOnlyFollowingDatabase.

func (ReadOnlyFollowingDatabase) MarshalJSON added in v0.2.0 

func (r ReadOnlyFollowingDatabase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReadOnlyFollowingDatabase.

func (*ReadOnlyFollowingDatabase) UnmarshalJSON added in v0.2.0 

func (r *ReadOnlyFollowingDatabase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReadOnlyFollowingDatabase.

type ReadOnlyFollowingDatabaseProperties added in v0.2.0 

type ReadOnlyFollowingDatabaseProperties struct {
	// The time the data should be kept in cache for fast queries in TimeSpan.
	HotCachePeriod *string

	// READ-ONLY; The name of the attached database configuration cluster
	AttachedDatabaseConfigurationName *string

	// READ-ONLY; The name of the leader cluster
	LeaderClusterResourceID *string

	// READ-ONLY; The principals modification kind of the database
	PrincipalsModificationKind *PrincipalsModificationKind

	// READ-ONLY; The provisioned state of the resource.
	ProvisioningState *ResourceProvisioningState

	// READ-ONLY; The time the data should be kept before it stops being accessible to queries in TimeSpan.
	SoftDeletePeriod *string

	// READ-ONLY; The statistics of the database.
	Statistics *DatabaseStatistics
}

ReadOnlyFollowingDatabaseProperties - Class representing the Kusto database properties.

func (ReadOnlyFollowingDatabaseProperties) MarshalJSON added in v0.6.0 

func (r ReadOnlyFollowingDatabaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReadOnlyFollowingDatabaseProperties.

func (*ReadOnlyFollowingDatabaseProperties) UnmarshalJSON added in v0.6.0 

func (r *ReadOnlyFollowingDatabaseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReadOnlyFollowingDatabaseProperties.

type ReadWriteDatabase 

type ReadWriteDatabase struct {
	// REQUIRED; Kind of the database
	Kind *Kind

	// Resource location.
	Location *string

	// The database properties.
	Properties *ReadWriteDatabaseProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ReadWriteDatabase - Class representing a read write database.

func (*ReadWriteDatabase) GetDatabase added in v0.2.0 

func (r *ReadWriteDatabase) GetDatabase() *Database

GetDatabase implements the DatabaseClassification interface for type ReadWriteDatabase.

func (ReadWriteDatabase) MarshalJSON 

func (r ReadWriteDatabase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReadWriteDatabase.

func (*ReadWriteDatabase) UnmarshalJSON 

func (r *ReadWriteDatabase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReadWriteDatabase.

type ReadWriteDatabaseProperties 

type ReadWriteDatabaseProperties struct {
	// The time the data should be kept in cache for fast queries in TimeSpan.
	HotCachePeriod *string

	// The time the data should be kept before it stops being accessible to queries in TimeSpan.
	SoftDeletePeriod *string

	// READ-ONLY; Indicates whether the database is followed.
	IsFollowed *bool

	// READ-ONLY; The provisioned state of the resource.
	ProvisioningState *ResourceProvisioningState

	// READ-ONLY; The statistics of the database.
	Statistics *DatabaseStatistics
}

ReadWriteDatabaseProperties - Class representing the Kusto database properties.

func (ReadWriteDatabaseProperties) MarshalJSON added in v0.6.0 

func (r ReadWriteDatabaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReadWriteDatabaseProperties.

func (*ReadWriteDatabaseProperties) UnmarshalJSON added in v0.6.0 

func (r *ReadWriteDatabaseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReadWriteDatabaseProperties.

type Reason 

type Reason string

Reason - Message providing the reason why the given name is invalid. 

const (
	ReasonAlreadyExists Reason = "AlreadyExists"
	ReasonInvalid       Reason = "Invalid"
)

func PossibleReasonValues 

func PossibleReasonValues() []Reason

PossibleReasonValues returns the possible values for the Reason const type.

type RecommendedSensitivityLabelUpdate 

type RecommendedSensitivityLabelUpdate struct {
	// Resource properties.
	Properties *RecommendedSensitivityLabelUpdateProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

RecommendedSensitivityLabelUpdate - A recommended sensitivity label update operation.

func (RecommendedSensitivityLabelUpdate) MarshalJSON 

func (r RecommendedSensitivityLabelUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecommendedSensitivityLabelUpdate.

func (*RecommendedSensitivityLabelUpdate) UnmarshalJSON 

func (r *RecommendedSensitivityLabelUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecommendedSensitivityLabelUpdate.

type RecommendedSensitivityLabelUpdateKind 

type RecommendedSensitivityLabelUpdateKind string
const (
	RecommendedSensitivityLabelUpdateKindDisable RecommendedSensitivityLabelUpdateKind = "disable"
	RecommendedSensitivityLabelUpdateKindEnable  RecommendedSensitivityLabelUpdateKind = "enable"
)

func PossibleRecommendedSensitivityLabelUpdateKindValues 

func PossibleRecommendedSensitivityLabelUpdateKindValues() []RecommendedSensitivityLabelUpdateKind

PossibleRecommendedSensitivityLabelUpdateKindValues returns the possible values for the RecommendedSensitivityLabelUpdateKind const type.

type RecommendedSensitivityLabelUpdateList 

type RecommendedSensitivityLabelUpdateList struct {
	Operations []*RecommendedSensitivityLabelUpdate
}

RecommendedSensitivityLabelUpdateList - A list of recommended sensitivity label update operations.

func (RecommendedSensitivityLabelUpdateList) MarshalJSON 

func (r RecommendedSensitivityLabelUpdateList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecommendedSensitivityLabelUpdateList.

func (*RecommendedSensitivityLabelUpdateList) UnmarshalJSON added in v0.6.0 

func (r *RecommendedSensitivityLabelUpdateList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecommendedSensitivityLabelUpdateList.

type RecommendedSensitivityLabelUpdateProperties 

type RecommendedSensitivityLabelUpdateProperties struct {
	// REQUIRED; Column name to update.
	Column *string

	// REQUIRED
	Op *RecommendedSensitivityLabelUpdateKind

	// REQUIRED; Schema name of the column to update.
	Schema *string

	// REQUIRED; Table name of the column to update.
	Table *string
}

RecommendedSensitivityLabelUpdateProperties - Properties of an operation executed on a recommended sensitivity label.

func (RecommendedSensitivityLabelUpdateProperties) MarshalJSON added in v0.6.0 

func (r RecommendedSensitivityLabelUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecommendedSensitivityLabelUpdateProperties.

func (*RecommendedSensitivityLabelUpdateProperties) UnmarshalJSON added in v0.6.0 

func (r *RecommendedSensitivityLabelUpdateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecommendedSensitivityLabelUpdateProperties.

type RecoverableSQLPool 

type RecoverableSQLPool struct {
	// The properties of a recoverable sql pool
	Properties *RecoverableSQLPoolProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

RecoverableSQLPool - A recoverable sql pool

func (RecoverableSQLPool) MarshalJSON 

func (r RecoverableSQLPool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecoverableSQLPool.

func (*RecoverableSQLPool) UnmarshalJSON 

func (r *RecoverableSQLPool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecoverableSQLPool.

type RecoverableSQLPoolListResult 

type RecoverableSQLPoolListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; A list of recoverable sql pool
	Value []*RecoverableSQLPool
}

RecoverableSQLPoolListResult - The response to a list recoverable sql pools request

func (RecoverableSQLPoolListResult) MarshalJSON 

func (r RecoverableSQLPoolListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecoverableSQLPoolListResult.

func (*RecoverableSQLPoolListResult) UnmarshalJSON added in v0.6.0 

func (r *RecoverableSQLPoolListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecoverableSQLPoolListResult.

type RecoverableSQLPoolProperties 

type RecoverableSQLPoolProperties struct {
	// READ-ONLY; The edition of the database
	Edition *string

	// READ-ONLY; The elastic pool name of the database
	ElasticPoolName *string

	// READ-ONLY; The last available backup date of the database (ISO8601 format)
	LastAvailableBackupDate *time.Time

	// READ-ONLY; The service level objective name of the database
	ServiceLevelObjective *string
}

RecoverableSQLPoolProperties - The properties of a recoverable sql pool

func (RecoverableSQLPoolProperties) MarshalJSON 

func (r RecoverableSQLPoolProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecoverableSQLPoolProperties.

func (*RecoverableSQLPoolProperties) UnmarshalJSON 

func (r *RecoverableSQLPoolProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecoverableSQLPoolProperties.

type ReplaceAllFirewallRulesOperationResponse 

type ReplaceAllFirewallRulesOperationResponse struct {
	// The operation ID
	OperationID *string
}

ReplaceAllFirewallRulesOperationResponse - An existing operation for replacing the firewall rules

func (ReplaceAllFirewallRulesOperationResponse) MarshalJSON added in v0.6.0 

func (r ReplaceAllFirewallRulesOperationResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReplaceAllFirewallRulesOperationResponse.

func (*ReplaceAllFirewallRulesOperationResponse) UnmarshalJSON added in v0.6.0 

func (r *ReplaceAllFirewallRulesOperationResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReplaceAllFirewallRulesOperationResponse.

type ReplaceAllIPFirewallRulesRequest 

type ReplaceAllIPFirewallRulesRequest struct {
	// IP firewall rule properties
	IPFirewallRules map[string]*IPFirewallRuleProperties
}

ReplaceAllIPFirewallRulesRequest - Replace all IP firewall rules request

func (ReplaceAllIPFirewallRulesRequest) MarshalJSON 

func (r ReplaceAllIPFirewallRulesRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReplaceAllIPFirewallRulesRequest.

func (*ReplaceAllIPFirewallRulesRequest) UnmarshalJSON added in v0.6.0 

func (r *ReplaceAllIPFirewallRulesRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReplaceAllIPFirewallRulesRequest. 

type ReplicationLink struct {
	// The properties representing the resource.
	Properties *ReplicationLinkProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; Location of the workspace that contains this firewall rule.
	Location *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ReplicationLink - Represents a Sql pool replication link.

func (ReplicationLink) MarshalJSON 

func (r ReplicationLink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReplicationLink.

func (*ReplicationLink) UnmarshalJSON 

func (r *ReplicationLink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReplicationLink.

type ReplicationLinkListResult 

type ReplicationLinkListResult struct {
	// The list of Sql pool replication links housed in the Sql pool.
	Value []*ReplicationLink

	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string
}

ReplicationLinkListResult - Represents the response to a List Sql pool replication link request.

func (ReplicationLinkListResult) MarshalJSON 

func (r ReplicationLinkListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReplicationLinkListResult.

func (*ReplicationLinkListResult) UnmarshalJSON added in v0.6.0 

func (r *ReplicationLinkListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReplicationLinkListResult.

type ReplicationLinkProperties 

type ReplicationLinkProperties struct {
	// READ-ONLY; Legacy value indicating whether termination is allowed. Currently always returns true.
	IsTerminationAllowed *bool

	// READ-ONLY; The name of the partner Sql pool.
	PartnerDatabase *string

	// READ-ONLY; The Azure Region of the partner Sql pool.
	PartnerLocation *string

	// READ-ONLY; The role of the partner Sql pool in the replication link.
	PartnerRole *ReplicationRole

	// READ-ONLY; The name of the workspace hosting the partner Sql pool.
	PartnerServer *string

	// READ-ONLY; The percentage of seeding complete for the replication link.
	PercentComplete *int32

	// READ-ONLY; Replication mode of this replication link.
	ReplicationMode *string

	// READ-ONLY; The replication state for the replication link.
	ReplicationState *ReplicationState

	// READ-ONLY; The role of the Sql pool in the replication link.
	Role *ReplicationRole

	// READ-ONLY; The start time for the replication link.
	StartTime *time.Time
}

ReplicationLinkProperties - Represents the properties of a Sql pool replication link.

func (ReplicationLinkProperties) MarshalJSON 

func (r ReplicationLinkProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReplicationLinkProperties.

func (*ReplicationLinkProperties) UnmarshalJSON 

func (r *ReplicationLinkProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReplicationLinkProperties.

type ReplicationRole 

type ReplicationRole string

ReplicationRole - The role of the Sql pool in the replication link. 

const (
	ReplicationRoleCopy                 ReplicationRole = "Copy"
	ReplicationRoleNonReadableSecondary ReplicationRole = "NonReadableSecondary"
	ReplicationRolePrimary              ReplicationRole = "Primary"
	ReplicationRoleSecondary            ReplicationRole = "Secondary"
	ReplicationRoleSource               ReplicationRole = "Source"
)

func PossibleReplicationRoleValues 

func PossibleReplicationRoleValues() []ReplicationRole

PossibleReplicationRoleValues returns the possible values for the ReplicationRole const type.

type ReplicationState 

type ReplicationState string

ReplicationState - The replication state for the replication link. 

const (
	ReplicationStateCATCHUP   ReplicationState = "CATCH_UP"
	ReplicationStatePENDING   ReplicationState = "PENDING"
	ReplicationStateSEEDING   ReplicationState = "SEEDING"
	ReplicationStateSUSPENDED ReplicationState = "SUSPENDED"
)

func PossibleReplicationStateValues 

func PossibleReplicationStateValues() []ReplicationState

PossibleReplicationStateValues returns the possible values for the ReplicationState const type.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON 

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType - The type of managed identity for the workspace 

const (
	ResourceIdentityTypeNone                       ResourceIdentityType = "None"
	ResourceIdentityTypeSystemAssigned             ResourceIdentityType = "SystemAssigned"
	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned,UserAssigned"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

type ResourceMoveDefinition 

type ResourceMoveDefinition struct {
	// REQUIRED; The target ID for the resource
	ID *string
}

ResourceMoveDefinition - Contains the information necessary to perform a resource move (rename).

func (ResourceMoveDefinition) MarshalJSON added in v0.6.0 

func (r ResourceMoveDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceMoveDefinition.

func (*ResourceMoveDefinition) UnmarshalJSON added in v0.6.0 

func (r *ResourceMoveDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceMoveDefinition.

type ResourceProvisioningState 

type ResourceProvisioningState string

ResourceProvisioningState - The provisioned state of the resource. 

const (
	ResourceProvisioningStateCanceled  ResourceProvisioningState = "Canceled"
	ResourceProvisioningStateCreating  ResourceProvisioningState = "Creating"
	ResourceProvisioningStateDeleting  ResourceProvisioningState = "Deleting"
	ResourceProvisioningStateFailed    ResourceProvisioningState = "Failed"
	ResourceProvisioningStateMoving    ResourceProvisioningState = "Moving"
	ResourceProvisioningStateRunning   ResourceProvisioningState = "Running"
	ResourceProvisioningStateSucceeded ResourceProvisioningState = "Succeeded"
)

func PossibleResourceProvisioningStateValues 

func PossibleResourceProvisioningStateValues() []ResourceProvisioningState

PossibleResourceProvisioningStateValues returns the possible values for the ResourceProvisioningState const type.

type RestorableDroppedSQLPool 

type RestorableDroppedSQLPool struct {
	// The properties of a restorable dropped Sql pool
	Properties *RestorableDroppedSQLPoolProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The geo-location where the resource lives
	Location *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

RestorableDroppedSQLPool - A restorable dropped Sql pool

func (RestorableDroppedSQLPool) MarshalJSON 

func (r RestorableDroppedSQLPool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RestorableDroppedSQLPool.

func (*RestorableDroppedSQLPool) UnmarshalJSON 

func (r *RestorableDroppedSQLPool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RestorableDroppedSQLPool.

type RestorableDroppedSQLPoolListResult 

type RestorableDroppedSQLPoolListResult struct {
	// REQUIRED; A list of restorable dropped Sql pools
	Value []*RestorableDroppedSQLPool
}

RestorableDroppedSQLPoolListResult - The response to a list restorable dropped Sql pools request

func (RestorableDroppedSQLPoolListResult) MarshalJSON 

func (r RestorableDroppedSQLPoolListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RestorableDroppedSQLPoolListResult.

func (*RestorableDroppedSQLPoolListResult) UnmarshalJSON added in v0.6.0 

func (r *RestorableDroppedSQLPoolListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RestorableDroppedSQLPoolListResult.

type RestorableDroppedSQLPoolProperties 

type RestorableDroppedSQLPoolProperties struct {
	// READ-ONLY; The creation date of the database (ISO8601 format)
	CreationDate *time.Time

	// READ-ONLY; The name of the database
	DatabaseName *string

	// READ-ONLY; The deletion date of the database (ISO8601 format)
	DeletionDate *time.Time

	// READ-ONLY; The earliest restore date of the database (ISO8601 format)
	EarliestRestoreDate *time.Time

	// READ-ONLY; The edition of the database
	Edition *string

	// READ-ONLY; The elastic pool name of the database
	ElasticPoolName *string

	// READ-ONLY; The max size in bytes of the database
	MaxSizeBytes *string

	// READ-ONLY; The service level objective name of the database
	ServiceLevelObjective *string
}

RestorableDroppedSQLPoolProperties - The properties of a restorable dropped Sql pool

func (RestorableDroppedSQLPoolProperties) MarshalJSON 

func (r RestorableDroppedSQLPoolProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RestorableDroppedSQLPoolProperties.

func (*RestorableDroppedSQLPoolProperties) UnmarshalJSON 

func (r *RestorableDroppedSQLPoolProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RestorableDroppedSQLPoolProperties.

type RestorableDroppedSQLPoolsClient 

type RestorableDroppedSQLPoolsClient struct {
	// contains filtered or unexported fields
}

RestorableDroppedSQLPoolsClient contains the methods for the RestorableDroppedSQLPools group. Don't use this type directly, use NewRestorableDroppedSQLPoolsClient() instead.

func NewRestorableDroppedSQLPoolsClient 

func NewRestorableDroppedSQLPoolsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RestorableDroppedSQLPoolsClient, error)

NewRestorableDroppedSQLPoolsClient creates a new instance of RestorableDroppedSQLPoolsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*RestorableDroppedSQLPoolsClient) Get 

func (client *RestorableDroppedSQLPoolsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, restorableDroppedSQLPoolID string, options *RestorableDroppedSQLPoolsClientGetOptions) (RestorableDroppedSQLPoolsClientGetResponse, error)

Get - Gets a deleted sql pool that can be restored If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • restorableDroppedSQLPoolID - The id of the deleted Sql Pool in the form of sqlPoolName,deletionTimeInFileTimeFormat
  • options - RestorableDroppedSQLPoolsClientGetOptions contains the optional parameters for the RestorableDroppedSQLPoolsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/RestorableDroppedSqlPoolGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewRestorableDroppedSQLPoolsClient().Get(ctx, "restorabledroppeddatabasetest-1257", "restorabledroppeddatabasetest-2389", "restorabledroppeddatabasetest-7654,131403269876900000", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RestorableDroppedSQLPool = armsynapse.RestorableDroppedSQLPool{
	// 	Name: to.Ptr("restorabledroppeddatabasetest-7654,131403269876900000"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/restorableDroppedSqlPools"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/restorabledroppeddatabasetest-1257/providers/Microsoft.Synapse/workspaces/restorabledroppeddatabasetest-2389/restorableDroppedSqlPools/restorabledroppeddatabasetest-7654,131403269876900000"),
	// 	Location: to.Ptr("Japan East"),
	// 	Properties: &armsynapse.RestorableDroppedSQLPoolProperties{
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:56:19.200Z"); return t}()),
	// 		DatabaseName: to.Ptr("restorabledroppeddatabasetest-7654"),
	// 		DeletionDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-27T02:49:47.690Z"); return t}()),
	// 		EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-20T02:49:47.690Z"); return t}()),
	// 		Edition: to.Ptr("Datawarehouse"),
	// 		MaxSizeBytes: to.Ptr("2147483648"),
	// 		ServiceLevelObjective: to.Ptr("DW100c"),
	// 	},
	// }
}

Output:

func (*RestorableDroppedSQLPoolsClient) NewListByWorkspacePager added in v0.4.0 

func (client *RestorableDroppedSQLPoolsClient) NewListByWorkspacePager(resourceGroupName string, workspaceName string, options *RestorableDroppedSQLPoolsClientListByWorkspaceOptions) *runtime.Pager[RestorableDroppedSQLPoolsClientListByWorkspaceResponse]

NewListByWorkspacePager - Gets a list of deleted Sql pools that can be restored

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - RestorableDroppedSQLPoolsClientListByWorkspaceOptions contains the optional parameters for the RestorableDroppedSQLPoolsClient.NewListByWorkspacePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/RestorableDroppedSqlpoolList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRestorableDroppedSQLPoolsClient().NewListByWorkspacePager("restorabledroppeddatabasetest-1349", "restorabledroppeddatabasetest-1840", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RestorableDroppedSQLPoolListResult = armsynapse.RestorableDroppedSQLPoolListResult{
		// 	Value: []*armsynapse.RestorableDroppedSQLPool{
		// 		{
		// 			Name: to.Ptr("restorabledroppeddatabasetest-1345,131403269876900000"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/restorableDroppedSqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/restorabledroppeddatabasetest-1349/providers/Microsoft.Synapse/workspaces/restorabledroppeddatabasetest-1840/restorableDroppedSqlPools/restorabledroppeddatabasetest-1345,131403269876900000"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.RestorableDroppedSQLPoolProperties{
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:56:19.200Z"); return t}()),
		// 				DatabaseName: to.Ptr("restorabledroppeddatabasetest-1345"),
		// 				DeletionDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-27T02:49:47.690Z"); return t}()),
		// 				EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-20T02:49:47.690Z"); return t}()),
		// 				Edition: to.Ptr("Basic"),
		// 				MaxSizeBytes: to.Ptr("2147483648"),
		// 				ServiceLevelObjective: to.Ptr("Basic"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("restorabledroppeddatabasetest-2764,131403249684030000"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/restorableDroppedSqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/restorabledroppeddatabasetest-1349/providers/Microsoft.Synapse/workspaces/restorabledroppeddatabasetest-1840/restorableDroppedSqlPools/restorabledroppeddatabasetest-2764,131403249684030000"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.RestorableDroppedSQLPoolProperties{
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-05-10T00:56:19.200Z"); return t}()),
		// 				DatabaseName: to.Ptr("restorabledroppeddatabasetest-2764"),
		// 				DeletionDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-27T02:16:08.403Z"); return t}()),
		// 				EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-04-21T02:49:47.690Z"); return t}()),
		// 				Edition: to.Ptr("Standard"),
		// 				MaxSizeBytes: to.Ptr("268435456000"),
		// 				ServiceLevelObjective: to.Ptr("S0"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type RestorableDroppedSQLPoolsClientGetOptions added in v0.2.0 

type RestorableDroppedSQLPoolsClientGetOptions struct {
}

RestorableDroppedSQLPoolsClientGetOptions contains the optional parameters for the RestorableDroppedSQLPoolsClient.Get method.

type RestorableDroppedSQLPoolsClientGetResponse added in v0.2.0 

type RestorableDroppedSQLPoolsClientGetResponse struct {
	// A restorable dropped Sql pool
	RestorableDroppedSQLPool
}

RestorableDroppedSQLPoolsClientGetResponse contains the response from method RestorableDroppedSQLPoolsClient.Get.

type RestorableDroppedSQLPoolsClientListByWorkspaceOptions added in v0.2.0 

type RestorableDroppedSQLPoolsClientListByWorkspaceOptions struct {
}

RestorableDroppedSQLPoolsClientListByWorkspaceOptions contains the optional parameters for the RestorableDroppedSQLPoolsClient.NewListByWorkspacePager method.

type RestorableDroppedSQLPoolsClientListByWorkspaceResponse added in v0.2.0 

type RestorableDroppedSQLPoolsClientListByWorkspaceResponse struct {
	// The response to a list restorable dropped Sql pools request
	RestorableDroppedSQLPoolListResult
}

RestorableDroppedSQLPoolsClientListByWorkspaceResponse contains the response from method RestorableDroppedSQLPoolsClient.NewListByWorkspacePager.

type RestorePoint 

type RestorePoint struct {
	// Resource properties.
	Properties *RestorePointProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; Resource location.
	Location *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

RestorePoint - Database restore points.

func (RestorePoint) MarshalJSON 

func (r RestorePoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RestorePoint.

func (*RestorePoint) UnmarshalJSON 

func (r *RestorePoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RestorePoint.

type RestorePointListResult 

type RestorePointListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*RestorePoint
}

RestorePointListResult - A list of long term retention backups.

func (RestorePointListResult) MarshalJSON 

func (r RestorePointListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RestorePointListResult.

func (*RestorePointListResult) UnmarshalJSON added in v0.6.0 

func (r *RestorePointListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RestorePointListResult.

type RestorePointProperties 

type RestorePointProperties struct {
	// READ-ONLY; The earliest time to which this database can be restored
	EarliestRestoreDate *time.Time

	// READ-ONLY; The time the backup was taken
	RestorePointCreationDate *time.Time

	// READ-ONLY; The label of restore point for backup request by user
	RestorePointLabel *string

	// READ-ONLY; The type of restore point
	RestorePointType *RestorePointType
}

RestorePointProperties - Properties of a database restore point

func (RestorePointProperties) MarshalJSON 

func (r RestorePointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RestorePointProperties.

func (*RestorePointProperties) UnmarshalJSON 

func (r *RestorePointProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RestorePointProperties.

type RestorePointType 

type RestorePointType string

RestorePointType - The type of restore point 

const (
	RestorePointTypeCONTINUOUS RestorePointType = "CONTINUOUS"
	RestorePointTypeDISCRETE   RestorePointType = "DISCRETE"
)

func PossibleRestorePointTypeValues 

func PossibleRestorePointTypeValues() []RestorePointType

PossibleRestorePointTypeValues returns the possible values for the RestorePointType const type.

type SKU 

type SKU struct {
	// If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the
	// resource this may be omitted.
	Capacity *int32

	// The SKU name
	Name *string

	// The service tier
	Tier *string
}

SKU - SQL pool SKU

func (SKU) MarshalJSON added in v0.6.0 

func (s SKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKU.

func (*SKU) UnmarshalJSON added in v0.6.0 

func (s *SKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKU.

type SKUDescription 

type SKUDescription struct {
	// READ-ONLY; Locations and zones
	LocationInfo []*SKULocationInfoItem

	// READ-ONLY; The set of locations that the SKU is available
	Locations []*string

	// READ-ONLY; The name of the SKU
	Name *string

	// READ-ONLY; The resource type
	ResourceType *string

	// READ-ONLY; The restrictions because of which SKU cannot be used
	Restrictions []any

	// READ-ONLY; The size of the SKU
	Size *string
}

SKUDescription - The Kusto SKU description of given resource type

func (SKUDescription) MarshalJSON 

func (s SKUDescription) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUDescription.

func (*SKUDescription) UnmarshalJSON added in v0.6.0 

func (s *SKUDescription) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUDescription.

type SKUDescriptionList 

type SKUDescriptionList struct {
	// READ-ONLY; SKU descriptions
	Value []*SKUDescription
}

SKUDescriptionList - The list of the SKU descriptions

func (SKUDescriptionList) MarshalJSON 

func (s SKUDescriptionList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUDescriptionList.

func (*SKUDescriptionList) UnmarshalJSON added in v0.6.0 

func (s *SKUDescriptionList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUDescriptionList.

type SKULocationInfoItem 

type SKULocationInfoItem struct {
	// REQUIRED; The available location of the SKU.
	Location *string

	// The available zone of the SKU.
	Zones []*string
}

SKULocationInfoItem - The locations and zones info for SKU.

func (SKULocationInfoItem) MarshalJSON 

func (s SKULocationInfoItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKULocationInfoItem.

func (*SKULocationInfoItem) UnmarshalJSON added in v0.6.0 

func (s *SKULocationInfoItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKULocationInfoItem.

type SKUName 

type SKUName string

SKUName - SKU name. 

const (
	SKUNameComputeOptimized SKUName = "Compute optimized"
	SKUNameStorageOptimized SKUName = "Storage optimized"
)

func PossibleSKUNameValues 

func PossibleSKUNameValues() []SKUName

PossibleSKUNameValues returns the possible values for the SKUName const type.

type SKUSize 

type SKUSize string

SKUSize - SKU size. 

const (
	SKUSizeExtraSmall SKUSize = "Extra small"
	SKUSizeLarge      SKUSize = "Large"
	SKUSizeMedium     SKUSize = "Medium"
	SKUSizeSmall      SKUSize = "Small"
)

func PossibleSKUSizeValues 

func PossibleSKUSizeValues() []SKUSize

PossibleSKUSizeValues returns the possible values for the SKUSize const type.

type SQLPool 

type SQLPool struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// SQL pool properties
	Properties *SQLPoolResourceProperties

	// SQL pool SKU
	SKU *SKU

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLPool - A SQL Analytics pool

func (SQLPool) MarshalJSON 

func (s SQLPool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPool.

func (*SQLPool) UnmarshalJSON 

func (s *SQLPool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPool.

type SQLPoolBlobAuditingPoliciesClient 

type SQLPoolBlobAuditingPoliciesClient struct {
	// contains filtered or unexported fields
}

SQLPoolBlobAuditingPoliciesClient contains the methods for the SQLPoolBlobAuditingPolicies group. Don't use this type directly, use NewSQLPoolBlobAuditingPoliciesClient() instead.

func NewSQLPoolBlobAuditingPoliciesClient 

func NewSQLPoolBlobAuditingPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolBlobAuditingPoliciesClient, error)

NewSQLPoolBlobAuditingPoliciesClient creates a new instance of SQLPoolBlobAuditingPoliciesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolBlobAuditingPoliciesClient) CreateOrUpdate 

func (client *SQLPoolBlobAuditingPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, parameters SQLPoolBlobAuditingPolicy, options *SQLPoolBlobAuditingPoliciesClientCreateOrUpdateOptions) (SQLPoolBlobAuditingPoliciesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a SQL pool's blob auditing policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • parameters - The database blob auditing policy.
  • options - SQLPoolBlobAuditingPoliciesClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolBlobAuditingPoliciesClient.CreateOrUpdate method.
Example (CreateOrUpdateADatabasesBlobAuditingPolicyWithAllParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolBlobAuditingWithAllParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolBlobAuditingPoliciesClient().CreateOrUpdate(ctx, "blobauditingtest-4799", "blobauditingtest-6440", "testdb", armsynapse.SQLPoolBlobAuditingPolicy{
		Properties: &armsynapse.SQLPoolBlobAuditingPolicyProperties{
			AuditActionsAndGroups: []*string{
				to.Ptr("DATABASE_LOGOUT_GROUP"),
				to.Ptr("DATABASE_ROLE_MEMBER_CHANGE_GROUP"),
				to.Ptr("UPDATE on database::TestDatabaseName by public")},
			IsAzureMonitorTargetEnabled:  to.Ptr(true),
			IsStorageSecondaryKeyInUse:   to.Ptr(false),
			RetentionDays:                to.Ptr[int32](6),
			State:                        to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
			StorageAccountAccessKey:      to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageAccountSubscriptionID: to.Ptr("00000000-1234-0000-5678-000000000000"),
			StorageEndpoint:              to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolBlobAuditingPolicy = armsynapse.SQLPoolBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/auditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb"),
	// 	Kind: to.Ptr("V12"),
	// 	Properties: &armsynapse.SQLPoolBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 			to.Ptr("DATABASE_LOGOUT_GROUP"),
	// 			to.Ptr("DATABASE_ROLE_MEMBER_CHANGE_GROUP"),
	// 			to.Ptr("UPDATE on database::TestDatabaseName by public")},
	// 			IsAzureMonitorTargetEnabled: to.Ptr(true),
	// 			IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 			RetentionDays: to.Ptr[int32](0),
	// 			State: to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
	// 			StorageAccountSubscriptionID: to.Ptr("00000000-1234-0000-5678-000000000000"),
	// 			StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 		},
	// 	}
}

Output:
Example (CreateOrUpdateADatabasesBlobAuditingPolicyWithMinimalParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolBlobAuditingWithMinParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolBlobAuditingPoliciesClient().CreateOrUpdate(ctx, "blobauditingtest-4799", "blobauditingtest-6440", "testdb", armsynapse.SQLPoolBlobAuditingPolicy{
		Properties: &armsynapse.SQLPoolBlobAuditingPolicyProperties{
			State:                   to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
			StorageAccountAccessKey: to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageEndpoint:         to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolBlobAuditingPolicy = armsynapse.SQLPoolBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/auditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb"),
	// 	Kind: to.Ptr("V12"),
	// 	Properties: &armsynapse.SQLPoolBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 			to.Ptr("SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("FAILED_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("BATCH_COMPLETED_GROUP")},
	// 			IsAzureMonitorTargetEnabled: to.Ptr(false),
	// 			IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 			RetentionDays: to.Ptr[int32](0),
	// 			State: to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
	// 			StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 			StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 		},
	// 	}
}

Output:

func (*SQLPoolBlobAuditingPoliciesClient) Get 

func (client *SQLPoolBlobAuditingPoliciesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolBlobAuditingPoliciesClientGetOptions) (SQLPoolBlobAuditingPoliciesClientGetResponse, error)

Get - Get a SQL pool's blob auditing policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolBlobAuditingPoliciesClientGetOptions contains the optional parameters for the SQLPoolBlobAuditingPoliciesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolBlobAuditing.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolBlobAuditingPoliciesClient().Get(ctx, "blobauditingtest-6852", "blobauditingtest-2080", "testdb", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolBlobAuditingPolicy = armsynapse.SQLPoolBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/auditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb"),
	// 	Kind: to.Ptr("V12"),
	// 	Properties: &armsynapse.SQLPoolBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 		},
	// 		IsAzureMonitorTargetEnabled: to.Ptr(false),
	// 		IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 		RetentionDays: to.Ptr[int32](0),
	// 		State: to.Ptr(armsynapse.BlobAuditingPolicyStateDisabled),
	// 		StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		StorageEndpoint: to.Ptr(""),
	// 	},
	// }
}

Output:

func (*SQLPoolBlobAuditingPoliciesClient) NewListBySQLPoolPager added in v0.4.0 

func (client *SQLPoolBlobAuditingPoliciesClient) NewListBySQLPoolPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolBlobAuditingPoliciesClientListBySQLPoolOptions) *runtime.Pager[SQLPoolBlobAuditingPoliciesClientListBySQLPoolResponse]

NewListBySQLPoolPager - Lists auditing settings of a Sql pool.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolBlobAuditingPoliciesClientListBySQLPoolOptions contains the optional parameters for the SQLPoolBlobAuditingPoliciesClient.NewListBySQLPoolPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolAuditingSettingsList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolBlobAuditingPoliciesClient().NewListBySQLPoolPager("blobauditingtest-6852", "blobauditingtest-2080", "testdb", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLPoolBlobAuditingPolicyListResult = armsynapse.SQLPoolBlobAuditingPolicyListResult{
		// 	Value: []*armsynapse.SQLPoolBlobAuditingPolicy{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/auditingSettings"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb"),
		// 			Kind: to.Ptr("V12"),
		// 			Properties: &armsynapse.SQLPoolBlobAuditingPolicyProperties{
		// 				AuditActionsAndGroups: []*string{
		// 				},
		// 				IsAzureMonitorTargetEnabled: to.Ptr(false),
		// 				IsStorageSecondaryKeyInUse: to.Ptr(false),
		// 				RetentionDays: to.Ptr[int32](0),
		// 				State: to.Ptr(armsynapse.BlobAuditingPolicyStateDisabled),
		// 				StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				StorageEndpoint: to.Ptr(""),
		// 			},
		// 	}},
		// }
	}
}

Output:

type SQLPoolBlobAuditingPoliciesClientCreateOrUpdateOptions added in v0.2.0 

type SQLPoolBlobAuditingPoliciesClientCreateOrUpdateOptions struct {
}

SQLPoolBlobAuditingPoliciesClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolBlobAuditingPoliciesClient.CreateOrUpdate method.

type SQLPoolBlobAuditingPoliciesClientCreateOrUpdateResponse added in v0.2.0 

type SQLPoolBlobAuditingPoliciesClientCreateOrUpdateResponse struct {
	// A Sql pool blob auditing policy.
	SQLPoolBlobAuditingPolicy
}

SQLPoolBlobAuditingPoliciesClientCreateOrUpdateResponse contains the response from method SQLPoolBlobAuditingPoliciesClient.CreateOrUpdate.

type SQLPoolBlobAuditingPoliciesClientGetOptions added in v0.2.0 

type SQLPoolBlobAuditingPoliciesClientGetOptions struct {
}

SQLPoolBlobAuditingPoliciesClientGetOptions contains the optional parameters for the SQLPoolBlobAuditingPoliciesClient.Get method.

type SQLPoolBlobAuditingPoliciesClientGetResponse added in v0.2.0 

type SQLPoolBlobAuditingPoliciesClientGetResponse struct {
	// A Sql pool blob auditing policy.
	SQLPoolBlobAuditingPolicy
}

SQLPoolBlobAuditingPoliciesClientGetResponse contains the response from method SQLPoolBlobAuditingPoliciesClient.Get.

type SQLPoolBlobAuditingPoliciesClientListBySQLPoolOptions added in v0.2.0 

type SQLPoolBlobAuditingPoliciesClientListBySQLPoolOptions struct {
}

SQLPoolBlobAuditingPoliciesClientListBySQLPoolOptions contains the optional parameters for the SQLPoolBlobAuditingPoliciesClient.NewListBySQLPoolPager method.

type SQLPoolBlobAuditingPoliciesClientListBySQLPoolResponse added in v0.2.0 

type SQLPoolBlobAuditingPoliciesClientListBySQLPoolResponse struct {
	// A list of Sql pool auditing settings.
	SQLPoolBlobAuditingPolicyListResult
}

SQLPoolBlobAuditingPoliciesClientListBySQLPoolResponse contains the response from method SQLPoolBlobAuditingPoliciesClient.NewListBySQLPoolPager.

type SQLPoolBlobAuditingPolicy 

type SQLPoolBlobAuditingPolicy struct {
	// Resource properties.
	Properties *SQLPoolBlobAuditingPolicyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; Resource kind.
	Kind *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLPoolBlobAuditingPolicy - A Sql pool blob auditing policy.

func (SQLPoolBlobAuditingPolicy) MarshalJSON 

func (s SQLPoolBlobAuditingPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolBlobAuditingPolicy.

func (*SQLPoolBlobAuditingPolicy) UnmarshalJSON 

func (s *SQLPoolBlobAuditingPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolBlobAuditingPolicy.

type SQLPoolBlobAuditingPolicyListResult 

type SQLPoolBlobAuditingPolicyListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*SQLPoolBlobAuditingPolicy
}

SQLPoolBlobAuditingPolicyListResult - A list of Sql pool auditing settings.

func (SQLPoolBlobAuditingPolicyListResult) MarshalJSON 

func (s SQLPoolBlobAuditingPolicyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolBlobAuditingPolicyListResult.

func (*SQLPoolBlobAuditingPolicyListResult) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolBlobAuditingPolicyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolBlobAuditingPolicyListResult.

type SQLPoolBlobAuditingPolicyProperties 

type SQLPoolBlobAuditingPolicyProperties struct {
	// REQUIRED; Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.
	State *BlobAuditingPolicyState

	// Specifies the Actions-Groups and Actions to audit.
	// The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures
	// executed against the database, as well as successful and failed logins:
	// BATCHCOMPLETEDGROUP, SUCCESSFULDATABASEAUTHENTICATIONGROUP, FAILEDDATABASEAUTHENTICATIONGROUP.
	// This above combination is also the set that is configured by default when enabling auditing from the Azure portal.
	// The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary
	// groups could lead to very large quantities of audit records):
	// APPLICATIONROLECHANGEPASSWORDGROUP BACKUPRESTOREGROUP DATABASELOGOUTGROUP DATABASEOBJECTCHANGEGROUP DATABASEOBJECTOWNERSHIPCHANGEGROUP
	// DATABASEOBJECTPERMISSIONCHANGEGROUP DATABASEOPERATIONGROUP
	// DATABASEPERMISSIONCHANGEGROUP DATABASEPRINCIPALCHANGEGROUP DATABASEPRINCIPALIMPERSONATIONGROUP DATABASEROLEMEMBERCHANGEGROUP
	// FAILEDDATABASEAUTHENTICATIONGROUP SCHEMAOBJECTACCESSGROUP SCHEMAOBJECT
	// CHANGEGROUP SCHEMAOBJECTOWNERSHIPCHANGEGROUP SCHEMAOBJECTPERMISSIONCHANGEGROUP SUCCESSFULDATABASEAUTHENTICATIONGROUP USERCHANGEPASSWORDGROUP
	// BATCHSTARTEDGROUP BATCHCOMPLETED_GROUP
	// These are groups that cover all sql statements and stored procedures executed against the database, and should not be used
	// in combination with other groups as this will result in duplicate audit logs.
	// For more information, see Database-Level Audit Action Groups
	// [https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups].
	// For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server
	// auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE
	// EXECUTE RECEIVE REFERENCES
	// The general form for defining an action to be audited is: {action} ON {object} BY {principal}
	// Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or
	// schema. For the latter cases, the forms DATABASE::{dbname} and SCHEMA::{schema
	// name} are used, respectively.
	// For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public
	// For more information, see Database-Level Audit Actions
	// [https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions]
	AuditActionsAndGroups []*string

	// Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'state'
	// as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.
	// When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on
	// the database should be also created. Note that for server level audit you
	// should use the 'master' database as {databaseName}.
	// Diagnostic Settings URI format: PUT
	// https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview
	// For more information, see Diagnostic Settings REST API [https://go.microsoft.com/fwlink/?linkid=2033207]or Diagnostic Settings
	// PowerShell [https://go.microsoft.com/fwlink/?linkid=2033043]
	IsAzureMonitorTargetEnabled *bool

	// Specifies whether storageAccountAccessKey value is the storage's secondary key.
	IsStorageSecondaryKeyInUse *bool

	// Specifies the number of days to keep in the audit logs in the storage account.
	RetentionDays *int32

	// Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey
	// is required.
	StorageAccountAccessKey *string

	// Specifies the blob storage subscription Id.
	StorageAccountSubscriptionID *string

	// Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint
	// is required.
	StorageEndpoint *string
}

SQLPoolBlobAuditingPolicyProperties - Properties of a Sql pool blob auditing policy.

func (SQLPoolBlobAuditingPolicyProperties) MarshalJSON 

func (s SQLPoolBlobAuditingPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolBlobAuditingPolicyProperties.

func (*SQLPoolBlobAuditingPolicyProperties) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolBlobAuditingPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolBlobAuditingPolicyProperties.

type SQLPoolBlobAuditingPolicySQLPoolOperationListResult 

type SQLPoolBlobAuditingPolicySQLPoolOperationListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*SQLPoolOperation
}

SQLPoolBlobAuditingPolicySQLPoolOperationListResult - The response to a list Sql pool operations request

func (SQLPoolBlobAuditingPolicySQLPoolOperationListResult) MarshalJSON 

func (s SQLPoolBlobAuditingPolicySQLPoolOperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolBlobAuditingPolicySQLPoolOperationListResult.

func (*SQLPoolBlobAuditingPolicySQLPoolOperationListResult) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolBlobAuditingPolicySQLPoolOperationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolBlobAuditingPolicySQLPoolOperationListResult.

type SQLPoolColumn 

type SQLPoolColumn struct {
	// Resource properties.
	Properties *SQLPoolColumnProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLPoolColumn - A Sql pool column resource.

func (SQLPoolColumn) MarshalJSON 

func (s SQLPoolColumn) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolColumn.

func (*SQLPoolColumn) UnmarshalJSON 

func (s *SQLPoolColumn) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolColumn.

type SQLPoolColumnListResult 

type SQLPoolColumnListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*SQLPoolColumn
}

SQLPoolColumnListResult - A list of Sql pool columns.

func (SQLPoolColumnListResult) MarshalJSON 

func (s SQLPoolColumnListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolColumnListResult.

func (*SQLPoolColumnListResult) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolColumnListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolColumnListResult.

type SQLPoolColumnProperties 

type SQLPoolColumnProperties struct {
	// The column data type.
	ColumnType *ColumnDataType

	// READ-ONLY; Indicates whether column value is computed or not
	IsComputed *bool
}

SQLPoolColumnProperties - Sql pool column properties.

func (SQLPoolColumnProperties) MarshalJSON added in v0.6.0 

func (s SQLPoolColumnProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolColumnProperties.

func (*SQLPoolColumnProperties) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolColumnProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolColumnProperties.

type SQLPoolColumnsClient 

type SQLPoolColumnsClient struct {
	// contains filtered or unexported fields
}

SQLPoolColumnsClient contains the methods for the SQLPoolColumns group. Don't use this type directly, use NewSQLPoolColumnsClient() instead.

func NewSQLPoolColumnsClient 

func NewSQLPoolColumnsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolColumnsClient, error)

NewSQLPoolColumnsClient creates a new instance of SQLPoolColumnsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolColumnsClient) Get 

func (client *SQLPoolColumnsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, schemaName string, tableName string, columnName string, options *SQLPoolColumnsClientGetOptions) (SQLPoolColumnsClientGetResponse, error)

Get - Get Sql pool column If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • schemaName - The name of the schema.
  • tableName - The name of the table.
  • columnName - The name of the column.
  • options - SQLPoolColumnsClientGetOptions contains the optional parameters for the SQLPoolColumnsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolColumnGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolColumnsClient().Get(ctx, "myRG", "serverName", "myDatabase", "dbo", "table1", "column1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolColumn = armsynapse.SQLPoolColumn{
	// 	Name: to.Ptr("column1"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table1/columns/column1"),
	// 	Properties: &armsynapse.SQLPoolColumnProperties{
	// 		ColumnType: to.Ptr(armsynapse.ColumnDataTypeBit),
	// 	},
	// }
}

Output:

type SQLPoolColumnsClientGetOptions added in v0.2.0 

type SQLPoolColumnsClientGetOptions struct {
}

SQLPoolColumnsClientGetOptions contains the optional parameters for the SQLPoolColumnsClient.Get method.

type SQLPoolColumnsClientGetResponse added in v0.2.0 

type SQLPoolColumnsClientGetResponse struct {
	// A Sql pool column resource.
	SQLPoolColumn
}

SQLPoolColumnsClientGetResponse contains the response from method SQLPoolColumnsClient.Get.

type SQLPoolConnectionPoliciesClient 

type SQLPoolConnectionPoliciesClient struct {
	// contains filtered or unexported fields
}

SQLPoolConnectionPoliciesClient contains the methods for the SQLPoolConnectionPolicies group. Don't use this type directly, use NewSQLPoolConnectionPoliciesClient() instead.

func NewSQLPoolConnectionPoliciesClient 

func NewSQLPoolConnectionPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolConnectionPoliciesClient, error)

NewSQLPoolConnectionPoliciesClient creates a new instance of SQLPoolConnectionPoliciesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolConnectionPoliciesClient) Get 

func (client *SQLPoolConnectionPoliciesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, connectionPolicyName ConnectionPolicyName, options *SQLPoolConnectionPoliciesClientGetOptions) (SQLPoolConnectionPoliciesClientGetResponse, error)

Get - Get a Sql pool's connection policy, which is used with table auditing. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • connectionPolicyName - The name of the connection policy.
  • options - SQLPoolConnectionPoliciesClientGetOptions contains the optional parameters for the SQLPoolConnectionPoliciesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolConnectionPolicy.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolConnectionPoliciesClient().Get(ctx, "blobauditingtest-6852", "blobauditingtest-2080", "testdb", armsynapse.ConnectionPolicyNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolConnectionPolicy = armsynapse.SQLPoolConnectionPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/connectionPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb/connectionPolicies/default"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armsynapse.SQLPoolConnectionPolicyProperties{
	// 		ProxyDNSName: to.Ptr("blobauditingtest-2080.database.secure.windows.net"),
	// 		ProxyPort: to.Ptr("1433"),
	// 		RedirectionState: to.Ptr("Disabled"),
	// 		SecurityEnabledAccess: to.Ptr("Optional"),
	// 		State: to.Ptr("New"),
	// 		UseServerDefault: to.Ptr("Enabled"),
	// 		Visibility: to.Ptr("Visible"),
	// 	},
	// }
}

Output:

type SQLPoolConnectionPoliciesClientGetOptions added in v0.2.0 

type SQLPoolConnectionPoliciesClientGetOptions struct {
}

SQLPoolConnectionPoliciesClientGetOptions contains the optional parameters for the SQLPoolConnectionPoliciesClient.Get method.

type SQLPoolConnectionPoliciesClientGetResponse added in v0.2.0 

type SQLPoolConnectionPoliciesClientGetResponse struct {
	// A Sql pool connection policy.
	SQLPoolConnectionPolicy
}

SQLPoolConnectionPoliciesClientGetResponse contains the response from method SQLPoolConnectionPoliciesClient.Get.

type SQLPoolConnectionPolicy 

type SQLPoolConnectionPolicy struct {
	// Resource properties.
	Properties *SQLPoolConnectionPolicyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; Resource kind.
	Kind *string

	// READ-ONLY; Resource location.
	Location *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLPoolConnectionPolicy - A Sql pool connection policy.

func (SQLPoolConnectionPolicy) MarshalJSON 

func (s SQLPoolConnectionPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolConnectionPolicy.

func (*SQLPoolConnectionPolicy) UnmarshalJSON 

func (s *SQLPoolConnectionPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolConnectionPolicy.

type SQLPoolConnectionPolicyProperties 

type SQLPoolConnectionPolicyProperties struct {
	// The fully qualified host name of the auditing proxy.
	ProxyDNSName *string

	// The port number of the auditing proxy.
	ProxyPort *string

	// The state of proxy redirection.
	RedirectionState *string

	// The state of security access.
	SecurityEnabledAccess *string

	// The connection policy state.
	State *string

	// Whether server default is enabled or disabled.
	UseServerDefault *string

	// The visibility of the auditing proxy.
	Visibility *string
}

SQLPoolConnectionPolicyProperties - Properties of a Sql pool connection policy.

func (SQLPoolConnectionPolicyProperties) MarshalJSON added in v0.6.0 

func (s SQLPoolConnectionPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolConnectionPolicyProperties.

func (*SQLPoolConnectionPolicyProperties) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolConnectionPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolConnectionPolicyProperties.

type SQLPoolDataWarehouseUserActivitiesClient 

type SQLPoolDataWarehouseUserActivitiesClient struct {
	// contains filtered or unexported fields
}

SQLPoolDataWarehouseUserActivitiesClient contains the methods for the SQLPoolDataWarehouseUserActivities group. Don't use this type directly, use NewSQLPoolDataWarehouseUserActivitiesClient() instead.

func NewSQLPoolDataWarehouseUserActivitiesClient 

func NewSQLPoolDataWarehouseUserActivitiesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolDataWarehouseUserActivitiesClient, error)

NewSQLPoolDataWarehouseUserActivitiesClient creates a new instance of SQLPoolDataWarehouseUserActivitiesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolDataWarehouseUserActivitiesClient) Get 

func (client *SQLPoolDataWarehouseUserActivitiesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, dataWarehouseUserActivityName DataWarehouseUserActivityName, options *SQLPoolDataWarehouseUserActivitiesClientGetOptions) (SQLPoolDataWarehouseUserActivitiesClientGetResponse, error)

Get - Gets the user activities of a SQL pool which includes running and suspended queries If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • dataWarehouseUserActivityName - The activity name of the Sql pool.
  • options - SQLPoolDataWarehouseUserActivitiesClientGetOptions contains the optional parameters for the SQLPoolDataWarehouseUserActivitiesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolUserActivity.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolDataWarehouseUserActivitiesClient().Get(ctx, "Default-SQL-SouthEastAsia", "testsvr", "testdb", armsynapse.DataWarehouseUserActivityNameCurrent, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataWarehouseUserActivities = armsynapse.DataWarehouseUserActivities{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/dataWarehouseUserActivities"),
	// 	ID: to.Ptr("subscriptions/326affc3-21f4-4471-a545-e37430b70113/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/dwdb01/dataWarehouseUserActivities/current"),
	// 	Properties: &armsynapse.DataWarehouseUserActivitiesProperties{
	// 		ActiveQueriesCount: to.Ptr[int32](0),
	// 	},
	// }
}

Output:

type SQLPoolDataWarehouseUserActivitiesClientGetOptions added in v0.2.0 

type SQLPoolDataWarehouseUserActivitiesClientGetOptions struct {
}

SQLPoolDataWarehouseUserActivitiesClientGetOptions contains the optional parameters for the SQLPoolDataWarehouseUserActivitiesClient.Get method.

type SQLPoolDataWarehouseUserActivitiesClientGetResponse added in v0.2.0 

type SQLPoolDataWarehouseUserActivitiesClientGetResponse struct {
	// User activities of a data warehouse
	DataWarehouseUserActivities
}

SQLPoolDataWarehouseUserActivitiesClientGetResponse contains the response from method SQLPoolDataWarehouseUserActivitiesClient.Get.

type SQLPoolGeoBackupPoliciesClient 

type SQLPoolGeoBackupPoliciesClient struct {
	// contains filtered or unexported fields
}

SQLPoolGeoBackupPoliciesClient contains the methods for the SQLPoolGeoBackupPolicies group. Don't use this type directly, use NewSQLPoolGeoBackupPoliciesClient() instead.

func NewSQLPoolGeoBackupPoliciesClient 

func NewSQLPoolGeoBackupPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolGeoBackupPoliciesClient, error)

NewSQLPoolGeoBackupPoliciesClient creates a new instance of SQLPoolGeoBackupPoliciesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolGeoBackupPoliciesClient) CreateOrUpdate 

func (client *SQLPoolGeoBackupPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, geoBackupPolicyName GeoBackupPolicyName, parameters GeoBackupPolicy, options *SQLPoolGeoBackupPoliciesClientCreateOrUpdateOptions) (SQLPoolGeoBackupPoliciesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Updates a SQL Pool geo backup policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • geoBackupPolicyName - The name of the geo backup policy.
  • parameters - The required parameters for creating or updating the geo backup policy.
  • options - SQLPoolGeoBackupPoliciesClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolGeoBackupPoliciesClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateGeoBackupPolicies.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolGeoBackupPoliciesClient().CreateOrUpdate(ctx, "testrg", "testws", "testdw", armsynapse.GeoBackupPolicyNameDefault, armsynapse.GeoBackupPolicy{
		Properties: &armsynapse.GeoBackupPolicyProperties{
			State: to.Ptr(armsynapse.GeoBackupPolicyStateEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.GeoBackupPolicy = armsynapse.GeoBackupPolicy{
	// 	Name: to.Ptr("Default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlpools/geoBackupPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Synapse/workspaces/testws/databases/testdw/geoBackupPolicies/Default"),
	// 	Properties: &armsynapse.GeoBackupPolicyProperties{
	// 		State: to.Ptr(armsynapse.GeoBackupPolicyStateEnabled),
	// 	},
	// }
}

Output:

func (*SQLPoolGeoBackupPoliciesClient) Get 

func (client *SQLPoolGeoBackupPoliciesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, geoBackupPolicyName GeoBackupPolicyName, options *SQLPoolGeoBackupPoliciesClientGetOptions) (SQLPoolGeoBackupPoliciesClientGetResponse, error)

Get - Get the specified SQL pool geo backup policy If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • geoBackupPolicyName - The name of the geo backup policy.
  • options - SQLPoolGeoBackupPoliciesClientGetOptions contains the optional parameters for the SQLPoolGeoBackupPoliciesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolGeoBackupPolicy.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolGeoBackupPoliciesClient().Get(ctx, "sqlcrudtest-4799", "sqlcrudtest-5961", "testdw", armsynapse.GeoBackupPolicyNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.GeoBackupPolicy = armsynapse.GeoBackupPolicy{
	// 	Name: to.Ptr("Default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-5961/sqlPools/testdw/geoBackupPolicies/Default"),
	// 	Location: to.Ptr("Central US"),
	// 	Properties: &armsynapse.GeoBackupPolicyProperties{
	// 		State: to.Ptr(armsynapse.GeoBackupPolicyStateEnabled),
	// 		StorageType: to.Ptr("Premium"),
	// 	},
	// }
}

Output:

func (*SQLPoolGeoBackupPoliciesClient) NewListPager added in v0.4.0 

func (client *SQLPoolGeoBackupPoliciesClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolGeoBackupPoliciesClientListOptions) *runtime.Pager[SQLPoolGeoBackupPoliciesClientListResponse]

NewListPager - Get list of SQL pool geo backup policies

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolGeoBackupPoliciesClientListOptions contains the optional parameters for the SQLPoolGeoBackupPoliciesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolGeoBackupPolicies_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolGeoBackupPoliciesClient().NewListPager("sqlcrudtest-4799", "sqlcrudtest-5961", "testdw", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.GeoBackupPolicyListResult = armsynapse.GeoBackupPolicyListResult{
		// 	Value: []*armsynapse.GeoBackupPolicy{
		// 		{
		// 			Name: to.Ptr("Default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-5961/sqlPools/testdw/geoBackupPolicies/Default"),
		// 			Location: to.Ptr("Central US"),
		// 			Properties: &armsynapse.GeoBackupPolicyProperties{
		// 				State: to.Ptr(armsynapse.GeoBackupPolicyStateEnabled),
		// 				StorageType: to.Ptr("Premium"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type SQLPoolGeoBackupPoliciesClientCreateOrUpdateOptions added in v0.2.0 

type SQLPoolGeoBackupPoliciesClientCreateOrUpdateOptions struct {
}

SQLPoolGeoBackupPoliciesClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolGeoBackupPoliciesClient.CreateOrUpdate method.

type SQLPoolGeoBackupPoliciesClientCreateOrUpdateResponse added in v0.2.0 

type SQLPoolGeoBackupPoliciesClientCreateOrUpdateResponse struct {
	// A database geo backup policy.
	GeoBackupPolicy
}

SQLPoolGeoBackupPoliciesClientCreateOrUpdateResponse contains the response from method SQLPoolGeoBackupPoliciesClient.CreateOrUpdate.

type SQLPoolGeoBackupPoliciesClientGetOptions added in v0.2.0 

type SQLPoolGeoBackupPoliciesClientGetOptions struct {
}

SQLPoolGeoBackupPoliciesClientGetOptions contains the optional parameters for the SQLPoolGeoBackupPoliciesClient.Get method.

type SQLPoolGeoBackupPoliciesClientGetResponse added in v0.2.0 

type SQLPoolGeoBackupPoliciesClientGetResponse struct {
	// A database geo backup policy.
	GeoBackupPolicy
}

SQLPoolGeoBackupPoliciesClientGetResponse contains the response from method SQLPoolGeoBackupPoliciesClient.Get.

type SQLPoolGeoBackupPoliciesClientListOptions added in v0.2.0 

type SQLPoolGeoBackupPoliciesClientListOptions struct {
}

SQLPoolGeoBackupPoliciesClientListOptions contains the optional parameters for the SQLPoolGeoBackupPoliciesClient.NewListPager method.

type SQLPoolGeoBackupPoliciesClientListResponse added in v0.2.0 

type SQLPoolGeoBackupPoliciesClientListResponse struct {
	// The response to a list geo backup policies request.
	GeoBackupPolicyListResult
}

SQLPoolGeoBackupPoliciesClientListResponse contains the response from method SQLPoolGeoBackupPoliciesClient.NewListPager.

type SQLPoolInfoListResult 

type SQLPoolInfoListResult struct {
	// Link to the next page of results
	NextLink *string

	// List of SQL pools
	Value []*SQLPool
}

SQLPoolInfoListResult - List of SQL pools

func (SQLPoolInfoListResult) MarshalJSON 

func (s SQLPoolInfoListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolInfoListResult.

func (*SQLPoolInfoListResult) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolInfoListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolInfoListResult.

type SQLPoolMaintenanceWindowOptionsClient 

type SQLPoolMaintenanceWindowOptionsClient struct {
	// contains filtered or unexported fields
}

SQLPoolMaintenanceWindowOptionsClient contains the methods for the SQLPoolMaintenanceWindowOptions group. Don't use this type directly, use NewSQLPoolMaintenanceWindowOptionsClient() instead.

func NewSQLPoolMaintenanceWindowOptionsClient 

func NewSQLPoolMaintenanceWindowOptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolMaintenanceWindowOptionsClient, error)

NewSQLPoolMaintenanceWindowOptionsClient creates a new instance of SQLPoolMaintenanceWindowOptionsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolMaintenanceWindowOptionsClient) Get 

func (client *SQLPoolMaintenanceWindowOptionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, maintenanceWindowOptionsName string, options *SQLPoolMaintenanceWindowOptionsClientGetOptions) (SQLPoolMaintenanceWindowOptionsClientGetResponse, error)

Get - Get list of SQL pool's available maintenance windows. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • maintenanceWindowOptionsName - Maintenance window options name.
  • options - SQLPoolMaintenanceWindowOptionsClientGetOptions contains the optional parameters for the SQLPoolMaintenanceWindowOptionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetMaintenanceWindowOptions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolMaintenanceWindowOptionsClient().Get(ctx, "samplerg", "testworkspace", "testsp", "current", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MaintenanceWindowOptions = armsynapse.MaintenanceWindowOptions{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/maintenanceWindowOptions"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/samplerg/providers/Microsoft.Synapse/workspaces/testworkspace/sqlPools/testsp/maintenanceWindowOptions/current"),
	// 	Properties: &armsynapse.MaintenanceWindowOptionsProperties{
	// 		AllowMultipleMaintenanceWindowsPerCycle: to.Ptr(true),
	// 		DefaultDurationInMinutes: to.Ptr[int32](120),
	// 		IsEnabled: to.Ptr(true),
	// 		MaintenanceWindowCycles: []*armsynapse.MaintenanceWindowTimeRange{
	// 			{
	// 				DayOfWeek: to.Ptr(armsynapse.DayOfWeekSaturday),
	// 				Duration: to.Ptr("PT60M"),
	// 				StartTime: to.Ptr("00:00:00"),
	// 		}},
	// 		MinCycles: to.Ptr[int32](2),
	// 		MinDurationInMinutes: to.Ptr[int32](60),
	// 		TimeGranularityInMinutes: to.Ptr[int32](5),
	// 	},
	// }
}

Output:

type SQLPoolMaintenanceWindowOptionsClientGetOptions added in v0.2.0 

type SQLPoolMaintenanceWindowOptionsClientGetOptions struct {
}

SQLPoolMaintenanceWindowOptionsClientGetOptions contains the optional parameters for the SQLPoolMaintenanceWindowOptionsClient.Get method.

type SQLPoolMaintenanceWindowOptionsClientGetResponse added in v0.2.0 

type SQLPoolMaintenanceWindowOptionsClientGetResponse struct {
	// Maintenance window options.
	MaintenanceWindowOptions
}

SQLPoolMaintenanceWindowOptionsClientGetResponse contains the response from method SQLPoolMaintenanceWindowOptionsClient.Get.

type SQLPoolMaintenanceWindowsClient 

type SQLPoolMaintenanceWindowsClient struct {
	// contains filtered or unexported fields
}

SQLPoolMaintenanceWindowsClient contains the methods for the SQLPoolMaintenanceWindows group. Don't use this type directly, use NewSQLPoolMaintenanceWindowsClient() instead.

func NewSQLPoolMaintenanceWindowsClient 

func NewSQLPoolMaintenanceWindowsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolMaintenanceWindowsClient, error)

NewSQLPoolMaintenanceWindowsClient creates a new instance of SQLPoolMaintenanceWindowsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolMaintenanceWindowsClient) CreateOrUpdate 

func (client *SQLPoolMaintenanceWindowsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, maintenanceWindowName string, parameters MaintenanceWindows, options *SQLPoolMaintenanceWindowsClientCreateOrUpdateOptions) (SQLPoolMaintenanceWindowsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a Sql pool's maintenance windows settings. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • maintenanceWindowName - Maintenance window name.
  • parameters - The required parameters for creating or updating Maintenance Windows settings
  • options - SQLPoolMaintenanceWindowsClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolMaintenanceWindowsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateMaintenanceWindows.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSQLPoolMaintenanceWindowsClient().CreateOrUpdate(ctx, "samplerg", "testworkspace", "testsp", "current", armsynapse.MaintenanceWindows{
		Properties: &armsynapse.MaintenanceWindowsProperties{
			TimeRanges: []*armsynapse.MaintenanceWindowTimeRange{
				{
					DayOfWeek: to.Ptr(armsynapse.DayOfWeekSaturday),
					Duration:  to.Ptr("PT60M"),
					StartTime: to.Ptr("00:00:00"),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SQLPoolMaintenanceWindowsClient) Get 

func (client *SQLPoolMaintenanceWindowsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, maintenanceWindowName string, options *SQLPoolMaintenanceWindowsClientGetOptions) (SQLPoolMaintenanceWindowsClientGetResponse, error)

Get - Get a SQL pool's Maintenance Windows. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • maintenanceWindowName - Maintenance window name.
  • options - SQLPoolMaintenanceWindowsClientGetOptions contains the optional parameters for the SQLPoolMaintenanceWindowsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetMaintenanceWindows.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolMaintenanceWindowsClient().Get(ctx, "samplerg", "testworkspace", "testsp", "current", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MaintenanceWindows = armsynapse.MaintenanceWindows{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/maintenancewindows"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/samplerg/providers/Microsoft.Synapse/workspaces/testworkspace/sqlPools/testsp/maintenancewindows/current"),
	// 	Properties: &armsynapse.MaintenanceWindowsProperties{
	// 		TimeRanges: []*armsynapse.MaintenanceWindowTimeRange{
	// 			{
	// 				DayOfWeek: to.Ptr(armsynapse.DayOfWeekSaturday),
	// 				Duration: to.Ptr("PT60M"),
	// 				StartTime: to.Ptr("00:00:00"),
	// 		}},
	// 	},
	// }
}

Output:

type SQLPoolMaintenanceWindowsClientCreateOrUpdateOptions added in v0.2.0 

type SQLPoolMaintenanceWindowsClientCreateOrUpdateOptions struct {
}

SQLPoolMaintenanceWindowsClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolMaintenanceWindowsClient.CreateOrUpdate method.

type SQLPoolMaintenanceWindowsClientCreateOrUpdateResponse added in v0.2.0 

type SQLPoolMaintenanceWindowsClientCreateOrUpdateResponse struct {
}

SQLPoolMaintenanceWindowsClientCreateOrUpdateResponse contains the response from method SQLPoolMaintenanceWindowsClient.CreateOrUpdate.

type SQLPoolMaintenanceWindowsClientGetOptions added in v0.2.0 

type SQLPoolMaintenanceWindowsClientGetOptions struct {
}

SQLPoolMaintenanceWindowsClientGetOptions contains the optional parameters for the SQLPoolMaintenanceWindowsClient.Get method.

type SQLPoolMaintenanceWindowsClientGetResponse added in v0.2.0 

type SQLPoolMaintenanceWindowsClientGetResponse struct {
	// Maintenance windows.
	MaintenanceWindows
}

SQLPoolMaintenanceWindowsClientGetResponse contains the response from method SQLPoolMaintenanceWindowsClient.Get.

type SQLPoolMetadataSyncConfigsClient 

type SQLPoolMetadataSyncConfigsClient struct {
	// contains filtered or unexported fields
}

SQLPoolMetadataSyncConfigsClient contains the methods for the SQLPoolMetadataSyncConfigs group. Don't use this type directly, use NewSQLPoolMetadataSyncConfigsClient() instead.

func NewSQLPoolMetadataSyncConfigsClient 

func NewSQLPoolMetadataSyncConfigsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolMetadataSyncConfigsClient, error)

NewSQLPoolMetadataSyncConfigsClient creates a new instance of SQLPoolMetadataSyncConfigsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolMetadataSyncConfigsClient) Create 

func (client *SQLPoolMetadataSyncConfigsClient) Create(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, metadataSyncConfiguration MetadataSyncConfig, options *SQLPoolMetadataSyncConfigsClientCreateOptions) (SQLPoolMetadataSyncConfigsClientCreateResponse, error)

Create - Set the metadata sync configuration for a SQL pool If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • metadataSyncConfiguration - Metadata sync configuration
  • options - SQLPoolMetadataSyncConfigsClientCreateOptions contains the optional parameters for the SQLPoolMetadataSyncConfigsClient.Create method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateSqlPoolMetadataSyncConfig.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolMetadataSyncConfigsClient().Create(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExampleSqlPool", armsynapse.MetadataSyncConfig{
		Properties: &armsynapse.MetadataSyncConfigProperties{
			Enabled: to.Ptr(true),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MetadataSyncConfig = armsynapse.MetadataSyncConfig{
	// 	Name: to.Ptr("config"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools/metadataSync/config"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool/metadataSync/config"),
	// 	Properties: &armsynapse.MetadataSyncConfigProperties{
	// 		Enabled: to.Ptr(true),
	// 	},
	// }
}

Output:

func (*SQLPoolMetadataSyncConfigsClient) Get 

func (client *SQLPoolMetadataSyncConfigsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolMetadataSyncConfigsClientGetOptions) (SQLPoolMetadataSyncConfigsClientGetResponse, error)

Get - Get the metadata sync configuration for a SQL pool If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolMetadataSyncConfigsClientGetOptions contains the optional parameters for the SQLPoolMetadataSyncConfigsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolMetadataSyncConfig.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolMetadataSyncConfigsClient().Get(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExampleSqlPool", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MetadataSyncConfig = armsynapse.MetadataSyncConfig{
	// 	Name: to.Ptr("config"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/bigDataPools/metadataSync/config"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool/metadataSync/config"),
	// 	Properties: &armsynapse.MetadataSyncConfigProperties{
	// 		Enabled: to.Ptr(true),
	// 	},
	// }
}

Output:

type SQLPoolMetadataSyncConfigsClientCreateOptions added in v0.2.0 

type SQLPoolMetadataSyncConfigsClientCreateOptions struct {
}

SQLPoolMetadataSyncConfigsClientCreateOptions contains the optional parameters for the SQLPoolMetadataSyncConfigsClient.Create method.

type SQLPoolMetadataSyncConfigsClientCreateResponse added in v0.2.0 

type SQLPoolMetadataSyncConfigsClientCreateResponse struct {
	// Configuration for metadata sync
	MetadataSyncConfig
}

SQLPoolMetadataSyncConfigsClientCreateResponse contains the response from method SQLPoolMetadataSyncConfigsClient.Create.

type SQLPoolMetadataSyncConfigsClientGetOptions added in v0.2.0 

type SQLPoolMetadataSyncConfigsClientGetOptions struct {
}

SQLPoolMetadataSyncConfigsClientGetOptions contains the optional parameters for the SQLPoolMetadataSyncConfigsClient.Get method.

type SQLPoolMetadataSyncConfigsClientGetResponse added in v0.2.0 

type SQLPoolMetadataSyncConfigsClientGetResponse struct {
	// Configuration for metadata sync
	MetadataSyncConfig
}

SQLPoolMetadataSyncConfigsClientGetResponse contains the response from method SQLPoolMetadataSyncConfigsClient.Get.

type SQLPoolOperation 

type SQLPoolOperation struct {
	// Resource properties.
	Properties *SQLPoolOperationProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLPoolOperation - A Sql pool operation.

func (SQLPoolOperation) MarshalJSON 

func (s SQLPoolOperation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolOperation.

func (*SQLPoolOperation) UnmarshalJSON 

func (s *SQLPoolOperation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolOperation.

type SQLPoolOperationProperties 

type SQLPoolOperationProperties struct {
	// READ-ONLY; The name of the Sql pool the operation is being performed on.
	DatabaseName *string

	// READ-ONLY; The operation description.
	Description *string

	// READ-ONLY; The operation error code.
	ErrorCode *int32

	// READ-ONLY; The operation error description.
	ErrorDescription *string

	// READ-ONLY; The operation error severity.
	ErrorSeverity *int32

	// READ-ONLY; The estimated completion time of the operation.
	EstimatedCompletionTime *time.Time

	// READ-ONLY; Whether the operation can be cancelled.
	IsCancellable *bool

	// READ-ONLY; Whether or not the error is a user error.
	IsUserError *bool

	// READ-ONLY; The name of operation.
	Operation *string

	// READ-ONLY; The friendly name of operation.
	OperationFriendlyName *string

	// READ-ONLY; The percentage of the operation completed.
	PercentComplete *int32

	// READ-ONLY; The name of the server.
	ServerName *string

	// READ-ONLY; The operation start time.
	StartTime *time.Time

	// READ-ONLY; The operation state.
	State *ManagementOperationState
}

SQLPoolOperationProperties - The properties of a Sql pool operation.

func (SQLPoolOperationProperties) MarshalJSON 

func (s SQLPoolOperationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolOperationProperties.

func (*SQLPoolOperationProperties) UnmarshalJSON 

func (s *SQLPoolOperationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolOperationProperties.

type SQLPoolOperationResultsClient 

type SQLPoolOperationResultsClient struct {
	// contains filtered or unexported fields
}

SQLPoolOperationResultsClient contains the methods for the SQLPoolOperationResults group. Don't use this type directly, use NewSQLPoolOperationResultsClient() instead.

func NewSQLPoolOperationResultsClient 

func NewSQLPoolOperationResultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolOperationResultsClient, error)

NewSQLPoolOperationResultsClient creates a new instance of SQLPoolOperationResultsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolOperationResultsClient) BeginGetLocationHeaderResult added in v0.6.0 

func (client *SQLPoolOperationResultsClient) BeginGetLocationHeaderResult(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, operationID string, options *SQLPoolOperationResultsClientBeginGetLocationHeaderResultOptions) (*runtime.Poller[SQLPoolOperationResultsClientGetLocationHeaderResultResponse], error)

BeginGetLocationHeaderResult - Get the status of a SQL pool operation If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • operationID - Operation ID
  • options - SQLPoolOperationResultsClientBeginGetLocationHeaderResultOptions contains the optional parameters for the SQLPoolOperationResultsClient.BeginGetLocationHeaderResult method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetLocationHeaderResultWithSqlPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolOperationResultsClient().BeginGetLocationHeaderResult(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExampleSqlPool", "fedcba98-7654-4210-fedc-ba9876543210", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPool = armsynapse.SQLPool{
	// 	Name: to.Ptr("SampleSQLPool"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg_ursa/providers/Microsoft.Synapse/workspaces/ursascaneastus/sqlPools/SampleSQLPool"),
	// 	Location: to.Ptr("eastus"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armsynapse.SQLPoolResourceProperties{
	// 		Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-08-25T09:22:46.680Z"); return t}()),
	// 		MaxSizeBytes: to.Ptr[int64](263882790666240),
	// 		Status: to.Ptr("Paused"),
	// 	},
	// 	SKU: &armsynapse.SKU{
	// 	},
	// }
}

Output:

type SQLPoolOperationResultsClientBeginGetLocationHeaderResultOptions added in v0.6.0 

type SQLPoolOperationResultsClientBeginGetLocationHeaderResultOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolOperationResultsClientBeginGetLocationHeaderResultOptions contains the optional parameters for the SQLPoolOperationResultsClient.BeginGetLocationHeaderResult method.

type SQLPoolOperationResultsClientGetLocationHeaderResultResponse added in v0.2.0 

type SQLPoolOperationResultsClientGetLocationHeaderResultResponse struct {
	// A SQL Analytics pool
	SQLPool
}

SQLPoolOperationResultsClientGetLocationHeaderResultResponse contains the response from method SQLPoolOperationResultsClient.BeginGetLocationHeaderResult.

type SQLPoolOperationsClient 

type SQLPoolOperationsClient struct {
	// contains filtered or unexported fields
}

SQLPoolOperationsClient contains the methods for the SQLPoolOperations group. Don't use this type directly, use NewSQLPoolOperationsClient() instead.

func NewSQLPoolOperationsClient 

func NewSQLPoolOperationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolOperationsClient, error)

NewSQLPoolOperationsClient creates a new instance of SQLPoolOperationsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolOperationsClient) NewListPager added in v0.4.0 

func (client *SQLPoolOperationsClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolOperationsClientListOptions) *runtime.Pager[SQLPoolOperationsClientListResponse]

NewListPager - Gets a list of operations performed on the SQL pool.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolOperationsClientListOptions contains the optional parameters for the SQLPoolOperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolOperations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolOperationsClient().NewListPager("sqlcrudtest-7398", "sqlcrudtest-4645", "testdb", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLPoolBlobAuditingPolicySQLPoolOperationListResult = armsynapse.SQLPoolBlobAuditingPolicySQLPoolOperationListResult{
		// 	Value: []*armsynapse.SQLPoolOperation{
		// 		{
		// 			Name: to.Ptr("11111111-1111-1111-1111-111111111111"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/operations"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Synapse/workspaces/sqlcrudtest-4645/sqlPools/testdb/operations/11111111-1111-1111-1111-111111111111"),
		// 			Properties: &armsynapse.SQLPoolOperationProperties{
		// 				Description: to.Ptr("UpdateLogicalDatabase on 'testdb', target ServiceLevelObjective S3"),
		// 				DatabaseName: to.Ptr("testdb"),
		// 				EstimatedCompletionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T13:10:10.000Z"); return t}()),
		// 				IsCancellable: to.Ptr(false),
		// 				Operation: to.Ptr("UpdateLogicalDatabase"),
		// 				OperationFriendlyName: to.Ptr("ALTER DATABASE"),
		// 				PercentComplete: to.Ptr[int32](100),
		// 				ServerName: to.Ptr("sqlcrudtest-4645"),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T09:10:08.100Z"); return t}()),
		// 				State: to.Ptr(armsynapse.ManagementOperationStateSucceeded),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("55555555-5555-5555-5555-555555555555"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/operations"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Synapse/workspaces/sqlcrudtest-4645/sqlPools/testdb/operations/55555555-5555-5555-5555-555555555555"),
		// 			Properties: &armsynapse.SQLPoolOperationProperties{
		// 				Description: to.Ptr("UpdateLogicalDatabase on 'testdb', target ServiceLevelObjective S3"),
		// 				DatabaseName: to.Ptr("testdb"),
		// 				EstimatedCompletionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T13:10:10.000Z"); return t}()),
		// 				IsCancellable: to.Ptr(true),
		// 				Operation: to.Ptr("UpdateLogicalDatabase"),
		// 				OperationFriendlyName: to.Ptr("ALTER DATABASE"),
		// 				PercentComplete: to.Ptr[int32](19),
		// 				ServerName: to.Ptr("sqlcrudtest-4645"),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T10:10:08.100Z"); return t}()),
		// 				State: to.Ptr(armsynapse.ManagementOperationStateInProgress),
		// 			},
		// 	}},
		// }
	}
}

Output:

type SQLPoolOperationsClientListOptions added in v0.2.0 

type SQLPoolOperationsClientListOptions struct {
}

SQLPoolOperationsClientListOptions contains the optional parameters for the SQLPoolOperationsClient.NewListPager method.

type SQLPoolOperationsClientListResponse added in v0.2.0 

type SQLPoolOperationsClientListResponse struct {
	// The response to a list Sql pool operations request
	SQLPoolBlobAuditingPolicySQLPoolOperationListResult
}

SQLPoolOperationsClientListResponse contains the response from method SQLPoolOperationsClient.NewListPager.

type SQLPoolPatchInfo 

type SQLPoolPatchInfo struct {
	// The geo-location where the resource lives
	Location *string

	// SQL pool properties
	Properties *SQLPoolResourceProperties

	// SQL pool SKU
	SKU *SKU

	// Resource tags.
	Tags map[string]*string
}

SQLPoolPatchInfo - A SQL Analytics pool patch info

func (SQLPoolPatchInfo) MarshalJSON 

func (s SQLPoolPatchInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolPatchInfo.

func (*SQLPoolPatchInfo) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolPatchInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolPatchInfo.

type SQLPoolRecommendedSensitivityLabelsClient 

type SQLPoolRecommendedSensitivityLabelsClient struct {
	// contains filtered or unexported fields
}

SQLPoolRecommendedSensitivityLabelsClient contains the methods for the SQLPoolRecommendedSensitivityLabels group. Don't use this type directly, use NewSQLPoolRecommendedSensitivityLabelsClient() instead.

func NewSQLPoolRecommendedSensitivityLabelsClient 

func NewSQLPoolRecommendedSensitivityLabelsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolRecommendedSensitivityLabelsClient, error)

NewSQLPoolRecommendedSensitivityLabelsClient creates a new instance of SQLPoolRecommendedSensitivityLabelsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolRecommendedSensitivityLabelsClient) Update 

func (client *SQLPoolRecommendedSensitivityLabelsClient) Update(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, parameters RecommendedSensitivityLabelUpdateList, options *SQLPoolRecommendedSensitivityLabelsClientUpdateOptions) (SQLPoolRecommendedSensitivityLabelsClientUpdateResponse, error)

Update - Update recommended sensitivity labels states of a given SQL Pool using an operations batch. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolRecommendedSensitivityLabelsClientUpdateOptions contains the optional parameters for the SQLPoolRecommendedSensitivityLabelsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SensitivityLabelsRecommendedUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSQLPoolRecommendedSensitivityLabelsClient().Update(ctx, "myRG", "myWorkspace", "mySqlPool", armsynapse.RecommendedSensitivityLabelUpdateList{
		Operations: []*armsynapse.RecommendedSensitivityLabelUpdate{
			{
				Properties: &armsynapse.RecommendedSensitivityLabelUpdateProperties{
					Schema: to.Ptr("dbo"),
					Column: to.Ptr("column1"),
					Op:     to.Ptr(armsynapse.RecommendedSensitivityLabelUpdateKindEnable),
					Table:  to.Ptr("table1"),
				},
			},
			{
				Properties: &armsynapse.RecommendedSensitivityLabelUpdateProperties{
					Schema: to.Ptr("dbo"),
					Column: to.Ptr("column2"),
					Op:     to.Ptr(armsynapse.RecommendedSensitivityLabelUpdateKindEnable),
					Table:  to.Ptr("table2"),
				},
			},
			{
				Properties: &armsynapse.RecommendedSensitivityLabelUpdateProperties{
					Schema: to.Ptr("dbo"),
					Column: to.Ptr("column3"),
					Op:     to.Ptr(armsynapse.RecommendedSensitivityLabelUpdateKindDisable),
					Table:  to.Ptr("table1"),
				},
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type SQLPoolRecommendedSensitivityLabelsClientUpdateOptions added in v0.2.0 

type SQLPoolRecommendedSensitivityLabelsClientUpdateOptions struct {
}

SQLPoolRecommendedSensitivityLabelsClientUpdateOptions contains the optional parameters for the SQLPoolRecommendedSensitivityLabelsClient.Update method.

type SQLPoolRecommendedSensitivityLabelsClientUpdateResponse added in v0.2.0 

type SQLPoolRecommendedSensitivityLabelsClientUpdateResponse struct {
}

SQLPoolRecommendedSensitivityLabelsClientUpdateResponse contains the response from method SQLPoolRecommendedSensitivityLabelsClient.Update.

type SQLPoolReplicationLinksClient 

type SQLPoolReplicationLinksClient struct {
	// contains filtered or unexported fields
}

SQLPoolReplicationLinksClient contains the methods for the SQLPoolReplicationLinks group. Don't use this type directly, use NewSQLPoolReplicationLinksClient() instead.

func NewSQLPoolReplicationLinksClient 

func NewSQLPoolReplicationLinksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolReplicationLinksClient, error)

NewSQLPoolReplicationLinksClient creates a new instance of SQLPoolReplicationLinksClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolReplicationLinksClient) GetByName 

func (client *SQLPoolReplicationLinksClient) GetByName(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, linkID string, options *SQLPoolReplicationLinksClientGetByNameOptions) (SQLPoolReplicationLinksClientGetByNameResponse, error)

GetByName - Get SQL pool replication link by name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • linkID - The ID of the replication link.
  • options - SQLPoolReplicationLinksClientGetByNameOptions contains the optional parameters for the SQLPoolReplicationLinksClient.GetByName method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolReplicationLinks_GetByName.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolReplicationLinksClient().GetByName(ctx, "sqlcrudtest-4799", "sqlcrudtest-6440", "testdb", "5b301b68-03f6-4b26-b0f4-73ebb8634238", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ReplicationLink = armsynapse.ReplicationLink{
	// 	Name: to.Ptr("5b301b68-03f6-4b26-b0f4-73ebb8634238"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/replicationLinks"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6440/sqlPools/testdb/replicationLinks/5b301b68-03f6-4b26-b0f4-73ebb8634238"),
	// 	Location: to.Ptr("Japan East"),
	// 	Properties: &armsynapse.ReplicationLinkProperties{
	// 		IsTerminationAllowed: to.Ptr(true),
	// 		PartnerDatabase: to.Ptr("testdb"),
	// 		PartnerLocation: to.Ptr("Japan East"),
	// 		PartnerRole: to.Ptr(armsynapse.ReplicationRolePrimary),
	// 		PartnerServer: to.Ptr("sqlcrudtest-5961"),
	// 		PercentComplete: to.Ptr[int32](100),
	// 		ReplicationMode: to.Ptr("ASYNC"),
	// 		ReplicationState: to.Ptr(armsynapse.ReplicationStateCATCHUP),
	// 		Role: to.Ptr(armsynapse.ReplicationRoleSecondary),
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T01:44:27.117Z"); return t}()),
	// 	},
	// }
}

Output:

func (*SQLPoolReplicationLinksClient) NewListPager added in v0.4.0 

func (client *SQLPoolReplicationLinksClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolReplicationLinksClientListOptions) *runtime.Pager[SQLPoolReplicationLinksClientListResponse]

NewListPager - Lists a Sql pool's replication links.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolReplicationLinksClientListOptions contains the optional parameters for the SQLPoolReplicationLinksClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolReplicationLinks.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolReplicationLinksClient().NewListPager("sqlcrudtest-4799", "sqlcrudtest-6440", "testdb", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ReplicationLinkListResult = armsynapse.ReplicationLinkListResult{
		// 	Value: []*armsynapse.ReplicationLink{
		// 		{
		// 			Name: to.Ptr("5b301b68-03f6-4b26-b0f4-73ebb8634238"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/replicationLinks"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6440/sqlPools/testdb/replicationLinks/5b301b68-03f6-4b26-b0f4-73ebb8634238"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.ReplicationLinkProperties{
		// 				IsTerminationAllowed: to.Ptr(true),
		// 				PartnerDatabase: to.Ptr("testdb"),
		// 				PartnerLocation: to.Ptr("Japan East"),
		// 				PartnerRole: to.Ptr(armsynapse.ReplicationRolePrimary),
		// 				PartnerServer: to.Ptr("sqlcrudtest-5961"),
		// 				PercentComplete: to.Ptr[int32](100),
		// 				ReplicationMode: to.Ptr("ASYNC"),
		// 				ReplicationState: to.Ptr(armsynapse.ReplicationStateCATCHUP),
		// 				Role: to.Ptr(armsynapse.ReplicationRoleSecondary),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T01:44:27.117Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

Output:

type SQLPoolReplicationLinksClientGetByNameOptions added in v0.2.0 

type SQLPoolReplicationLinksClientGetByNameOptions struct {
}

SQLPoolReplicationLinksClientGetByNameOptions contains the optional parameters for the SQLPoolReplicationLinksClient.GetByName method.

type SQLPoolReplicationLinksClientGetByNameResponse added in v0.2.0 

type SQLPoolReplicationLinksClientGetByNameResponse struct {
	// Represents a Sql pool replication link.
	ReplicationLink
}

SQLPoolReplicationLinksClientGetByNameResponse contains the response from method SQLPoolReplicationLinksClient.GetByName.

type SQLPoolReplicationLinksClientListOptions added in v0.2.0 

type SQLPoolReplicationLinksClientListOptions struct {
}

SQLPoolReplicationLinksClientListOptions contains the optional parameters for the SQLPoolReplicationLinksClient.NewListPager method.

type SQLPoolReplicationLinksClientListResponse added in v0.2.0 

type SQLPoolReplicationLinksClientListResponse struct {
	// Represents the response to a List Sql pool replication link request.
	ReplicationLinkListResult
}

SQLPoolReplicationLinksClientListResponse contains the response from method SQLPoolReplicationLinksClient.NewListPager.

type SQLPoolResourceProperties 

type SQLPoolResourceProperties struct {
	// Collation mode
	Collation *string

	// Specifies the mode of sql pool creation.
	// Default: regular sql pool creation.
	// PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must
	// be specified as the resource ID of the existing sql pool, and
	// restorePointInTime must be specified.
	// Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId
	// to restore.
	// Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original
	// resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be
	// specified.
	CreateMode *CreateMode

	// Maximum size in bytes
	MaxSizeBytes *int64

	// Resource state
	ProvisioningState *string

	// Backup database to restore from
	RecoverableDatabaseID *string

	// Snapshot time to restore
	RestorePointInTime *time.Time

	// Specifies the time that the sql pool was deleted
	SourceDatabaseDeletionDate *time.Time

	// Source database to create from
	SourceDatabaseID *string

	// The storage account type used to store backups for this sql pool.
	StorageAccountType *StorageAccountType

	// READ-ONLY; Date the SQL pool was created
	CreationDate *time.Time

	// READ-ONLY; Resource status
	Status *string
}

SQLPoolResourceProperties - Properties of a SQL Analytics pool

func (SQLPoolResourceProperties) MarshalJSON 

func (s SQLPoolResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolResourceProperties.

func (*SQLPoolResourceProperties) UnmarshalJSON 

func (s *SQLPoolResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolResourceProperties.

type SQLPoolRestorePointsClient 

type SQLPoolRestorePointsClient struct {
	// contains filtered or unexported fields
}

SQLPoolRestorePointsClient contains the methods for the SQLPoolRestorePoints group. Don't use this type directly, use NewSQLPoolRestorePointsClient() instead.

func NewSQLPoolRestorePointsClient 

func NewSQLPoolRestorePointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolRestorePointsClient, error)

NewSQLPoolRestorePointsClient creates a new instance of SQLPoolRestorePointsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolRestorePointsClient) BeginCreate 

func (client *SQLPoolRestorePointsClient) BeginCreate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, parameters CreateSQLPoolRestorePointDefinition, options *SQLPoolRestorePointsClientBeginCreateOptions) (*runtime.Poller[SQLPoolRestorePointsClientCreateResponse], error)

BeginCreate - Creates a restore point for a data warehouse. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • parameters - The definition for creating the restore point of this Sql pool.
  • options - SQLPoolRestorePointsClientBeginCreateOptions contains the optional parameters for the SQLPoolRestorePointsClient.BeginCreate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateSqlPoolRestorePoints.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolRestorePointsClient().BeginCreate(ctx, "Default-SQL-SouthEastAsia", "testserver", "testDatabase", armsynapse.CreateSQLPoolRestorePointDefinition{
		RestorePointLabel: to.Ptr("mylabel"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RestorePoint = armsynapse.RestorePoint{
	// 	Name: to.Ptr("131546477590000000"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/restorePoints"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131546477590000000"),
	// 	Location: to.Ptr("japaneast"),
	// 	Properties: &armsynapse.RestorePointProperties{
	// 		RestorePointCreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-10T08:00:00.000Z"); return t}()),
	// 		RestorePointLabel: to.Ptr("mylabel"),
	// 		RestorePointType: to.Ptr(armsynapse.RestorePointTypeDISCRETE),
	// 	},
	// }
}

Output:

func (*SQLPoolRestorePointsClient) Delete 

func (client *SQLPoolRestorePointsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, restorePointName string, options *SQLPoolRestorePointsClientDeleteOptions) (SQLPoolRestorePointsClientDeleteResponse, error)

Delete - Deletes a restore point. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • restorePointName - The name of the restore point.
  • options - SQLPoolRestorePointsClientDeleteOptions contains the optional parameters for the SQLPoolRestorePointsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolRestorePointsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSQLPoolRestorePointsClient().Delete(ctx, "Default-SQL-SouthEastAsia", "testws", "testpool", "131546477590000000", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SQLPoolRestorePointsClient) Get 

func (client *SQLPoolRestorePointsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, restorePointName string, options *SQLPoolRestorePointsClientGetOptions) (SQLPoolRestorePointsClientGetResponse, error)

Get - Gets a restore point. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • restorePointName - The name of the restore point.
  • options - SQLPoolRestorePointsClientGetOptions contains the optional parameters for the SQLPoolRestorePointsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolRestorePointsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolRestorePointsClient().Get(ctx, "Default-SQL-SouthEastAsia", "testws", "testpool", "131546477590000000", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RestorePoint = armsynapse.RestorePoint{
	// 	Name: to.Ptr("131546477590000000"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/restorePoints"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testws/sqlPools/testpool/restorePoints/131546477590000000"),
	// 	Location: to.Ptr("japaneast"),
	// 	Properties: &armsynapse.RestorePointProperties{
	// 		RestorePointCreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-10T08:00:00.000Z"); return t}()),
	// 		RestorePointLabel: to.Ptr("mylabel"),
	// 		RestorePointType: to.Ptr(armsynapse.RestorePointTypeDISCRETE),
	// 	},
	// }
}

Output:

func (*SQLPoolRestorePointsClient) NewListPager added in v0.4.0 

func (client *SQLPoolRestorePointsClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolRestorePointsClientListOptions) *runtime.Pager[SQLPoolRestorePointsClientListResponse]

NewListPager - Get SQL pool backup information

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolRestorePointsClientListOptions contains the optional parameters for the SQLPoolRestorePointsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolRestorePoints.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolRestorePointsClient().NewListPager("Default-SQL-SouthEastAsia", "testserver", "testDatabase", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RestorePointListResult = armsynapse.RestorePointListResult{
		// 	Value: []*armsynapse.RestorePoint{
		// 		{
		// 			Name: to.Ptr("131546477590000000"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/restorePoints"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131546477590000000"),
		// 			Location: to.Ptr("japaneast"),
		// 			Properties: &armsynapse.RestorePointProperties{
		// 				RestorePointCreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-10T08:00:00.000Z"); return t}()),
		// 				RestorePointLabel: to.Ptr("mylabel1"),
		// 				RestorePointType: to.Ptr(armsynapse.RestorePointTypeDISCRETE),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("131553636140000000"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/restorePoints"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131553636140000000"),
		// 			Location: to.Ptr("japaneast"),
		// 			Properties: &armsynapse.RestorePointProperties{
		// 				RestorePointCreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-17T03:40:14.000Z"); return t}()),
		// 				RestorePointLabel: to.Ptr("mylabel2"),
		// 				RestorePointType: to.Ptr(armsynapse.RestorePointTypeDISCRETE),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("131553619750000000"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/restorePoints"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131553619750000000"),
		// 			Location: to.Ptr("japaneast"),
		// 			Properties: &armsynapse.RestorePointProperties{
		// 				RestorePointCreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-17T03:12:55.000Z"); return t}()),
		// 				RestorePointType: to.Ptr(armsynapse.RestorePointTypeDISCRETE),
		// 			},
		// 	}},
		// }
	}
}

Output:

type SQLPoolRestorePointsClientBeginCreateOptions added in v0.2.0 

type SQLPoolRestorePointsClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolRestorePointsClientBeginCreateOptions contains the optional parameters for the SQLPoolRestorePointsClient.BeginCreate method.

type SQLPoolRestorePointsClientCreateResponse added in v0.2.0 

type SQLPoolRestorePointsClientCreateResponse struct {
	// Database restore points.
	RestorePoint
}

SQLPoolRestorePointsClientCreateResponse contains the response from method SQLPoolRestorePointsClient.BeginCreate.

type SQLPoolRestorePointsClientDeleteOptions added in v0.2.0 

type SQLPoolRestorePointsClientDeleteOptions struct {
}

SQLPoolRestorePointsClientDeleteOptions contains the optional parameters for the SQLPoolRestorePointsClient.Delete method.

type SQLPoolRestorePointsClientDeleteResponse added in v0.2.0 

type SQLPoolRestorePointsClientDeleteResponse struct {
}

SQLPoolRestorePointsClientDeleteResponse contains the response from method SQLPoolRestorePointsClient.Delete.

type SQLPoolRestorePointsClientGetOptions added in v0.2.0 

type SQLPoolRestorePointsClientGetOptions struct {
}

SQLPoolRestorePointsClientGetOptions contains the optional parameters for the SQLPoolRestorePointsClient.Get method.

type SQLPoolRestorePointsClientGetResponse added in v0.2.0 

type SQLPoolRestorePointsClientGetResponse struct {
	// Database restore points.
	RestorePoint
}

SQLPoolRestorePointsClientGetResponse contains the response from method SQLPoolRestorePointsClient.Get.

type SQLPoolRestorePointsClientListOptions added in v0.2.0 

type SQLPoolRestorePointsClientListOptions struct {
}

SQLPoolRestorePointsClientListOptions contains the optional parameters for the SQLPoolRestorePointsClient.NewListPager method.

type SQLPoolRestorePointsClientListResponse added in v0.2.0 

type SQLPoolRestorePointsClientListResponse struct {
	// A list of long term retention backups.
	RestorePointListResult
}

SQLPoolRestorePointsClientListResponse contains the response from method SQLPoolRestorePointsClient.NewListPager.

type SQLPoolSchema 

type SQLPoolSchema struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLPoolSchema - A Sql pool schema resource.

func (SQLPoolSchema) MarshalJSON added in v0.6.0 

func (s SQLPoolSchema) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolSchema.

func (*SQLPoolSchema) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolSchema) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolSchema.

type SQLPoolSchemaListResult 

type SQLPoolSchemaListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*SQLPoolSchema
}

SQLPoolSchemaListResult - A list of Sql pool schemas.

func (SQLPoolSchemaListResult) MarshalJSON 

func (s SQLPoolSchemaListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolSchemaListResult.

func (*SQLPoolSchemaListResult) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolSchemaListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolSchemaListResult.

type SQLPoolSchemasClient 

type SQLPoolSchemasClient struct {
	// contains filtered or unexported fields
}

SQLPoolSchemasClient contains the methods for the SQLPoolSchemas group. Don't use this type directly, use NewSQLPoolSchemasClient() instead.

func NewSQLPoolSchemasClient 

func NewSQLPoolSchemasClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolSchemasClient, error)

NewSQLPoolSchemasClient creates a new instance of SQLPoolSchemasClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolSchemasClient) Get 

func (client *SQLPoolSchemasClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, schemaName string, options *SQLPoolSchemasClientGetOptions) (SQLPoolSchemasClientGetResponse, error)

Get - Get Sql Pool schema If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • schemaName - The name of the schema.
  • options - SQLPoolSchemasClientGetOptions contains the optional parameters for the SQLPoolSchemasClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolSchemaGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolSchemasClient().Get(ctx, "myRG", "serverName", "myDatabase", "dbo", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolSchema = armsynapse.SQLPoolSchema{
	// 	Name: to.Ptr("dbo"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo"),
	// }
}

Output:

func (*SQLPoolSchemasClient) NewListPager added in v0.4.0 

func (client *SQLPoolSchemasClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolSchemasClientListOptions) *runtime.Pager[SQLPoolSchemasClientListResponse]

NewListPager - Gets schemas of a given SQL pool.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolSchemasClientListOptions contains the optional parameters for the SQLPoolSchemasClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolSchema.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolSchemasClient().NewListPager("myRG", "serverName", "myDatabase", &armsynapse.SQLPoolSchemasClientListOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLPoolSchemaListResult = armsynapse.SQLPoolSchemaListResult{
		// 	Value: []*armsynapse.SQLPoolSchema{
		// 		{
		// 			Name: to.Ptr("dbo"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo"),
		// 		},
		// 		{
		// 			Name: to.Ptr("schema2"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/schema2"),
		// 	}},
		// }
	}
}

Output:

type SQLPoolSchemasClientGetOptions added in v0.2.0 

type SQLPoolSchemasClientGetOptions struct {
}

SQLPoolSchemasClientGetOptions contains the optional parameters for the SQLPoolSchemasClient.Get method.

type SQLPoolSchemasClientGetResponse added in v0.2.0 

type SQLPoolSchemasClientGetResponse struct {
	// A Sql pool schema resource.
	SQLPoolSchema
}

SQLPoolSchemasClientGetResponse contains the response from method SQLPoolSchemasClient.Get.

type SQLPoolSchemasClientListOptions added in v0.2.0 

type SQLPoolSchemasClientListOptions struct {
	// An OData filter expression that filters elements in the collection.
	Filter *string
}

SQLPoolSchemasClientListOptions contains the optional parameters for the SQLPoolSchemasClient.NewListPager method.

type SQLPoolSchemasClientListResponse added in v0.2.0 

type SQLPoolSchemasClientListResponse struct {
	// A list of Sql pool schemas.
	SQLPoolSchemaListResult
}

SQLPoolSchemasClientListResponse contains the response from method SQLPoolSchemasClient.NewListPager.

type SQLPoolSecurityAlertPoliciesClient 

type SQLPoolSecurityAlertPoliciesClient struct {
	// contains filtered or unexported fields
}

SQLPoolSecurityAlertPoliciesClient contains the methods for the SQLPoolSecurityAlertPolicies group. Don't use this type directly, use NewSQLPoolSecurityAlertPoliciesClient() instead.

func NewSQLPoolSecurityAlertPoliciesClient 

func NewSQLPoolSecurityAlertPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolSecurityAlertPoliciesClient, error)

NewSQLPoolSecurityAlertPoliciesClient creates a new instance of SQLPoolSecurityAlertPoliciesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolSecurityAlertPoliciesClient) CreateOrUpdate 

func (client *SQLPoolSecurityAlertPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, securityAlertPolicyName SecurityAlertPolicyName, parameters SQLPoolSecurityAlertPolicy, options *SQLPoolSecurityAlertPoliciesClientCreateOrUpdateOptions) (SQLPoolSecurityAlertPoliciesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update a Sql pool's security alert policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • securityAlertPolicyName - The name of the security alert policy.
  • parameters - The Sql pool security alert policy.
  • options - SQLPoolSecurityAlertPoliciesClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolSecurityAlertPoliciesClient.CreateOrUpdate method.
Example (UpdateASqlPoolsThreatDetectionPolicyWithAllParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolSecurityAlertWithAllParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolSecurityAlertPoliciesClient().CreateOrUpdate(ctx, "securityalert-4799", "securityalert-6440", "testdb", armsynapse.SecurityAlertPolicyNameDefault, armsynapse.SQLPoolSecurityAlertPolicy{
		Properties: &armsynapse.SecurityAlertPolicyProperties{
			DisabledAlerts: []*string{
				to.Ptr("Sql_Injection"),
				to.Ptr("Usage_Anomaly")},
			EmailAccountAdmins: to.Ptr(true),
			EmailAddresses: []*string{
				to.Ptr("test@microsoft.com"),
				to.Ptr("user@microsoft.com")},
			RetentionDays:           to.Ptr[int32](6),
			State:                   to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
			StorageAccountAccessKey: to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageEndpoint:         to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolSecurityAlertPolicy = armsynapse.SQLPoolSecurityAlertPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Synapse/workspaces/securityalert-6440/sqlPools/testdb"),
	// 	Properties: &armsynapse.SecurityAlertPolicyProperties{
	// 		DisabledAlerts: []*string{
	// 			to.Ptr("Sql_Injection"),
	// 			to.Ptr("Usage_Anomaly")},
	// 			EmailAccountAdmins: to.Ptr(true),
	// 			EmailAddresses: []*string{
	// 				to.Ptr("test@microsoft.com"),
	// 				to.Ptr("user@microsoft.com")},
	// 				RetentionDays: to.Ptr[int32](6),
	// 				State: to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
	// 				StorageAccountAccessKey: to.Ptr(""),
	// 				StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 			},
	// 		}
}

Output:
Example (UpdateASqlPoolsThreatDetectionPolicyWithMinimalParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolSecurityAlertWithMinParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolSecurityAlertPoliciesClient().CreateOrUpdate(ctx, "securityalert-4799", "securityalert-6440", "testdb", armsynapse.SecurityAlertPolicyNameDefault, armsynapse.SQLPoolSecurityAlertPolicy{
		Properties: &armsynapse.SecurityAlertPolicyProperties{
			State: to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolSecurityAlertPolicy = armsynapse.SQLPoolSecurityAlertPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Synapse/workspaces/securityalert-6440/sqlPools/testdb"),
	// 	Properties: &armsynapse.SecurityAlertPolicyProperties{
	// 		DisabledAlerts: []*string{
	// 		},
	// 		EmailAccountAdmins: to.Ptr(true),
	// 		EmailAddresses: []*string{
	// 		},
	// 		RetentionDays: to.Ptr[int32](0),
	// 		State: to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
	// 		StorageAccountAccessKey: to.Ptr(""),
	// 		StorageEndpoint: to.Ptr(""),
	// 	},
	// }
}

Output:

func (*SQLPoolSecurityAlertPoliciesClient) Get 

func (client *SQLPoolSecurityAlertPoliciesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, securityAlertPolicyName SecurityAlertPolicyName, options *SQLPoolSecurityAlertPoliciesClientGetOptions) (SQLPoolSecurityAlertPoliciesClientGetResponse, error)

Get - Get a Sql pool's security alert policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • securityAlertPolicyName - The name of the security alert policy.
  • options - SQLPoolSecurityAlertPoliciesClientGetOptions contains the optional parameters for the SQLPoolSecurityAlertPoliciesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolSecurityAlert.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolSecurityAlertPoliciesClient().Get(ctx, "securityalert-6852", "securityalert-2080", "testdb", armsynapse.SecurityAlertPolicyNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolSecurityAlertPolicy = armsynapse.SQLPoolSecurityAlertPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Synapse/workspaces/securityalert-2080/sqlPools/testdb"),
	// 	Properties: &armsynapse.SecurityAlertPolicyProperties{
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-08T00:00:00.000Z"); return t}()),
	// 		DisabledAlerts: []*string{
	// 			to.Ptr("Usage_Anomaly")},
	// 			EmailAccountAdmins: to.Ptr(true),
	// 			EmailAddresses: []*string{
	// 				to.Ptr("test@microsoft.com"),
	// 				to.Ptr("user@microsoft.com")},
	// 				RetentionDays: to.Ptr[int32](0),
	// 				State: to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
	// 				StorageAccountAccessKey: to.Ptr(""),
	// 			},
	// 		}
}

Output:

func (*SQLPoolSecurityAlertPoliciesClient) NewListPager added in v0.4.0 

func (client *SQLPoolSecurityAlertPoliciesClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolSecurityAlertPoliciesClientListOptions) *runtime.Pager[SQLPoolSecurityAlertPoliciesClientListResponse]

NewListPager - Get a list of Sql pool's security alert policies.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolSecurityAlertPoliciesClientListOptions contains the optional parameters for the SQLPoolSecurityAlertPoliciesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolSecurityAlertPolicies_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolSecurityAlertPoliciesClient().NewListPager("securityalert-6852", "securityalert-2080", "testdb", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListSQLPoolSecurityAlertPolicies = armsynapse.ListSQLPoolSecurityAlertPolicies{
		// 	Value: []*armsynapse.SQLPoolSecurityAlertPolicy{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Synapse/workspaces/securityalert-2080/sqlPools/testdb"),
		// 			Properties: &armsynapse.SecurityAlertPolicyProperties{
		// 				CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-08T00:00:00.000Z"); return t}()),
		// 				DisabledAlerts: []*string{
		// 					to.Ptr("Usage_Anomaly")},
		// 					EmailAccountAdmins: to.Ptr(true),
		// 					EmailAddresses: []*string{
		// 						to.Ptr("test@microsoft.com"),
		// 						to.Ptr("user@microsoft.com")},
		// 						RetentionDays: to.Ptr[int32](0),
		// 						State: to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
		// 						StorageAccountAccessKey: to.Ptr(""),
		// 					},
		// 			}},
		// 		}
	}
}

Output:

type SQLPoolSecurityAlertPoliciesClientCreateOrUpdateOptions added in v0.2.0 

type SQLPoolSecurityAlertPoliciesClientCreateOrUpdateOptions struct {
}

SQLPoolSecurityAlertPoliciesClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolSecurityAlertPoliciesClient.CreateOrUpdate method.

type SQLPoolSecurityAlertPoliciesClientCreateOrUpdateResponse added in v0.2.0 

type SQLPoolSecurityAlertPoliciesClientCreateOrUpdateResponse struct {
	// A Sql pool security alert policy.
	SQLPoolSecurityAlertPolicy
}

SQLPoolSecurityAlertPoliciesClientCreateOrUpdateResponse contains the response from method SQLPoolSecurityAlertPoliciesClient.CreateOrUpdate.

type SQLPoolSecurityAlertPoliciesClientGetOptions added in v0.2.0 

type SQLPoolSecurityAlertPoliciesClientGetOptions struct {
}

SQLPoolSecurityAlertPoliciesClientGetOptions contains the optional parameters for the SQLPoolSecurityAlertPoliciesClient.Get method.

type SQLPoolSecurityAlertPoliciesClientGetResponse added in v0.2.0 

type SQLPoolSecurityAlertPoliciesClientGetResponse struct {
	// A Sql pool security alert policy.
	SQLPoolSecurityAlertPolicy
}

SQLPoolSecurityAlertPoliciesClientGetResponse contains the response from method SQLPoolSecurityAlertPoliciesClient.Get.

type SQLPoolSecurityAlertPoliciesClientListOptions added in v0.2.0 

type SQLPoolSecurityAlertPoliciesClientListOptions struct {
}

SQLPoolSecurityAlertPoliciesClientListOptions contains the optional parameters for the SQLPoolSecurityAlertPoliciesClient.NewListPager method.

type SQLPoolSecurityAlertPoliciesClientListResponse added in v0.2.0 

type SQLPoolSecurityAlertPoliciesClientListResponse struct {
	// A list of SQL pool security alert policies.
	ListSQLPoolSecurityAlertPolicies
}

SQLPoolSecurityAlertPoliciesClientListResponse contains the response from method SQLPoolSecurityAlertPoliciesClient.NewListPager.

type SQLPoolSecurityAlertPolicy 

type SQLPoolSecurityAlertPolicy struct {
	// Resource properties.
	Properties *SecurityAlertPolicyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLPoolSecurityAlertPolicy - A Sql pool security alert policy.

func (SQLPoolSecurityAlertPolicy) MarshalJSON 

func (s SQLPoolSecurityAlertPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolSecurityAlertPolicy.

func (*SQLPoolSecurityAlertPolicy) UnmarshalJSON 

func (s *SQLPoolSecurityAlertPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolSecurityAlertPolicy.

type SQLPoolSensitivityLabelsClient 

type SQLPoolSensitivityLabelsClient struct {
	// contains filtered or unexported fields
}

SQLPoolSensitivityLabelsClient contains the methods for the SQLPoolSensitivityLabels group. Don't use this type directly, use NewSQLPoolSensitivityLabelsClient() instead.

func NewSQLPoolSensitivityLabelsClient 

func NewSQLPoolSensitivityLabelsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolSensitivityLabelsClient, error)

NewSQLPoolSensitivityLabelsClient creates a new instance of SQLPoolSensitivityLabelsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolSensitivityLabelsClient) CreateOrUpdate 

func (client *SQLPoolSensitivityLabelsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, schemaName string, tableName string, columnName string, parameters SensitivityLabel, options *SQLPoolSensitivityLabelsClientCreateOrUpdateOptions) (SQLPoolSensitivityLabelsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates the sensitivity label of a given column in a Sql pool If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • schemaName - The name of the schema.
  • tableName - The name of the table.
  • columnName - The name of the column.
  • parameters - The column sensitivity label resource.
  • options - SQLPoolSensitivityLabelsClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolColumnSensitivityLabelWithAllParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolSensitivityLabelsClient().CreateOrUpdate(ctx, "myRG", "myServer", "myDatabase", "dbo", "myTable", "myColumn", armsynapse.SensitivityLabel{
		Properties: &armsynapse.SensitivityLabelProperties{
			InformationType:   to.Ptr("PhoneNumber"),
			InformationTypeID: to.Ptr("d22fa6e9-5ee4-3bde-4c2b-a409604c4646"),
			LabelID:           to.Ptr("bf91e08c-f4f0-478a-b016-25164b2a65ff"),
			LabelName:         to.Ptr("PII"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SensitivityLabel = armsynapse.SensitivityLabel{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current"),
	// 	Properties: &armsynapse.SensitivityLabelProperties{
	// 		InformationType: to.Ptr("PhoneNumber"),
	// 		InformationTypeID: to.Ptr("d22fa6e9-5ee4-3bde-4c2b-a409604c4646"),
	// 		LabelID: to.Ptr("bf91e08c-f4f0-478a-b016-25164b2a65ff"),
	// 		LabelName: to.Ptr("PII"),
	// 	},
	// }
}

Output:

func (*SQLPoolSensitivityLabelsClient) Delete 

func (client *SQLPoolSensitivityLabelsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, schemaName string, tableName string, columnName string, options *SQLPoolSensitivityLabelsClientDeleteOptions) (SQLPoolSensitivityLabelsClientDeleteResponse, error)

Delete - Deletes the sensitivity label of a given column in a Sql pool If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • schemaName - The name of the schema.
  • tableName - The name of the table.
  • columnName - The name of the column.
  • options - SQLPoolSensitivityLabelsClientDeleteOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteSqlPoolColumnSensitivityLabel.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSQLPoolSensitivityLabelsClient().Delete(ctx, "myRG", "myServer", "myDatabase", "dbo", "myTable", "myColumn", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SQLPoolSensitivityLabelsClient) DisableRecommendation 

func (client *SQLPoolSensitivityLabelsClient) DisableRecommendation(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, schemaName string, tableName string, columnName string, options *SQLPoolSensitivityLabelsClientDisableRecommendationOptions) (SQLPoolSensitivityLabelsClientDisableRecommendationResponse, error)

DisableRecommendation - Disables sensitivity recommendations on a given column If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • schemaName - The name of the schema.
  • tableName - The name of the table.
  • columnName - The name of the column.
  • options - SQLPoolSensitivityLabelsClientDisableRecommendationOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.DisableRecommendation method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/RecommendedColumnSensitivityLabelDisable.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSQLPoolSensitivityLabelsClient().DisableRecommendation(ctx, "myRG", "myServer", "myDatabase", "dbo", "myTable", "myColumn", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SQLPoolSensitivityLabelsClient) EnableRecommendation 

func (client *SQLPoolSensitivityLabelsClient) EnableRecommendation(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, schemaName string, tableName string, columnName string, options *SQLPoolSensitivityLabelsClientEnableRecommendationOptions) (SQLPoolSensitivityLabelsClientEnableRecommendationResponse, error)

EnableRecommendation - Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns) If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • schemaName - The name of the schema.
  • tableName - The name of the table.
  • columnName - The name of the column.
  • options - SQLPoolSensitivityLabelsClientEnableRecommendationOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.EnableRecommendation method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/RecommendedColumnSensitivityLabelEnable.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSQLPoolSensitivityLabelsClient().EnableRecommendation(ctx, "myRG", "myServer", "myDatabase", "dbo", "myTable", "myColumn", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SQLPoolSensitivityLabelsClient) Get 

func (client *SQLPoolSensitivityLabelsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, schemaName string, tableName string, columnName string, sensitivityLabelSource SensitivityLabelSource, options *SQLPoolSensitivityLabelsClientGetOptions) (SQLPoolSensitivityLabelsClientGetResponse, error)

Get - Gets the sensitivity label of a given column If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • schemaName - The name of the schema.
  • tableName - The name of the table.
  • columnName - The name of the column.
  • sensitivityLabelSource - The source of the sensitivity label.
  • options - SQLPoolSensitivityLabelsClientGetOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolColumnSensitivityLabelGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolSensitivityLabelsClient().Get(ctx, "myRG", "myServer", "myDatabase", "dbo", "myTable", "myColumn", armsynapse.SensitivityLabelSourceCurrent, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SensitivityLabel = armsynapse.SensitivityLabel{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current"),
	// 	Properties: &armsynapse.SensitivityLabelProperties{
	// 		InformationType: to.Ptr("PhoneNumber"),
	// 		InformationTypeID: to.Ptr("d22fa6e9-5ee4-3bde-4c2b-a409604c4646"),
	// 		LabelID: to.Ptr("bf91e08c-f4f0-478a-b016-25164b2a65ff"),
	// 		LabelName: to.Ptr("PII"),
	// 	},
	// }
}

Output:

func (*SQLPoolSensitivityLabelsClient) NewListCurrentPager added in v0.4.0 

func (client *SQLPoolSensitivityLabelsClient) NewListCurrentPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolSensitivityLabelsClientListCurrentOptions) *runtime.Pager[SQLPoolSensitivityLabelsClientListCurrentResponse]

NewListCurrentPager - Gets SQL pool sensitivity labels.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolSensitivityLabelsClientListCurrentOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.NewListCurrentPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolsSensitivityLabelsWithSourceCurrent.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolSensitivityLabelsClient().NewListCurrentPager("myRG", "myServer", "myDatabase", &armsynapse.SQLPoolSensitivityLabelsClientListCurrentOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SensitivityLabelListResult = armsynapse.SensitivityLabelListResult{
		// 	Value: []*armsynapse.SensitivityLabel{
		// 		{
		// 			Name: to.Ptr("current"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn3/sensitivityLabels/current"),
		// 			Properties: &armsynapse.SensitivityLabelProperties{
		// 				InformationType: to.Ptr("Financial"),
		// 				InformationTypeID: to.Ptr("d22fa6e9-5ee4-3bde-4c2b-a409604c4646"),
		// 				LabelID: to.Ptr("05e6eaa1-075a-4fb4-a732-a92215a2444a"),
		// 				LabelName: to.Ptr("Sensitive"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("current"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn4/sensitivityLabels/current"),
		// 			Properties: &armsynapse.SensitivityLabelProperties{
		// 				InformationType: to.Ptr("Email"),
		// 				InformationTypeID: to.Ptr("d22fa6e9-5ee4-3bde-4c2b-a409604c4646"),
		// 				LabelID: to.Ptr("bf91e08c-f4f0-478a-b016-25164b2a65ff"),
		// 				LabelName: to.Ptr("PII"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*SQLPoolSensitivityLabelsClient) NewListRecommendedPager added in v0.4.0 

func (client *SQLPoolSensitivityLabelsClient) NewListRecommendedPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolSensitivityLabelsClientListRecommendedOptions) *runtime.Pager[SQLPoolSensitivityLabelsClientListRecommendedResponse]

NewListRecommendedPager - Gets sensitivity labels of a given SQL pool.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolSensitivityLabelsClientListRecommendedOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.NewListRecommendedPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolSensitivityLabelsWithSourceRecommended.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolSensitivityLabelsClient().NewListRecommendedPager("myRG", "myServer", "myDatabase", &armsynapse.SQLPoolSensitivityLabelsClientListRecommendedOptions{IncludeDisabledRecommendations: nil,
		SkipToken: nil,
		Filter:    nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SensitivityLabelListResult = armsynapse.SensitivityLabelListResult{
		// 	Value: []*armsynapse.SensitivityLabel{
		// 		{
		// 			Name: to.Ptr("recommended"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/recommended"),
		// 			Properties: &armsynapse.SensitivityLabelProperties{
		// 				InformationType: to.Ptr("Financial"),
		// 				InformationTypeID: to.Ptr("d22fa6e9-5ee4-3bde-4c2b-a409604c4646"),
		// 				LabelID: to.Ptr("05e6eaa1-075a-4fb4-a732-a92215a2444a"),
		// 				LabelName: to.Ptr("Sensitive"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("recommended"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn2/sensitivityLabels/recommended"),
		// 			Properties: &armsynapse.SensitivityLabelProperties{
		// 				InformationType: to.Ptr("Email"),
		// 				InformationTypeID: to.Ptr("d22fa6e9-5ee4-3bde-4c2b-a409604c4646"),
		// 				LabelID: to.Ptr("bf91e08c-f4f0-478a-b016-25164b2a65ff"),
		// 				LabelName: to.Ptr("PII"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*SQLPoolSensitivityLabelsClient) Update 

func (client *SQLPoolSensitivityLabelsClient) Update(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, parameters SensitivityLabelUpdateList, options *SQLPoolSensitivityLabelsClientUpdateOptions) (SQLPoolSensitivityLabelsClientUpdateResponse, error)

Update - Update sensitivity labels of a given SQL Pool using an operations batch. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolSensitivityLabelsClientUpdateOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SensitivityLabelsCurrentUpdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSQLPoolSensitivityLabelsClient().Update(ctx, "myRG", "myWorkspace", "mySqlPool", armsynapse.SensitivityLabelUpdateList{
		Operations: []*armsynapse.SensitivityLabelUpdate{
			{
				Properties: &armsynapse.SensitivityLabelUpdateProperties{
					Schema: to.Ptr("dbo"),
					Column: to.Ptr("column1"),
					Op:     to.Ptr(armsynapse.SensitivityLabelUpdateKindSet),
					SensitivityLabel: &armsynapse.SensitivityLabel{
						Properties: &armsynapse.SensitivityLabelProperties{
							InformationType:   to.Ptr("Financial"),
							InformationTypeID: to.Ptr("1D3652D6-422C-4115-82F1-65DAEBC665C8"),
							LabelID:           to.Ptr("3A477B16-9423-432B-AA97-6069B481CEC3"),
							LabelName:         to.Ptr("Highly Confidential"),
							Rank:              to.Ptr(armsynapse.SensitivityLabelRankLow),
						},
					},
					Table: to.Ptr("table1"),
				},
			},
			{
				Properties: &armsynapse.SensitivityLabelUpdateProperties{
					Schema: to.Ptr("dbo"),
					Column: to.Ptr("column2"),
					Op:     to.Ptr(armsynapse.SensitivityLabelUpdateKindSet),
					SensitivityLabel: &armsynapse.SensitivityLabel{
						Properties: &armsynapse.SensitivityLabelProperties{
							InformationType:   to.Ptr("PhoneNumber"),
							InformationTypeID: to.Ptr("d22fa6e9-5ee4-3bde-4c2b-a409604c4646"),
							LabelID:           to.Ptr("bf91e08c-f4f0-478a-b016-25164b2a65ff"),
							LabelName:         to.Ptr("PII"),
							Rank:              to.Ptr(armsynapse.SensitivityLabelRankCritical),
						},
					},
					Table: to.Ptr("table2"),
				},
			},
			{
				Properties: &armsynapse.SensitivityLabelUpdateProperties{
					Schema: to.Ptr("dbo"),
					Column: to.Ptr("Column3"),
					Op:     to.Ptr(armsynapse.SensitivityLabelUpdateKindRemove),
					Table:  to.Ptr("Table1"),
				},
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type SQLPoolSensitivityLabelsClientCreateOrUpdateOptions added in v0.2.0 

type SQLPoolSensitivityLabelsClientCreateOrUpdateOptions struct {
}

SQLPoolSensitivityLabelsClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.CreateOrUpdate method.

type SQLPoolSensitivityLabelsClientCreateOrUpdateResponse added in v0.2.0 

type SQLPoolSensitivityLabelsClientCreateOrUpdateResponse struct {
	// A sensitivity label.
	SensitivityLabel
}

SQLPoolSensitivityLabelsClientCreateOrUpdateResponse contains the response from method SQLPoolSensitivityLabelsClient.CreateOrUpdate.

type SQLPoolSensitivityLabelsClientDeleteOptions added in v0.2.0 

type SQLPoolSensitivityLabelsClientDeleteOptions struct {
}

SQLPoolSensitivityLabelsClientDeleteOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.Delete method.

type SQLPoolSensitivityLabelsClientDeleteResponse added in v0.2.0 

type SQLPoolSensitivityLabelsClientDeleteResponse struct {
}

SQLPoolSensitivityLabelsClientDeleteResponse contains the response from method SQLPoolSensitivityLabelsClient.Delete.

type SQLPoolSensitivityLabelsClientDisableRecommendationOptions added in v0.2.0 

type SQLPoolSensitivityLabelsClientDisableRecommendationOptions struct {
}

SQLPoolSensitivityLabelsClientDisableRecommendationOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.DisableRecommendation method.

type SQLPoolSensitivityLabelsClientDisableRecommendationResponse added in v0.2.0 

type SQLPoolSensitivityLabelsClientDisableRecommendationResponse struct {
}

SQLPoolSensitivityLabelsClientDisableRecommendationResponse contains the response from method SQLPoolSensitivityLabelsClient.DisableRecommendation.

type SQLPoolSensitivityLabelsClientEnableRecommendationOptions added in v0.2.0 

type SQLPoolSensitivityLabelsClientEnableRecommendationOptions struct {
}

SQLPoolSensitivityLabelsClientEnableRecommendationOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.EnableRecommendation method.

type SQLPoolSensitivityLabelsClientEnableRecommendationResponse added in v0.2.0 

type SQLPoolSensitivityLabelsClientEnableRecommendationResponse struct {
}

SQLPoolSensitivityLabelsClientEnableRecommendationResponse contains the response from method SQLPoolSensitivityLabelsClient.EnableRecommendation.

type SQLPoolSensitivityLabelsClientGetOptions added in v0.2.0 

type SQLPoolSensitivityLabelsClientGetOptions struct {
}

SQLPoolSensitivityLabelsClientGetOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.Get method.

type SQLPoolSensitivityLabelsClientGetResponse added in v0.2.0 

type SQLPoolSensitivityLabelsClientGetResponse struct {
	// A sensitivity label.
	SensitivityLabel
}

SQLPoolSensitivityLabelsClientGetResponse contains the response from method SQLPoolSensitivityLabelsClient.Get.

type SQLPoolSensitivityLabelsClientListCurrentOptions added in v0.2.0 

type SQLPoolSensitivityLabelsClientListCurrentOptions struct {
	// An OData filter expression that filters elements in the collection.
	Filter *string
}

SQLPoolSensitivityLabelsClientListCurrentOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.NewListCurrentPager method.

type SQLPoolSensitivityLabelsClientListCurrentResponse added in v0.2.0 

type SQLPoolSensitivityLabelsClientListCurrentResponse struct {
	// A list of sensitivity labels.
	SensitivityLabelListResult
}

SQLPoolSensitivityLabelsClientListCurrentResponse contains the response from method SQLPoolSensitivityLabelsClient.NewListCurrentPager.

type SQLPoolSensitivityLabelsClientListRecommendedOptions added in v0.2.0 

type SQLPoolSensitivityLabelsClientListRecommendedOptions struct {
	// An OData filter expression that filters elements in the collection.
	Filter *string

	// Specifies whether to include disabled recommendations or not.
	IncludeDisabledRecommendations *bool

	// An OData query option to indicate how many elements to skip in the collection.
	SkipToken *string
}

SQLPoolSensitivityLabelsClientListRecommendedOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.NewListRecommendedPager method.

type SQLPoolSensitivityLabelsClientListRecommendedResponse added in v0.2.0 

type SQLPoolSensitivityLabelsClientListRecommendedResponse struct {
	// A list of sensitivity labels.
	SensitivityLabelListResult
}

SQLPoolSensitivityLabelsClientListRecommendedResponse contains the response from method SQLPoolSensitivityLabelsClient.NewListRecommendedPager.

type SQLPoolSensitivityLabelsClientUpdateOptions added in v0.2.0 

type SQLPoolSensitivityLabelsClientUpdateOptions struct {
}

SQLPoolSensitivityLabelsClientUpdateOptions contains the optional parameters for the SQLPoolSensitivityLabelsClient.Update method.

type SQLPoolSensitivityLabelsClientUpdateResponse added in v0.2.0 

type SQLPoolSensitivityLabelsClientUpdateResponse struct {
}

SQLPoolSensitivityLabelsClientUpdateResponse contains the response from method SQLPoolSensitivityLabelsClient.Update.

type SQLPoolTable 

type SQLPoolTable struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLPoolTable - A Sql pool table resource.

func (SQLPoolTable) MarshalJSON added in v0.6.0 

func (s SQLPoolTable) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolTable.

func (*SQLPoolTable) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolTable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolTable.

type SQLPoolTableColumnsClient 

type SQLPoolTableColumnsClient struct {
	// contains filtered or unexported fields
}

SQLPoolTableColumnsClient contains the methods for the SQLPoolTableColumns group. Don't use this type directly, use NewSQLPoolTableColumnsClient() instead.

func NewSQLPoolTableColumnsClient 

func NewSQLPoolTableColumnsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolTableColumnsClient, error)

NewSQLPoolTableColumnsClient creates a new instance of SQLPoolTableColumnsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolTableColumnsClient) NewListByTableNamePager added in v0.4.0 

func (client *SQLPoolTableColumnsClient) NewListByTableNamePager(resourceGroupName string, workspaceName string, sqlPoolName string, schemaName string, tableName string, options *SQLPoolTableColumnsClientListByTableNameOptions) *runtime.Pager[SQLPoolTableColumnsClientListByTableNameResponse]

NewListByTableNamePager - Gets columns in a given table in a SQL pool.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • schemaName - The name of the schema.
  • tableName - The name of the table.
  • options - SQLPoolTableColumnsClientListByTableNameOptions contains the optional parameters for the SQLPoolTableColumnsClient.NewListByTableNamePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolColumns.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolTableColumnsClient().NewListByTableNamePager("myRG", "serverName", "myDatabase", "dbo", "table1", &armsynapse.SQLPoolTableColumnsClientListByTableNameOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLPoolColumnListResult = armsynapse.SQLPoolColumnListResult{
		// 	Value: []*armsynapse.SQLPoolColumn{
		// 		{
		// 			Name: to.Ptr("col1"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table1/columns/col1"),
		// 			Properties: &armsynapse.SQLPoolColumnProperties{
		// 				ColumnType: to.Ptr(armsynapse.ColumnDataTypeNvarchar),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("col2"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table1/columns/col2"),
		// 			Properties: &armsynapse.SQLPoolColumnProperties{
		// 				ColumnType: to.Ptr(armsynapse.ColumnDataTypeBit),
		// 			},
		// 	}},
		// }
	}
}

Output:

type SQLPoolTableColumnsClientListByTableNameOptions added in v0.2.0 

type SQLPoolTableColumnsClientListByTableNameOptions struct {
	// An OData filter expression that filters elements in the collection.
	Filter *string
}

SQLPoolTableColumnsClientListByTableNameOptions contains the optional parameters for the SQLPoolTableColumnsClient.NewListByTableNamePager method.

type SQLPoolTableColumnsClientListByTableNameResponse added in v0.2.0 

type SQLPoolTableColumnsClientListByTableNameResponse struct {
	// A list of Sql pool columns.
	SQLPoolColumnListResult
}

SQLPoolTableColumnsClientListByTableNameResponse contains the response from method SQLPoolTableColumnsClient.NewListByTableNamePager.

type SQLPoolTableListResult 

type SQLPoolTableListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*SQLPoolTable
}

SQLPoolTableListResult - A list of Sql pool tables.

func (SQLPoolTableListResult) MarshalJSON 

func (s SQLPoolTableListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolTableListResult.

func (*SQLPoolTableListResult) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolTableListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolTableListResult.

type SQLPoolTablesClient 

type SQLPoolTablesClient struct {
	// contains filtered or unexported fields
}

SQLPoolTablesClient contains the methods for the SQLPoolTables group. Don't use this type directly, use NewSQLPoolTablesClient() instead.

func NewSQLPoolTablesClient 

func NewSQLPoolTablesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolTablesClient, error)

NewSQLPoolTablesClient creates a new instance of SQLPoolTablesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolTablesClient) Get 

func (client *SQLPoolTablesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, schemaName string, tableName string, options *SQLPoolTablesClientGetOptions) (SQLPoolTablesClientGetResponse, error)

Get - Get Sql pool table If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • schemaName - The name of the schema.
  • tableName - The name of the table.
  • options - SQLPoolTablesClientGetOptions contains the optional parameters for the SQLPoolTablesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolTableGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolTablesClient().Get(ctx, "myRG", "serverName", "myDatabase", "dbo", "table1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolTable = armsynapse.SQLPoolTable{
	// 	Name: to.Ptr("table1"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table1"),
	// }
}

Output:

func (*SQLPoolTablesClient) NewListBySchemaPager added in v0.4.0 

func (client *SQLPoolTablesClient) NewListBySchemaPager(resourceGroupName string, workspaceName string, sqlPoolName string, schemaName string, options *SQLPoolTablesClientListBySchemaOptions) *runtime.Pager[SQLPoolTablesClientListBySchemaResponse]

NewListBySchemaPager - Gets tables of a given schema in a SQL pool.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • schemaName - The name of the schema.
  • options - SQLPoolTablesClientListBySchemaOptions contains the optional parameters for the SQLPoolTablesClient.NewListBySchemaPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolTables.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolTablesClient().NewListBySchemaPager("myRG", "serverName", "myDatabase", "dbo", &armsynapse.SQLPoolTablesClientListBySchemaOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLPoolTableListResult = armsynapse.SQLPoolTableListResult{
		// 	Value: []*armsynapse.SQLPoolTable{
		// 		{
		// 			Name: to.Ptr("table1"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table1"),
		// 		},
		// 		{
		// 			Name: to.Ptr("table2"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/schemas/tables"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table2"),
		// 	}},
		// }
	}
}

Output:

type SQLPoolTablesClientGetOptions added in v0.2.0 

type SQLPoolTablesClientGetOptions struct {
}

SQLPoolTablesClientGetOptions contains the optional parameters for the SQLPoolTablesClient.Get method.

type SQLPoolTablesClientGetResponse added in v0.2.0 

type SQLPoolTablesClientGetResponse struct {
	// A Sql pool table resource.
	SQLPoolTable
}

SQLPoolTablesClientGetResponse contains the response from method SQLPoolTablesClient.Get.

type SQLPoolTablesClientListBySchemaOptions added in v0.2.0 

type SQLPoolTablesClientListBySchemaOptions struct {
	// An OData filter expression that filters elements in the collection.
	Filter *string
}

SQLPoolTablesClientListBySchemaOptions contains the optional parameters for the SQLPoolTablesClient.NewListBySchemaPager method.

type SQLPoolTablesClientListBySchemaResponse added in v0.2.0 

type SQLPoolTablesClientListBySchemaResponse struct {
	// A list of Sql pool tables.
	SQLPoolTableListResult
}

SQLPoolTablesClientListBySchemaResponse contains the response from method SQLPoolTablesClient.NewListBySchemaPager.

type SQLPoolTransparentDataEncryptionsClient 

type SQLPoolTransparentDataEncryptionsClient struct {
	// contains filtered or unexported fields
}

SQLPoolTransparentDataEncryptionsClient contains the methods for the SQLPoolTransparentDataEncryptions group. Don't use this type directly, use NewSQLPoolTransparentDataEncryptionsClient() instead.

func NewSQLPoolTransparentDataEncryptionsClient 

func NewSQLPoolTransparentDataEncryptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolTransparentDataEncryptionsClient, error)

NewSQLPoolTransparentDataEncryptionsClient creates a new instance of SQLPoolTransparentDataEncryptionsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolTransparentDataEncryptionsClient) CreateOrUpdate 

func (client *SQLPoolTransparentDataEncryptionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, transparentDataEncryptionName TransparentDataEncryptionName, parameters TransparentDataEncryption, options *SQLPoolTransparentDataEncryptionsClientCreateOrUpdateOptions) (SQLPoolTransparentDataEncryptionsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a Sql pool's transparent data encryption configuration. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • transparentDataEncryptionName - The name of the transparent data encryption configuration.
  • parameters - The required parameters for creating or updating transparent data encryption.
  • options - SQLPoolTransparentDataEncryptionsClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolTransparentDataEncryptionsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolTransparentDataEncryption.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolTransparentDataEncryptionsClient().CreateOrUpdate(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", armsynapse.TransparentDataEncryptionNameCurrent, armsynapse.TransparentDataEncryption{
		Properties: &armsynapse.TransparentDataEncryptionProperties{
			Status: to.Ptr(armsynapse.TransparentDataEncryptionStatusEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.TransparentDataEncryption = armsynapse.TransparentDataEncryption{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/transparentDataEncryption/current"),
	// 	Location: to.Ptr("North Europe"),
	// 	Properties: &armsynapse.TransparentDataEncryptionProperties{
	// 		Status: to.Ptr(armsynapse.TransparentDataEncryptionStatusEnabled),
	// 	},
	// }
}

Output:

func (*SQLPoolTransparentDataEncryptionsClient) Get 

func (client *SQLPoolTransparentDataEncryptionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, transparentDataEncryptionName TransparentDataEncryptionName, options *SQLPoolTransparentDataEncryptionsClientGetOptions) (SQLPoolTransparentDataEncryptionsClientGetResponse, error)

Get - Get a SQL pool's transparent data encryption configuration. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • transparentDataEncryptionName - The name of the transparent data encryption configuration.
  • options - SQLPoolTransparentDataEncryptionsClientGetOptions contains the optional parameters for the SQLPoolTransparentDataEncryptionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolTransparentDataEncryption.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolTransparentDataEncryptionsClient().Get(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", armsynapse.TransparentDataEncryptionNameCurrent, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.TransparentDataEncryption = armsynapse.TransparentDataEncryption{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/transparentDataEncryption/current"),
	// 	Location: to.Ptr("North Europe"),
	// 	Properties: &armsynapse.TransparentDataEncryptionProperties{
	// 		Status: to.Ptr(armsynapse.TransparentDataEncryptionStatusEnabled),
	// 	},
	// }
}

Output:

func (*SQLPoolTransparentDataEncryptionsClient) NewListPager added in v0.4.0 

func (client *SQLPoolTransparentDataEncryptionsClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolTransparentDataEncryptionsClientListOptions) *runtime.Pager[SQLPoolTransparentDataEncryptionsClientListResponse]

NewListPager - Get list of SQL pool's transparent data encryption configurations.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolTransparentDataEncryptionsClientListOptions contains the optional parameters for the SQLPoolTransparentDataEncryptionsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolTransparentDataEncryptionList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolTransparentDataEncryptionsClient().NewListPager("sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.TransparentDataEncryptionListResult = armsynapse.TransparentDataEncryptionListResult{
		// 	Value: []*armsynapse.TransparentDataEncryption{
		// 		{
		// 			Name: to.Ptr("current"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/transparentDataEncryption/current"),
		// 			Location: to.Ptr("North Europe"),
		// 			Properties: &armsynapse.TransparentDataEncryptionProperties{
		// 				Status: to.Ptr(armsynapse.TransparentDataEncryptionStatusEnabled),
		// 			},
		// 	}},
		// }
	}
}

Output:

type SQLPoolTransparentDataEncryptionsClientCreateOrUpdateOptions added in v0.2.0 

type SQLPoolTransparentDataEncryptionsClientCreateOrUpdateOptions struct {
}

SQLPoolTransparentDataEncryptionsClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolTransparentDataEncryptionsClient.CreateOrUpdate method.

type SQLPoolTransparentDataEncryptionsClientCreateOrUpdateResponse added in v0.2.0 

type SQLPoolTransparentDataEncryptionsClientCreateOrUpdateResponse struct {
	// Represents a Sql pool transparent data encryption configuration.
	TransparentDataEncryption
}

SQLPoolTransparentDataEncryptionsClientCreateOrUpdateResponse contains the response from method SQLPoolTransparentDataEncryptionsClient.CreateOrUpdate.

type SQLPoolTransparentDataEncryptionsClientGetOptions added in v0.2.0 

type SQLPoolTransparentDataEncryptionsClientGetOptions struct {
}

SQLPoolTransparentDataEncryptionsClientGetOptions contains the optional parameters for the SQLPoolTransparentDataEncryptionsClient.Get method.

type SQLPoolTransparentDataEncryptionsClientGetResponse added in v0.2.0 

type SQLPoolTransparentDataEncryptionsClientGetResponse struct {
	// Represents a Sql pool transparent data encryption configuration.
	TransparentDataEncryption
}

SQLPoolTransparentDataEncryptionsClientGetResponse contains the response from method SQLPoolTransparentDataEncryptionsClient.Get.

type SQLPoolTransparentDataEncryptionsClientListOptions added in v0.2.0 

type SQLPoolTransparentDataEncryptionsClientListOptions struct {
}

SQLPoolTransparentDataEncryptionsClientListOptions contains the optional parameters for the SQLPoolTransparentDataEncryptionsClient.NewListPager method.

type SQLPoolTransparentDataEncryptionsClientListResponse added in v0.2.0 

type SQLPoolTransparentDataEncryptionsClientListResponse struct {
	// A list of transparent data encryption configurations.
	TransparentDataEncryptionListResult
}

SQLPoolTransparentDataEncryptionsClientListResponse contains the response from method SQLPoolTransparentDataEncryptionsClient.NewListPager.

type SQLPoolUsage 

type SQLPoolUsage struct {
	// READ-ONLY; The current value of the usage metric.
	CurrentValue *float64

	// READ-ONLY; The usage metric display name.
	DisplayName *string

	// READ-ONLY; The current limit of the usage metric.
	Limit *float64

	// READ-ONLY; The name of the usage metric.
	Name *string

	// READ-ONLY; The next reset time for the usage metric (ISO8601 format).
	NextResetTime *time.Time

	// READ-ONLY; The name of the resource.
	ResourceName *string

	// READ-ONLY; The units of the usage metric.
	Unit *string
}

SQLPoolUsage - The Sql pool usages.

func (SQLPoolUsage) MarshalJSON 

func (s SQLPoolUsage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolUsage.

func (*SQLPoolUsage) UnmarshalJSON 

func (s *SQLPoolUsage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolUsage.

type SQLPoolUsageListResult 

type SQLPoolUsageListResult struct {
	// REQUIRED; The list of usages for the Sql pool.
	Value []*SQLPoolUsage

	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string
}

SQLPoolUsageListResult - The response to a list Sql pool usages request.

func (SQLPoolUsageListResult) MarshalJSON 

func (s SQLPoolUsageListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolUsageListResult.

func (*SQLPoolUsageListResult) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolUsageListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolUsageListResult.

type SQLPoolUsagesClient 

type SQLPoolUsagesClient struct {
	// contains filtered or unexported fields
}

SQLPoolUsagesClient contains the methods for the SQLPoolUsages group. Don't use this type directly, use NewSQLPoolUsagesClient() instead.

func NewSQLPoolUsagesClient 

func NewSQLPoolUsagesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolUsagesClient, error)

NewSQLPoolUsagesClient creates a new instance of SQLPoolUsagesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolUsagesClient) NewListPager added in v0.4.0 

func (client *SQLPoolUsagesClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolUsagesClientListOptions) *runtime.Pager[SQLPoolUsagesClientListResponse]

NewListPager - Gets SQL pool usages.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolUsagesClientListOptions contains the optional parameters for the SQLPoolUsagesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolUsageMetricsList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolUsagesClient().NewListPager("sqlcrudtest-6730", "sqlcrudtest-9007", "3481", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLPoolUsageListResult = armsynapse.SQLPoolUsageListResult{
		// 	Value: []*armsynapse.SQLPoolUsage{
		// 		{
		// 			Name: to.Ptr("database_size"),
		// 			CurrentValue: to.Ptr[float64](4194304),
		// 			DisplayName: to.Ptr("Database Size"),
		// 			Limit: to.Ptr[float64](268435456000),
		// 			ResourceName: to.Ptr("3481"),
		// 			Unit: to.Ptr("Bytes"),
		// 	}},
		// }
	}
}

Output:

type SQLPoolUsagesClientListOptions added in v0.2.0 

type SQLPoolUsagesClientListOptions struct {
}

SQLPoolUsagesClientListOptions contains the optional parameters for the SQLPoolUsagesClient.NewListPager method.

type SQLPoolUsagesClientListResponse added in v0.2.0 

type SQLPoolUsagesClientListResponse struct {
	// The response to a list Sql pool usages request.
	SQLPoolUsageListResult
}

SQLPoolUsagesClientListResponse contains the response from method SQLPoolUsagesClient.NewListPager.

type SQLPoolVulnerabilityAssessment 

type SQLPoolVulnerabilityAssessment struct {
	// Resource properties.
	Properties *SQLPoolVulnerabilityAssessmentProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLPoolVulnerabilityAssessment - A Sql pool vulnerability assessment.

func (SQLPoolVulnerabilityAssessment) MarshalJSON 

func (s SQLPoolVulnerabilityAssessment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolVulnerabilityAssessment.

func (*SQLPoolVulnerabilityAssessment) UnmarshalJSON 

func (s *SQLPoolVulnerabilityAssessment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolVulnerabilityAssessment.

type SQLPoolVulnerabilityAssessmentListResult 

type SQLPoolVulnerabilityAssessmentListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*SQLPoolVulnerabilityAssessment
}

SQLPoolVulnerabilityAssessmentListResult - A list of the Sql pool's vulnerability assessments.

func (SQLPoolVulnerabilityAssessmentListResult) MarshalJSON 

func (s SQLPoolVulnerabilityAssessmentListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolVulnerabilityAssessmentListResult.

func (*SQLPoolVulnerabilityAssessmentListResult) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolVulnerabilityAssessmentListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolVulnerabilityAssessmentListResult.

type SQLPoolVulnerabilityAssessmentProperties 

type SQLPoolVulnerabilityAssessmentProperties struct {
	// The recurring scans settings
	RecurringScans *VulnerabilityAssessmentRecurringScansProperties

	// Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey'
	// isn't specified, storageAccountAccessKey is required.
	StorageAccountAccessKey *string

	// A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required
	// if server level vulnerability assessment policy doesn't set
	StorageContainerPath *string

	// A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter.
	// If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is
	// required.
	StorageContainerSasKey *string
}

SQLPoolVulnerabilityAssessmentProperties - Properties of a Sql pool Vulnerability Assessment.

func (SQLPoolVulnerabilityAssessmentProperties) MarshalJSON added in v0.6.0 

func (s SQLPoolVulnerabilityAssessmentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolVulnerabilityAssessmentProperties.

func (*SQLPoolVulnerabilityAssessmentProperties) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolVulnerabilityAssessmentProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolVulnerabilityAssessmentProperties.

type SQLPoolVulnerabilityAssessmentRuleBaseline 

type SQLPoolVulnerabilityAssessmentRuleBaseline struct {
	// Resource properties.
	Properties *SQLPoolVulnerabilityAssessmentRuleBaselineProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLPoolVulnerabilityAssessmentRuleBaseline - A Sql pool vulnerability assessment rule baseline.

func (SQLPoolVulnerabilityAssessmentRuleBaseline) MarshalJSON 

func (s SQLPoolVulnerabilityAssessmentRuleBaseline) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolVulnerabilityAssessmentRuleBaseline.

func (*SQLPoolVulnerabilityAssessmentRuleBaseline) UnmarshalJSON 

func (s *SQLPoolVulnerabilityAssessmentRuleBaseline) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolVulnerabilityAssessmentRuleBaseline.

type SQLPoolVulnerabilityAssessmentRuleBaselineItem 

type SQLPoolVulnerabilityAssessmentRuleBaselineItem struct {
	// REQUIRED; The rule baseline result
	Result []*string
}

SQLPoolVulnerabilityAssessmentRuleBaselineItem - Properties for an Sql pool vulnerability assessment rule baseline's result.

func (SQLPoolVulnerabilityAssessmentRuleBaselineItem) MarshalJSON 

func (s SQLPoolVulnerabilityAssessmentRuleBaselineItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolVulnerabilityAssessmentRuleBaselineItem.

func (*SQLPoolVulnerabilityAssessmentRuleBaselineItem) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolVulnerabilityAssessmentRuleBaselineItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolVulnerabilityAssessmentRuleBaselineItem.

type SQLPoolVulnerabilityAssessmentRuleBaselineProperties 

type SQLPoolVulnerabilityAssessmentRuleBaselineProperties struct {
	// REQUIRED; The rule baseline result
	BaselineResults []*SQLPoolVulnerabilityAssessmentRuleBaselineItem
}

SQLPoolVulnerabilityAssessmentRuleBaselineProperties - Properties of a Sql pool vulnerability assessment rule baseline.

func (SQLPoolVulnerabilityAssessmentRuleBaselineProperties) MarshalJSON 

func (s SQLPoolVulnerabilityAssessmentRuleBaselineProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolVulnerabilityAssessmentRuleBaselineProperties.

func (*SQLPoolVulnerabilityAssessmentRuleBaselineProperties) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolVulnerabilityAssessmentRuleBaselineProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolVulnerabilityAssessmentRuleBaselineProperties.

type SQLPoolVulnerabilityAssessmentRuleBaselinesClient 

type SQLPoolVulnerabilityAssessmentRuleBaselinesClient struct {
	// contains filtered or unexported fields
}

SQLPoolVulnerabilityAssessmentRuleBaselinesClient contains the methods for the SQLPoolVulnerabilityAssessmentRuleBaselines group. Don't use this type directly, use NewSQLPoolVulnerabilityAssessmentRuleBaselinesClient() instead.

func NewSQLPoolVulnerabilityAssessmentRuleBaselinesClient 

func NewSQLPoolVulnerabilityAssessmentRuleBaselinesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolVulnerabilityAssessmentRuleBaselinesClient, error)

NewSQLPoolVulnerabilityAssessmentRuleBaselinesClient creates a new instance of SQLPoolVulnerabilityAssessmentRuleBaselinesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolVulnerabilityAssessmentRuleBaselinesClient) CreateOrUpdate 

func (client *SQLPoolVulnerabilityAssessmentRuleBaselinesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, ruleID string, baselineName VulnerabilityAssessmentPolicyBaselineName, parameters SQLPoolVulnerabilityAssessmentRuleBaseline, options *SQLPoolVulnerabilityAssessmentRuleBaselinesClientCreateOrUpdateOptions) (SQLPoolVulnerabilityAssessmentRuleBaselinesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a Sql pool's vulnerability assessment rule baseline. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • ruleID - The vulnerability assessment rule ID.
  • baselineName - The name of the vulnerability assessment rule baseline (default implies a baseline on a Sql pool level rule and master for workspace level rule).
  • parameters - The requested rule baseline resource.
  • options - SQLPoolVulnerabilityAssessmentRuleBaselinesClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentRuleBaselinesClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentRuleBaseline.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolVulnerabilityAssessmentRuleBaselinesClient().CreateOrUpdate(ctx, "vulnerabilityaseessmenttest-4799", "vulnerabilityaseessmenttest-6440", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, "VA1001", armsynapse.VulnerabilityAssessmentPolicyBaselineNameDefault, armsynapse.SQLPoolVulnerabilityAssessmentRuleBaseline{
		Properties: &armsynapse.SQLPoolVulnerabilityAssessmentRuleBaselineProperties{
			BaselineResults: []*armsynapse.SQLPoolVulnerabilityAssessmentRuleBaselineItem{
				{
					Result: []*string{
						to.Ptr("userA"),
						to.Ptr("SELECT")},
				},
				{
					Result: []*string{
						to.Ptr("userB"),
						to.Ptr("SELECT")},
				},
				{
					Result: []*string{
						to.Ptr("userC"),
						to.Ptr("SELECT"),
						to.Ptr("tableId_4")},
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolVulnerabilityAssessmentRuleBaseline = armsynapse.SQLPoolVulnerabilityAssessmentRuleBaseline{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/rules/VA1001/baselines/default"),
	// 	Properties: &armsynapse.SQLPoolVulnerabilityAssessmentRuleBaselineProperties{
	// 		BaselineResults: []*armsynapse.SQLPoolVulnerabilityAssessmentRuleBaselineItem{
	// 			{
	// 				Result: []*string{
	// 					to.Ptr("userA"),
	// 					to.Ptr("SELECT")},
	// 				},
	// 				{
	// 					Result: []*string{
	// 						to.Ptr("userB"),
	// 						to.Ptr("SELECT")},
	// 					},
	// 					{
	// 						Result: []*string{
	// 							to.Ptr("userC"),
	// 							to.Ptr("SELECT"),
	// 							to.Ptr("tableId_4")},
	// 					}},
	// 				},
	// 			}
}

Output:

func (*SQLPoolVulnerabilityAssessmentRuleBaselinesClient) Delete 

func (client *SQLPoolVulnerabilityAssessmentRuleBaselinesClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, ruleID string, baselineName VulnerabilityAssessmentPolicyBaselineName, options *SQLPoolVulnerabilityAssessmentRuleBaselinesClientDeleteOptions) (SQLPoolVulnerabilityAssessmentRuleBaselinesClientDeleteResponse, error)

Delete - Removes the database's vulnerability assessment rule baseline. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • ruleID - The vulnerability assessment rule ID.
  • baselineName - The name of the vulnerability assessment rule baseline (default implies a baseline on a Sql pool level rule and master for workspace level rule).
  • options - SQLPoolVulnerabilityAssessmentRuleBaselinesClientDeleteOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentRuleBaselinesClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteSqlPoolVulnerabilityAssessmentRuleBaseline.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSQLPoolVulnerabilityAssessmentRuleBaselinesClient().Delete(ctx, "vulnerabilityaseessmenttest-4799", "vulnerabilityaseessmenttest-6440", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, "VA1001", armsynapse.VulnerabilityAssessmentPolicyBaselineNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SQLPoolVulnerabilityAssessmentRuleBaselinesClient) Get 

func (client *SQLPoolVulnerabilityAssessmentRuleBaselinesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, ruleID string, baselineName VulnerabilityAssessmentPolicyBaselineName, options *SQLPoolVulnerabilityAssessmentRuleBaselinesClientGetOptions) (SQLPoolVulnerabilityAssessmentRuleBaselinesClientGetResponse, error)

Get - Gets a SqlPool's vulnerability assessment rule baseline. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • ruleID - The vulnerability assessment rule ID.
  • baselineName - The name of the vulnerability assessment rule baseline (default implies a baseline on a Sql pool level rule and master for server level rule).
  • options - SQLPoolVulnerabilityAssessmentRuleBaselinesClientGetOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentRuleBaselinesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolVulnerabilityAssessmentRuleBaselineGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolVulnerabilityAssessmentRuleBaselinesClient().Get(ctx, "vulnerabilityaseessmenttest-4711", "vulnerabilityaseessmenttest-6411", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, "VA1001", armsynapse.VulnerabilityAssessmentPolicyBaselineNameMaster, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolVulnerabilityAssessmentRuleBaseline = armsynapse.SQLPoolVulnerabilityAssessmentRuleBaseline{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/rules/VA1001/baselines/default"),
	// 	Properties: &armsynapse.SQLPoolVulnerabilityAssessmentRuleBaselineProperties{
	// 		BaselineResults: []*armsynapse.SQLPoolVulnerabilityAssessmentRuleBaselineItem{
	// 			{
	// 				Result: []*string{
	// 					to.Ptr("userA"),
	// 					to.Ptr("SELECT")},
	// 				},
	// 				{
	// 					Result: []*string{
	// 						to.Ptr("userB"),
	// 						to.Ptr("SELECT")},
	// 					},
	// 					{
	// 						Result: []*string{
	// 							to.Ptr("userC"),
	// 							to.Ptr("SELECT"),
	// 							to.Ptr("tableId_4")},
	// 					}},
	// 				},
	// 			}
}

Output:

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientCreateOrUpdateOptions added in v0.2.0 

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientCreateOrUpdateOptions struct {
}

SQLPoolVulnerabilityAssessmentRuleBaselinesClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentRuleBaselinesClient.CreateOrUpdate method.

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientCreateOrUpdateResponse added in v0.2.0 

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientCreateOrUpdateResponse struct {
	// A Sql pool vulnerability assessment rule baseline.
	SQLPoolVulnerabilityAssessmentRuleBaseline
}

SQLPoolVulnerabilityAssessmentRuleBaselinesClientCreateOrUpdateResponse contains the response from method SQLPoolVulnerabilityAssessmentRuleBaselinesClient.CreateOrUpdate.

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientDeleteOptions added in v0.2.0 

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientDeleteOptions struct {
}

SQLPoolVulnerabilityAssessmentRuleBaselinesClientDeleteOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentRuleBaselinesClient.Delete method.

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientDeleteResponse added in v0.2.0 

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientDeleteResponse struct {
}

SQLPoolVulnerabilityAssessmentRuleBaselinesClientDeleteResponse contains the response from method SQLPoolVulnerabilityAssessmentRuleBaselinesClient.Delete.

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientGetOptions added in v0.2.0 

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientGetOptions struct {
}

SQLPoolVulnerabilityAssessmentRuleBaselinesClientGetOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentRuleBaselinesClient.Get method.

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientGetResponse added in v0.2.0 

type SQLPoolVulnerabilityAssessmentRuleBaselinesClientGetResponse struct {
	// A Sql pool vulnerability assessment rule baseline.
	SQLPoolVulnerabilityAssessmentRuleBaseline
}

SQLPoolVulnerabilityAssessmentRuleBaselinesClientGetResponse contains the response from method SQLPoolVulnerabilityAssessmentRuleBaselinesClient.Get.

type SQLPoolVulnerabilityAssessmentScanExportProperties 

type SQLPoolVulnerabilityAssessmentScanExportProperties struct {
	// READ-ONLY; Location of the exported report (e.g. https://myStorage.blob.core.windows.net/VaScans/scans/serverName/databaseName/scan_scanId.xlsx).
	ExportedReportLocation *string
}

SQLPoolVulnerabilityAssessmentScanExportProperties - Properties of the export operation's result.

func (SQLPoolVulnerabilityAssessmentScanExportProperties) MarshalJSON added in v0.6.0 

func (s SQLPoolVulnerabilityAssessmentScanExportProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolVulnerabilityAssessmentScanExportProperties.

func (*SQLPoolVulnerabilityAssessmentScanExportProperties) UnmarshalJSON added in v0.6.0 

func (s *SQLPoolVulnerabilityAssessmentScanExportProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolVulnerabilityAssessmentScanExportProperties.

type SQLPoolVulnerabilityAssessmentScansClient 

type SQLPoolVulnerabilityAssessmentScansClient struct {
	// contains filtered or unexported fields
}

SQLPoolVulnerabilityAssessmentScansClient contains the methods for the SQLPoolVulnerabilityAssessmentScans group. Don't use this type directly, use NewSQLPoolVulnerabilityAssessmentScansClient() instead.

func NewSQLPoolVulnerabilityAssessmentScansClient 

func NewSQLPoolVulnerabilityAssessmentScansClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolVulnerabilityAssessmentScansClient, error)

NewSQLPoolVulnerabilityAssessmentScansClient creates a new instance of SQLPoolVulnerabilityAssessmentScansClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolVulnerabilityAssessmentScansClient) BeginInitiateScan 

func (client *SQLPoolVulnerabilityAssessmentScansClient) BeginInitiateScan(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, scanID string, options *SQLPoolVulnerabilityAssessmentScansClientBeginInitiateScanOptions) (*runtime.Poller[SQLPoolVulnerabilityAssessmentScansClientInitiateScanResponse], error)

BeginInitiateScan - Executes a Vulnerability Assessment database scan. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • scanID - The vulnerability assessment scan Id of the scan to retrieve.
  • options - SQLPoolVulnerabilityAssessmentScansClientBeginInitiateScanOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentScansClient.BeginInitiateScan method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ExecuteSqlPoolVulnerabilityAssessmentScans.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolVulnerabilityAssessmentScansClient().BeginInitiateScan(ctx, "vulnerabilityassessmenttest-4711", "vulnerabilityassessmenttest-6411", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, "scan01", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*SQLPoolVulnerabilityAssessmentScansClient) Export 

func (client *SQLPoolVulnerabilityAssessmentScansClient) Export(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, scanID string, options *SQLPoolVulnerabilityAssessmentScansClientExportOptions) (SQLPoolVulnerabilityAssessmentScansClientExportResponse, error)

Export - Convert an existing scan result to a human readable format. If already exists nothing happens If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • scanID - The vulnerability assessment scan Id of the scan to retrieve.
  • options - SQLPoolVulnerabilityAssessmentScansClientExportOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentScansClient.Export method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ExportSqlPoolVulnerabilityAssessmentScan.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolVulnerabilityAssessmentScansClient().Export(ctx, "vulnerabilityassessmenttest-4799", "vulnerabilityassessmenttest-6440", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, "scan001", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolVulnerabilityAssessmentScansExport = armsynapse.SQLPoolVulnerabilityAssessmentScansExport{
	// 	Name: to.Ptr("scan001"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/export"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan001/export"),
	// 	Properties: &armsynapse.SQLPoolVulnerabilityAssessmentScanExportProperties{
	// 		ExportedReportLocation: to.Ptr("https://myaccount.blob.core.windows.net/vulnerabilityAssessment/vulnerabilityassessmenttest-6440/testdb/scan001.xlsx"),
	// 	},
	// }
}

Output:

func (*SQLPoolVulnerabilityAssessmentScansClient) Get 

func (client *SQLPoolVulnerabilityAssessmentScansClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, scanID string, options *SQLPoolVulnerabilityAssessmentScansClientGetOptions) (SQLPoolVulnerabilityAssessmentScansClientGetResponse, error)

Get - Gets a vulnerability assessment scan record of a Sql pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • scanID - The vulnerability assessment scan Id of the scan to retrieve.
  • options - SQLPoolVulnerabilityAssessmentScansClientGetOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentScansClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolVulnerabilityAssessmentScanRecordsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolVulnerabilityAssessmentScansClient().Get(ctx, "vulnerabilityassessmenttest-4711", "vulnerabilityassessmenttest-6411", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, "scan001", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VulnerabilityAssessmentScanRecord = armsynapse.VulnerabilityAssessmentScanRecord{
	// 	Name: to.Ptr("scan001"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan001"),
	// 	Properties: &armsynapse.VulnerabilityAssessmentScanRecordProperties{
	// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-12T17:47:06.000Z"); return t}()),
	// 		Errors: []*armsynapse.VulnerabilityAssessmentScanError{
	// 		},
	// 		NumberOfFailedSecurityChecks: to.Ptr[int32](9),
	// 		ScanID: to.Ptr("scan001"),
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-12T17:45:06.000Z"); return t}()),
	// 		State: to.Ptr(armsynapse.VulnerabilityAssessmentScanStatePassed),
	// 		StorageContainerPath: to.Ptr("https://myaccount.blob.core.windows.net/vulnerability-assessment"),
	// 		TriggerType: to.Ptr(armsynapse.VulnerabilityAssessmentScanTriggerTypeOnDemand),
	// 	},
	// }
}

Output:

func (*SQLPoolVulnerabilityAssessmentScansClient) NewListPager added in v0.4.0 

func (client *SQLPoolVulnerabilityAssessmentScansClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, options *SQLPoolVulnerabilityAssessmentScansClientListOptions) *runtime.Pager[SQLPoolVulnerabilityAssessmentScansClientListResponse]

NewListPager - Lists the vulnerability assessment scans of a SQL pool.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • options - SQLPoolVulnerabilityAssessmentScansClientListOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentScansClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolVulnerabilityAssessmentScanRecords.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolVulnerabilityAssessmentScansClient().NewListPager("vulnerabilityassessmenttest-4711", "vulnerabilityassessmenttest-6411", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.VulnerabilityAssessmentScanRecordListResult = armsynapse.VulnerabilityAssessmentScanRecordListResult{
		// 	Value: []*armsynapse.VulnerabilityAssessmentScanRecord{
		// 		{
		// 			Name: to.Ptr("scan001"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan001"),
		// 			Properties: &armsynapse.VulnerabilityAssessmentScanRecordProperties{
		// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-12T17:47:06.000Z"); return t}()),
		// 				Errors: []*armsynapse.VulnerabilityAssessmentScanError{
		// 				},
		// 				NumberOfFailedSecurityChecks: to.Ptr[int32](9),
		// 				ScanID: to.Ptr("scan001"),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-12T17:45:06.000Z"); return t}()),
		// 				State: to.Ptr(armsynapse.VulnerabilityAssessmentScanStatePassed),
		// 				TriggerType: to.Ptr(armsynapse.VulnerabilityAssessmentScanTriggerTypeOnDemand),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("scan002"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan002"),
		// 			Properties: &armsynapse.VulnerabilityAssessmentScanRecordProperties{
		// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-12T17:47:06.000Z"); return t}()),
		// 				Errors: []*armsynapse.VulnerabilityAssessmentScanError{
		// 				},
		// 				NumberOfFailedSecurityChecks: to.Ptr[int32](9),
		// 				ScanID: to.Ptr("scan002"),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-12T17:45:06.000Z"); return t}()),
		// 				State: to.Ptr(armsynapse.VulnerabilityAssessmentScanStateFailed),
		// 				TriggerType: to.Ptr(armsynapse.VulnerabilityAssessmentScanTriggerTypeRecurring),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("scan003"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan003"),
		// 			Properties: &armsynapse.VulnerabilityAssessmentScanRecordProperties{
		// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-12T17:47:06.000Z"); return t}()),
		// 				Errors: []*armsynapse.VulnerabilityAssessmentScanError{
		// 					{
		// 						Code: to.Ptr("StorageNotFound"),
		// 						Message: to.Ptr("Storage not found"),
		// 				}},
		// 				NumberOfFailedSecurityChecks: to.Ptr[int32](0),
		// 				ScanID: to.Ptr("scan003"),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-12T17:45:06.000Z"); return t}()),
		// 				State: to.Ptr(armsynapse.VulnerabilityAssessmentScanStateFailedToRun),
		// 				TriggerType: to.Ptr(armsynapse.VulnerabilityAssessmentScanTriggerTypeRecurring),
		// 			},
		// 	}},
		// }
	}
}

Output:

type SQLPoolVulnerabilityAssessmentScansClientBeginInitiateScanOptions added in v0.2.0 

type SQLPoolVulnerabilityAssessmentScansClientBeginInitiateScanOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolVulnerabilityAssessmentScansClientBeginInitiateScanOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentScansClient.BeginInitiateScan method.

type SQLPoolVulnerabilityAssessmentScansClientExportOptions added in v0.2.0 

type SQLPoolVulnerabilityAssessmentScansClientExportOptions struct {
}

SQLPoolVulnerabilityAssessmentScansClientExportOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentScansClient.Export method.

type SQLPoolVulnerabilityAssessmentScansClientExportResponse added in v0.2.0 

type SQLPoolVulnerabilityAssessmentScansClientExportResponse struct {
	// A Sql pool Vulnerability Assessment scan export resource.
	SQLPoolVulnerabilityAssessmentScansExport
}

SQLPoolVulnerabilityAssessmentScansClientExportResponse contains the response from method SQLPoolVulnerabilityAssessmentScansClient.Export.

type SQLPoolVulnerabilityAssessmentScansClientGetOptions added in v0.2.0 

type SQLPoolVulnerabilityAssessmentScansClientGetOptions struct {
}

SQLPoolVulnerabilityAssessmentScansClientGetOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentScansClient.Get method.

type SQLPoolVulnerabilityAssessmentScansClientGetResponse added in v0.2.0 

type SQLPoolVulnerabilityAssessmentScansClientGetResponse struct {
	// A vulnerability assessment scan record.
	VulnerabilityAssessmentScanRecord
}

SQLPoolVulnerabilityAssessmentScansClientGetResponse contains the response from method SQLPoolVulnerabilityAssessmentScansClient.Get.

type SQLPoolVulnerabilityAssessmentScansClientInitiateScanResponse added in v0.2.0 

type SQLPoolVulnerabilityAssessmentScansClientInitiateScanResponse struct {
}

SQLPoolVulnerabilityAssessmentScansClientInitiateScanResponse contains the response from method SQLPoolVulnerabilityAssessmentScansClient.BeginInitiateScan.

type SQLPoolVulnerabilityAssessmentScansClientListOptions added in v0.2.0 

type SQLPoolVulnerabilityAssessmentScansClientListOptions struct {
}

SQLPoolVulnerabilityAssessmentScansClientListOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentScansClient.NewListPager method.

type SQLPoolVulnerabilityAssessmentScansClientListResponse added in v0.2.0 

type SQLPoolVulnerabilityAssessmentScansClientListResponse struct {
	// A list of vulnerability assessment scan records.
	VulnerabilityAssessmentScanRecordListResult
}

SQLPoolVulnerabilityAssessmentScansClientListResponse contains the response from method SQLPoolVulnerabilityAssessmentScansClient.NewListPager.

type SQLPoolVulnerabilityAssessmentScansExport 

type SQLPoolVulnerabilityAssessmentScansExport struct {
	// Resource properties.
	Properties *SQLPoolVulnerabilityAssessmentScanExportProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLPoolVulnerabilityAssessmentScansExport - A Sql pool Vulnerability Assessment scan export resource.

func (SQLPoolVulnerabilityAssessmentScansExport) MarshalJSON 

func (s SQLPoolVulnerabilityAssessmentScansExport) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLPoolVulnerabilityAssessmentScansExport.

func (*SQLPoolVulnerabilityAssessmentScansExport) UnmarshalJSON 

func (s *SQLPoolVulnerabilityAssessmentScansExport) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLPoolVulnerabilityAssessmentScansExport.

type SQLPoolVulnerabilityAssessmentsClient 

type SQLPoolVulnerabilityAssessmentsClient struct {
	// contains filtered or unexported fields
}

SQLPoolVulnerabilityAssessmentsClient contains the methods for the SQLPoolVulnerabilityAssessments group. Don't use this type directly, use NewSQLPoolVulnerabilityAssessmentsClient() instead.

func NewSQLPoolVulnerabilityAssessmentsClient 

func NewSQLPoolVulnerabilityAssessmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolVulnerabilityAssessmentsClient, error)

NewSQLPoolVulnerabilityAssessmentsClient creates a new instance of SQLPoolVulnerabilityAssessmentsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolVulnerabilityAssessmentsClient) CreateOrUpdate 

func (client *SQLPoolVulnerabilityAssessmentsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, parameters SQLPoolVulnerabilityAssessment, options *SQLPoolVulnerabilityAssessmentsClientCreateOrUpdateOptions) (SQLPoolVulnerabilityAssessmentsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates the Sql pool vulnerability assessment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • parameters - The requested resource.
  • options - SQLPoolVulnerabilityAssessmentsClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentsClient.CreateOrUpdate method.
Example (CreateADatabasesVulnerabilityAssessmentWithAllParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentWithAllParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolVulnerabilityAssessmentsClient().CreateOrUpdate(ctx, "vulnerabilityaseessmenttest-4799", "vulnerabilityaseessmenttest-6440", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, armsynapse.SQLPoolVulnerabilityAssessment{
		Properties: &armsynapse.SQLPoolVulnerabilityAssessmentProperties{
			RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
				EmailSubscriptionAdmins: to.Ptr(true),
				Emails: []*string{
					to.Ptr("email1@mail.com"),
					to.Ptr("email2@mail.com")},
				IsEnabled: to.Ptr(true),
			},
			StorageAccountAccessKey: to.Ptr("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"),
			StorageContainerPath:    to.Ptr("https://myStorage.blob.core.windows.net/vulnerability-assessment/"),
			StorageContainerSasKey:  to.Ptr("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolVulnerabilityAssessment = armsynapse.SQLPoolVulnerabilityAssessment{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default"),
	// 	Properties: &armsynapse.SQLPoolVulnerabilityAssessmentProperties{
	// 		RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
	// 			EmailSubscriptionAdmins: to.Ptr(true),
	// 			Emails: []*string{
	// 				to.Ptr("email1@mail.com"),
	// 				to.Ptr("email2@mail.com")},
	// 				IsEnabled: to.Ptr(true),
	// 			},
	// 		},
	// 	}
}

Output:
Example (CreateADatabasesVulnerabilityAssessmentWithMinimalParametersWhenStorageAccountAccessKeyIsSpecified)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateVulnerabilityAssessmentWithStorageAccessKeyAndMinParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolVulnerabilityAssessmentsClient().CreateOrUpdate(ctx, "vulnerabilityaseessmenttest-4799", "vulnerabilityaseessmenttest-6440", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, armsynapse.SQLPoolVulnerabilityAssessment{
		Properties: &armsynapse.SQLPoolVulnerabilityAssessmentProperties{
			StorageAccountAccessKey: to.Ptr("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"),
			StorageContainerPath:    to.Ptr("https://myStorage.blob.core.windows.net/vulnerability-assessment/"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolVulnerabilityAssessment = armsynapse.SQLPoolVulnerabilityAssessment{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default"),
	// 	Properties: &armsynapse.SQLPoolVulnerabilityAssessmentProperties{
	// 		RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
	// 			EmailSubscriptionAdmins: to.Ptr(false),
	// 			Emails: []*string{
	// 			},
	// 			IsEnabled: to.Ptr(true),
	// 		},
	// 	},
	// }
}

Output:
Example (CreateADatabasesVulnerabilityAssessmentWithMinimalParametersWhenStorageContainerSasKeyIsSpecified)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentWithContainerSasKeyAndMinParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolVulnerabilityAssessmentsClient().CreateOrUpdate(ctx, "vulnerabilityaseessmenttest-4799", "vulnerabilityaseessmenttest-6440", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, armsynapse.SQLPoolVulnerabilityAssessment{
		Properties: &armsynapse.SQLPoolVulnerabilityAssessmentProperties{
			StorageContainerPath:   to.Ptr("https://myStorage.blob.core.windows.net/vulnerability-assessment/"),
			StorageContainerSasKey: to.Ptr("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolVulnerabilityAssessment = armsynapse.SQLPoolVulnerabilityAssessment{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default"),
	// 	Properties: &armsynapse.SQLPoolVulnerabilityAssessmentProperties{
	// 		RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
	// 			EmailSubscriptionAdmins: to.Ptr(false),
	// 			Emails: []*string{
	// 			},
	// 			IsEnabled: to.Ptr(true),
	// 		},
	// 	},
	// }
}

Output:

func (*SQLPoolVulnerabilityAssessmentsClient) Delete 

func (client *SQLPoolVulnerabilityAssessmentsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, options *SQLPoolVulnerabilityAssessmentsClientDeleteOptions) (SQLPoolVulnerabilityAssessmentsClientDeleteResponse, error)

Delete - Removes the database's vulnerability assessment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • options - SQLPoolVulnerabilityAssessmentsClientDeleteOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteSqlPoolVulnerabilityAssessment.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSQLPoolVulnerabilityAssessmentsClient().Delete(ctx, "vulnerabilityaseessmenttest-4799", "vulnerabilityaseessmenttest-6440", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*SQLPoolVulnerabilityAssessmentsClient) Get 

func (client *SQLPoolVulnerabilityAssessmentsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, options *SQLPoolVulnerabilityAssessmentsClientGetOptions) (SQLPoolVulnerabilityAssessmentsClientGetResponse, error)

Get - Gets the Sql pool's vulnerability assessment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • options - SQLPoolVulnerabilityAssessmentsClientGetOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolVulnerabilityAssessment.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolVulnerabilityAssessmentsClient().Get(ctx, "vulnerabilityaseessmenttest-4799", "vulnerabilityaseessmenttest-6440", "testdb", armsynapse.VulnerabilityAssessmentNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPoolVulnerabilityAssessment = armsynapse.SQLPoolVulnerabilityAssessment{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default"),
	// 	Properties: &armsynapse.SQLPoolVulnerabilityAssessmentProperties{
	// 		RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
	// 			EmailSubscriptionAdmins: to.Ptr(true),
	// 			Emails: []*string{
	// 				to.Ptr("email1@mail.com"),
	// 				to.Ptr("email2@mail.com")},
	// 				IsEnabled: to.Ptr(true),
	// 			},
	// 		},
	// 	}
}

Output:

func (*SQLPoolVulnerabilityAssessmentsClient) NewListPager added in v0.4.0 

func (client *SQLPoolVulnerabilityAssessmentsClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolVulnerabilityAssessmentsClientListOptions) *runtime.Pager[SQLPoolVulnerabilityAssessmentsClientListResponse]

NewListPager - Lists the vulnerability assessment policies associated with a SQL pool.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolVulnerabilityAssessmentsClientListOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolVulnerabilityAssessments.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolVulnerabilityAssessmentsClient().NewListPager("vulnerabilityaseessmenttest-4799", "vulnerabilityaseessmenttest-6440", "testdb", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLPoolVulnerabilityAssessmentListResult = armsynapse.SQLPoolVulnerabilityAssessmentListResult{
		// 	Value: []*armsynapse.SQLPoolVulnerabilityAssessment{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default"),
		// 			Properties: &armsynapse.SQLPoolVulnerabilityAssessmentProperties{
		// 				RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
		// 					EmailSubscriptionAdmins: to.Ptr(true),
		// 					Emails: []*string{
		// 						to.Ptr("email1@mail.com"),
		// 						to.Ptr("email2@mail.com")},
		// 						IsEnabled: to.Ptr(true),
		// 					},
		// 				},
		// 		}},
		// 	}
	}
}

Output:

type SQLPoolVulnerabilityAssessmentsClientCreateOrUpdateOptions added in v0.2.0 

type SQLPoolVulnerabilityAssessmentsClientCreateOrUpdateOptions struct {
}

SQLPoolVulnerabilityAssessmentsClientCreateOrUpdateOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentsClient.CreateOrUpdate method.

type SQLPoolVulnerabilityAssessmentsClientCreateOrUpdateResponse added in v0.2.0 

type SQLPoolVulnerabilityAssessmentsClientCreateOrUpdateResponse struct {
	// A Sql pool vulnerability assessment.
	SQLPoolVulnerabilityAssessment
}

SQLPoolVulnerabilityAssessmentsClientCreateOrUpdateResponse contains the response from method SQLPoolVulnerabilityAssessmentsClient.CreateOrUpdate.

type SQLPoolVulnerabilityAssessmentsClientDeleteOptions added in v0.2.0 

type SQLPoolVulnerabilityAssessmentsClientDeleteOptions struct {
}

SQLPoolVulnerabilityAssessmentsClientDeleteOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentsClient.Delete method.

type SQLPoolVulnerabilityAssessmentsClientDeleteResponse added in v0.2.0 

type SQLPoolVulnerabilityAssessmentsClientDeleteResponse struct {
}

SQLPoolVulnerabilityAssessmentsClientDeleteResponse contains the response from method SQLPoolVulnerabilityAssessmentsClient.Delete.

type SQLPoolVulnerabilityAssessmentsClientGetOptions added in v0.2.0 

type SQLPoolVulnerabilityAssessmentsClientGetOptions struct {
}

SQLPoolVulnerabilityAssessmentsClientGetOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentsClient.Get method.

type SQLPoolVulnerabilityAssessmentsClientGetResponse added in v0.2.0 

type SQLPoolVulnerabilityAssessmentsClientGetResponse struct {
	// A Sql pool vulnerability assessment.
	SQLPoolVulnerabilityAssessment
}

SQLPoolVulnerabilityAssessmentsClientGetResponse contains the response from method SQLPoolVulnerabilityAssessmentsClient.Get.

type SQLPoolVulnerabilityAssessmentsClientListOptions added in v0.2.0 

type SQLPoolVulnerabilityAssessmentsClientListOptions struct {
}

SQLPoolVulnerabilityAssessmentsClientListOptions contains the optional parameters for the SQLPoolVulnerabilityAssessmentsClient.NewListPager method.

type SQLPoolVulnerabilityAssessmentsClientListResponse added in v0.2.0 

type SQLPoolVulnerabilityAssessmentsClientListResponse struct {
	// A list of the Sql pool's vulnerability assessments.
	SQLPoolVulnerabilityAssessmentListResult
}

SQLPoolVulnerabilityAssessmentsClientListResponse contains the response from method SQLPoolVulnerabilityAssessmentsClient.NewListPager.

type SQLPoolWorkloadClassifierClient 

type SQLPoolWorkloadClassifierClient struct {
	// contains filtered or unexported fields
}

SQLPoolWorkloadClassifierClient contains the methods for the SQLPoolWorkloadClassifier group. Don't use this type directly, use NewSQLPoolWorkloadClassifierClient() instead.

func NewSQLPoolWorkloadClassifierClient 

func NewSQLPoolWorkloadClassifierClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolWorkloadClassifierClient, error)

NewSQLPoolWorkloadClassifierClient creates a new instance of SQLPoolWorkloadClassifierClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolWorkloadClassifierClient) BeginCreateOrUpdate 

func (client *SQLPoolWorkloadClassifierClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, workloadGroupName string, workloadClassifierName string, parameters WorkloadClassifier, options *SQLPoolWorkloadClassifierClientBeginCreateOrUpdateOptions) (*runtime.Poller[SQLPoolWorkloadClassifierClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create Or Update workload classifier for a Sql pool's workload group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • workloadGroupName - The name of the workload group.
  • workloadClassifierName - The name of the workload classifier.
  • parameters - The properties of the workload classifier.
  • options - SQLPoolWorkloadClassifierClientBeginCreateOrUpdateOptions contains the optional parameters for the SQLPoolWorkloadClassifierClient.BeginCreateOrUpdate method.
Example (CreateAWorkloadClassifierWithAllPropertiesSpecified)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolWorkloadClassifierMax.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolWorkloadClassifierClient().BeginCreateOrUpdate(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", "wlm_workloadgroup", "wlm_workloadclassifier", armsynapse.WorkloadClassifier{
		Properties: &armsynapse.WorkloadClassifierProperties{
			Context:    to.Ptr("test_context"),
			EndTime:    to.Ptr("14:00"),
			Importance: to.Ptr("high"),
			Label:      to.Ptr("test_label"),
			MemberName: to.Ptr("dbo"),
			StartTime:  to.Ptr("12:00"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkloadClassifier = armsynapse.WorkloadClassifier{
	// 	Name: to.Ptr("wlm_workloadclassifier"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_workloadclassifier"),
	// 	Properties: &armsynapse.WorkloadClassifierProperties{
	// 		Context: to.Ptr("test_context"),
	// 		EndTime: to.Ptr("14:00"),
	// 		Importance: to.Ptr("high"),
	// 		Label: to.Ptr("test_label"),
	// 		MemberName: to.Ptr("dbo"),
	// 		StartTime: to.Ptr("12:00"),
	// 	},
	// }
}

Output:
Example (CreateAWorkloadClassifierWithTheRequiredPropertiesSpecified)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolWorkloadClassifierMin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolWorkloadClassifierClient().BeginCreateOrUpdate(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", "wlm_workloadgroup", "wlm_workloadclassifier", armsynapse.WorkloadClassifier{
		Properties: &armsynapse.WorkloadClassifierProperties{
			MemberName: to.Ptr("dbo"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkloadClassifier = armsynapse.WorkloadClassifier{
	// 	Name: to.Ptr("wlm_workloadclassifier"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_workloadclassifier"),
	// 	Properties: &armsynapse.WorkloadClassifierProperties{
	// 		Context: to.Ptr(""),
	// 		EndTime: to.Ptr(""),
	// 		Importance: to.Ptr(""),
	// 		Label: to.Ptr(""),
	// 		MemberName: to.Ptr("dbo"),
	// 		StartTime: to.Ptr(""),
	// 	},
	// }
}

Output:

func (*SQLPoolWorkloadClassifierClient) BeginDelete 

func (client *SQLPoolWorkloadClassifierClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, workloadGroupName string, workloadClassifierName string, options *SQLPoolWorkloadClassifierClientBeginDeleteOptions) (*runtime.Poller[SQLPoolWorkloadClassifierClientDeleteResponse], error)

BeginDelete - Remove workload classifier of a Sql pool's workload group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • workloadGroupName - The name of the workload group.
  • workloadClassifierName - The name of the workload classifier.
  • options - SQLPoolWorkloadClassifierClientBeginDeleteOptions contains the optional parameters for the SQLPoolWorkloadClassifierClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteSqlPoolWorkloadGroupWorkloadClassifer.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolWorkloadClassifierClient().BeginDelete(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", "wlm_workloadgroup", "wlm_workloadclassifier", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*SQLPoolWorkloadClassifierClient) Get 

func (client *SQLPoolWorkloadClassifierClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, workloadGroupName string, workloadClassifierName string, options *SQLPoolWorkloadClassifierClientGetOptions) (SQLPoolWorkloadClassifierClientGetResponse, error)

Get - Get a workload classifier of Sql pool's workload group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • workloadGroupName - The name of the workload group.
  • workloadClassifierName - The name of the workload classifier.
  • options - SQLPoolWorkloadClassifierClientGetOptions contains the optional parameters for the SQLPoolWorkloadClassifierClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolWorkloadGroupWorkloadClassifier.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolWorkloadClassifierClient().Get(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", "wlm_workloadgroup", "wlm_classifier", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkloadClassifier = armsynapse.WorkloadClassifier{
	// 	Name: to.Ptr("wlm_classifier"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_classifier"),
	// 	Properties: &armsynapse.WorkloadClassifierProperties{
	// 		Context: to.Ptr("test_context"),
	// 		EndTime: to.Ptr("14:00"),
	// 		Importance: to.Ptr("high"),
	// 		Label: to.Ptr("test_label"),
	// 		MemberName: to.Ptr("dbo"),
	// 		StartTime: to.Ptr("12:00"),
	// 	},
	// }
}

Output:

func (*SQLPoolWorkloadClassifierClient) NewListPager added in v0.4.0 

func (client *SQLPoolWorkloadClassifierClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, workloadGroupName string, options *SQLPoolWorkloadClassifierClientListOptions) *runtime.Pager[SQLPoolWorkloadClassifierClientListResponse]

NewListPager - Get list of Sql pool's workload classifier for workload groups.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • workloadGroupName - The name of the workload group.
  • options - SQLPoolWorkloadClassifierClientListOptions contains the optional parameters for the SQLPoolWorkloadClassifierClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolWorkloadGroupWorkloadClassifierList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolWorkloadClassifierClient().NewListPager("sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", "wlm_workloadgroup", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.WorkloadClassifierListResult = armsynapse.WorkloadClassifierListResult{
		// 	Value: []*armsynapse.WorkloadClassifier{
		// 		{
		// 			Name: to.Ptr("classifier3"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/classifier3"),
		// 			Properties: &armsynapse.WorkloadClassifierProperties{
		// 				Context: to.Ptr(""),
		// 				EndTime: to.Ptr(""),
		// 				Importance: to.Ptr("high"),
		// 				Label: to.Ptr(""),
		// 				MemberName: to.Ptr("dbo"),
		// 				StartTime: to.Ptr(""),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("classifier1"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/classifier1"),
		// 			Properties: &armsynapse.WorkloadClassifierProperties{
		// 				Context: to.Ptr("test_context"),
		// 				EndTime: to.Ptr("14:00"),
		// 				Importance: to.Ptr("high"),
		// 				Label: to.Ptr("test_label"),
		// 				MemberName: to.Ptr("dbo"),
		// 				StartTime: to.Ptr("12:00"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("classifier2"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/classifier2"),
		// 			Properties: &armsynapse.WorkloadClassifierProperties{
		// 				Context: to.Ptr(""),
		// 				EndTime: to.Ptr("17:00"),
		// 				Importance: to.Ptr("high"),
		// 				Label: to.Ptr(""),
		// 				MemberName: to.Ptr("dbo"),
		// 				StartTime: to.Ptr("11:00"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type SQLPoolWorkloadClassifierClientBeginCreateOrUpdateOptions added in v0.2.0 

type SQLPoolWorkloadClassifierClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolWorkloadClassifierClientBeginCreateOrUpdateOptions contains the optional parameters for the SQLPoolWorkloadClassifierClient.BeginCreateOrUpdate method.

type SQLPoolWorkloadClassifierClientBeginDeleteOptions added in v0.2.0 

type SQLPoolWorkloadClassifierClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolWorkloadClassifierClientBeginDeleteOptions contains the optional parameters for the SQLPoolWorkloadClassifierClient.BeginDelete method.

type SQLPoolWorkloadClassifierClientCreateOrUpdateResponse added in v0.2.0 

type SQLPoolWorkloadClassifierClientCreateOrUpdateResponse struct {
	// Workload classifier operations for a data warehouse
	WorkloadClassifier
}

SQLPoolWorkloadClassifierClientCreateOrUpdateResponse contains the response from method SQLPoolWorkloadClassifierClient.BeginCreateOrUpdate.

type SQLPoolWorkloadClassifierClientDeleteResponse added in v0.2.0 

type SQLPoolWorkloadClassifierClientDeleteResponse struct {
}

SQLPoolWorkloadClassifierClientDeleteResponse contains the response from method SQLPoolWorkloadClassifierClient.BeginDelete.

type SQLPoolWorkloadClassifierClientGetOptions added in v0.2.0 

type SQLPoolWorkloadClassifierClientGetOptions struct {
}

SQLPoolWorkloadClassifierClientGetOptions contains the optional parameters for the SQLPoolWorkloadClassifierClient.Get method.

type SQLPoolWorkloadClassifierClientGetResponse added in v0.2.0 

type SQLPoolWorkloadClassifierClientGetResponse struct {
	// Workload classifier operations for a data warehouse
	WorkloadClassifier
}

SQLPoolWorkloadClassifierClientGetResponse contains the response from method SQLPoolWorkloadClassifierClient.Get.

type SQLPoolWorkloadClassifierClientListOptions added in v0.2.0 

type SQLPoolWorkloadClassifierClientListOptions struct {
}

SQLPoolWorkloadClassifierClientListOptions contains the optional parameters for the SQLPoolWorkloadClassifierClient.NewListPager method.

type SQLPoolWorkloadClassifierClientListResponse added in v0.2.0 

type SQLPoolWorkloadClassifierClientListResponse struct {
	// A list of workload classifiers for a workload group.
	WorkloadClassifierListResult
}

SQLPoolWorkloadClassifierClientListResponse contains the response from method SQLPoolWorkloadClassifierClient.NewListPager.

type SQLPoolWorkloadGroupClient 

type SQLPoolWorkloadGroupClient struct {
	// contains filtered or unexported fields
}

SQLPoolWorkloadGroupClient contains the methods for the SQLPoolWorkloadGroup group. Don't use this type directly, use NewSQLPoolWorkloadGroupClient() instead.

func NewSQLPoolWorkloadGroupClient 

func NewSQLPoolWorkloadGroupClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolWorkloadGroupClient, error)

NewSQLPoolWorkloadGroupClient creates a new instance of SQLPoolWorkloadGroupClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolWorkloadGroupClient) BeginCreateOrUpdate 

func (client *SQLPoolWorkloadGroupClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, workloadGroupName string, parameters WorkloadGroup, options *SQLPoolWorkloadGroupClientBeginCreateOrUpdateOptions) (*runtime.Poller[SQLPoolWorkloadGroupClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create Or Update a Sql pool's workload group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • workloadGroupName - The name of the workload group.
  • parameters - The requested workload group state.
  • options - SQLPoolWorkloadGroupClientBeginCreateOrUpdateOptions contains the optional parameters for the SQLPoolWorkloadGroupClient.BeginCreateOrUpdate method.
Example (CreateAWorkloadGroupWithAllPropertiesSpecified)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolWorkloadGroupMax.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolWorkloadGroupClient().BeginCreateOrUpdate(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", "smallrc", armsynapse.WorkloadGroup{
		Properties: &armsynapse.WorkloadGroupProperties{
			Importance:                   to.Ptr("normal"),
			MaxResourcePercent:           to.Ptr[int32](100),
			MaxResourcePercentPerRequest: to.Ptr[float64](3),
			MinResourcePercent:           to.Ptr[int32](0),
			MinResourcePercentPerRequest: to.Ptr[float64](3),
			QueryExecutionTimeout:        to.Ptr[int32](0),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkloadGroup = armsynapse.WorkloadGroup{
	// 	Name: to.Ptr("smallrc"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/workloadGroups/smallrc"),
	// 	Properties: &armsynapse.WorkloadGroupProperties{
	// 		Importance: to.Ptr("normal"),
	// 		MaxResourcePercent: to.Ptr[int32](100),
	// 		MaxResourcePercentPerRequest: to.Ptr[float64](3),
	// 		MinResourcePercent: to.Ptr[int32](0),
	// 		MinResourcePercentPerRequest: to.Ptr[float64](3),
	// 		QueryExecutionTimeout: to.Ptr[int32](0),
	// 	},
	// }
}

Output:
Example (CreateAWorkloadGroupWithTheRequiredPropertiesSpecified)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateSqlPoolWorkloadGroupMin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolWorkloadGroupClient().BeginCreateOrUpdate(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", "smallrc", armsynapse.WorkloadGroup{
		Properties: &armsynapse.WorkloadGroupProperties{
			MaxResourcePercent:           to.Ptr[int32](100),
			MinResourcePercent:           to.Ptr[int32](0),
			MinResourcePercentPerRequest: to.Ptr[float64](3),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkloadGroup = armsynapse.WorkloadGroup{
	// 	Name: to.Ptr("smallrc"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/workloadGroups/smallrc"),
	// 	Properties: &armsynapse.WorkloadGroupProperties{
	// 		Importance: to.Ptr("normal"),
	// 		MaxResourcePercent: to.Ptr[int32](100),
	// 		MaxResourcePercentPerRequest: to.Ptr[float64](3),
	// 		MinResourcePercent: to.Ptr[int32](0),
	// 		MinResourcePercentPerRequest: to.Ptr[float64](3),
	// 		QueryExecutionTimeout: to.Ptr[int32](0),
	// 	},
	// }
}

Output:

func (*SQLPoolWorkloadGroupClient) BeginDelete 

func (client *SQLPoolWorkloadGroupClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, workloadGroupName string, options *SQLPoolWorkloadGroupClientBeginDeleteOptions) (*runtime.Poller[SQLPoolWorkloadGroupClientDeleteResponse], error)

BeginDelete - Remove Sql pool's workload group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • workloadGroupName - The name of the workload group.
  • options - SQLPoolWorkloadGroupClientBeginDeleteOptions contains the optional parameters for the SQLPoolWorkloadGroupClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteSqlPoolWorkloadGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolWorkloadGroupClient().BeginDelete(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", "wlm_workloadgroup", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*SQLPoolWorkloadGroupClient) Get 

func (client *SQLPoolWorkloadGroupClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, workloadGroupName string, options *SQLPoolWorkloadGroupClientGetOptions) (SQLPoolWorkloadGroupClientGetResponse, error)

Get - Get a Sql pool's workload group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • workloadGroupName - The name of the workload group.
  • options - SQLPoolWorkloadGroupClientGetOptions contains the optional parameters for the SQLPoolWorkloadGroupClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolWorkloadGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolWorkloadGroupClient().Get(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", "smallrc", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkloadGroup = armsynapse.WorkloadGroup{
	// 	Name: to.Ptr("smallrc"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/smallrc"),
	// 	Properties: &armsynapse.WorkloadGroupProperties{
	// 		Importance: to.Ptr("normal"),
	// 		MaxResourcePercent: to.Ptr[int32](100),
	// 		MaxResourcePercentPerRequest: to.Ptr[float64](3),
	// 		MinResourcePercent: to.Ptr[int32](0),
	// 		MinResourcePercentPerRequest: to.Ptr[float64](3),
	// 		QueryExecutionTimeout: to.Ptr[int32](0),
	// 	},
	// }
}

Output:

func (*SQLPoolWorkloadGroupClient) NewListPager added in v0.4.0 

func (client *SQLPoolWorkloadGroupClient) NewListPager(resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolWorkloadGroupClientListOptions) *runtime.Pager[SQLPoolWorkloadGroupClientListResponse]

NewListPager - Get list of Sql pool's workload groups.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolWorkloadGroupClientListOptions contains the optional parameters for the SQLPoolWorkloadGroupClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPoolWorkloadGroupList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolWorkloadGroupClient().NewListPager("sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.WorkloadGroupListResult = armsynapse.WorkloadGroupListResult{
		// 	Value: []*armsynapse.WorkloadGroup{
		// 		{
		// 			Name: to.Ptr("smallrc"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/smallrc"),
		// 			Properties: &armsynapse.WorkloadGroupProperties{
		// 				Importance: to.Ptr("normal"),
		// 				MaxResourcePercent: to.Ptr[int32](100),
		// 				MaxResourcePercentPerRequest: to.Ptr[float64](5),
		// 				MinResourcePercent: to.Ptr[int32](0),
		// 				MinResourcePercentPerRequest: to.Ptr[float64](5),
		// 				QueryExecutionTimeout: to.Ptr[int32](0),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("mediumrc"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/mediumrc"),
		// 			Properties: &armsynapse.WorkloadGroupProperties{
		// 				Importance: to.Ptr("normal"),
		// 				MaxResourcePercent: to.Ptr[int32](100),
		// 				MaxResourcePercentPerRequest: to.Ptr[float64](10),
		// 				MinResourcePercent: to.Ptr[int32](0),
		// 				MinResourcePercentPerRequest: to.Ptr[float64](10),
		// 				QueryExecutionTimeout: to.Ptr[int32](0),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("largerc"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/workloadGroups"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/largerc"),
		// 			Properties: &armsynapse.WorkloadGroupProperties{
		// 				Importance: to.Ptr("high"),
		// 				MaxResourcePercent: to.Ptr[int32](100),
		// 				MaxResourcePercentPerRequest: to.Ptr[float64](20),
		// 				MinResourcePercent: to.Ptr[int32](0),
		// 				MinResourcePercentPerRequest: to.Ptr[float64](20),
		// 				QueryExecutionTimeout: to.Ptr[int32](0),
		// 			},
		// 	}},
		// }
	}
}

Output:

type SQLPoolWorkloadGroupClientBeginCreateOrUpdateOptions added in v0.2.0 

type SQLPoolWorkloadGroupClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolWorkloadGroupClientBeginCreateOrUpdateOptions contains the optional parameters for the SQLPoolWorkloadGroupClient.BeginCreateOrUpdate method.

type SQLPoolWorkloadGroupClientBeginDeleteOptions added in v0.2.0 

type SQLPoolWorkloadGroupClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolWorkloadGroupClientBeginDeleteOptions contains the optional parameters for the SQLPoolWorkloadGroupClient.BeginDelete method.

type SQLPoolWorkloadGroupClientCreateOrUpdateResponse added in v0.2.0 

type SQLPoolWorkloadGroupClientCreateOrUpdateResponse struct {
	// Workload group operations for a sql pool
	WorkloadGroup
}

SQLPoolWorkloadGroupClientCreateOrUpdateResponse contains the response from method SQLPoolWorkloadGroupClient.BeginCreateOrUpdate.

type SQLPoolWorkloadGroupClientDeleteResponse added in v0.2.0 

type SQLPoolWorkloadGroupClientDeleteResponse struct {
}

SQLPoolWorkloadGroupClientDeleteResponse contains the response from method SQLPoolWorkloadGroupClient.BeginDelete.

type SQLPoolWorkloadGroupClientGetOptions added in v0.2.0 

type SQLPoolWorkloadGroupClientGetOptions struct {
}

SQLPoolWorkloadGroupClientGetOptions contains the optional parameters for the SQLPoolWorkloadGroupClient.Get method.

type SQLPoolWorkloadGroupClientGetResponse added in v0.2.0 

type SQLPoolWorkloadGroupClientGetResponse struct {
	// Workload group operations for a sql pool
	WorkloadGroup
}

SQLPoolWorkloadGroupClientGetResponse contains the response from method SQLPoolWorkloadGroupClient.Get.

type SQLPoolWorkloadGroupClientListOptions added in v0.2.0 

type SQLPoolWorkloadGroupClientListOptions struct {
}

SQLPoolWorkloadGroupClientListOptions contains the optional parameters for the SQLPoolWorkloadGroupClient.NewListPager method.

type SQLPoolWorkloadGroupClientListResponse added in v0.2.0 

type SQLPoolWorkloadGroupClientListResponse struct {
	// A list of workload groups.
	WorkloadGroupListResult
}

SQLPoolWorkloadGroupClientListResponse contains the response from method SQLPoolWorkloadGroupClient.NewListPager.

type SQLPoolsClient 

type SQLPoolsClient struct {
	// contains filtered or unexported fields
}

SQLPoolsClient contains the methods for the SQLPools group. Don't use this type directly, use NewSQLPoolsClient() instead.

func NewSQLPoolsClient 

func NewSQLPoolsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLPoolsClient, error)

NewSQLPoolsClient creates a new instance of SQLPoolsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLPoolsClient) BeginCreate 

func (client *SQLPoolsClient) BeginCreate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, sqlPoolInfo SQLPool, options *SQLPoolsClientBeginCreateOptions) (*runtime.Poller[SQLPoolsClientCreateResponse], error)

BeginCreate - Create a SQL pool If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • sqlPoolInfo - The SQL pool to create
  • options - SQLPoolsClientBeginCreateOptions contains the optional parameters for the SQLPoolsClient.BeginCreate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateSqlPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolsClient().BeginCreate(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExampleSqlPool", armsynapse.SQLPool{
		Location: to.Ptr("Southeast Asia"),
		Tags:     map[string]*string{},
		Properties: &armsynapse.SQLPoolResourceProperties{
			Collation:             to.Ptr(""),
			CreateMode:            to.Ptr(armsynapse.CreateMode("")),
			MaxSizeBytes:          to.Ptr[int64](0),
			RecoverableDatabaseID: to.Ptr(""),
			SourceDatabaseID:      to.Ptr(""),
			StorageAccountType:    to.Ptr(armsynapse.StorageAccountTypeLRS),
		},
		SKU: &armsynapse.SKU{
			Name: to.Ptr(""),
			Tier: to.Ptr(""),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPool = armsynapse.SQLPool{
	// 	Name: to.Ptr("ExampleSqlPool"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspaces/sqlPools/ExampleSqlPool"),
	// 	Location: to.Ptr("Southeast Asia"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armsynapse.SQLPoolResourceProperties{
	// 		Collation: to.Ptr(""),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		MaxSizeBytes: to.Ptr[int64](0),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		RecoverableDatabaseID: to.Ptr(""),
	// 		RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		Status: to.Ptr("Paused"),
	// 		StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeLRS),
	// 	},
	// 	SKU: &armsynapse.SKU{
	// 		Name: to.Ptr(""),
	// 		Tier: to.Ptr(""),
	// 	},
	// }
}

Output:

func (*SQLPoolsClient) BeginDelete 

func (client *SQLPoolsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolsClientBeginDeleteOptions) (*runtime.Poller[SQLPoolsClientDeleteResponse], error)

BeginDelete - Delete a SQL pool If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolsClientBeginDeleteOptions contains the optional parameters for the SQLPoolsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteSqlPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolsClient().BeginDelete(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExampleSqlPool", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPool = armsynapse.SQLPool{
	// 	Name: to.Ptr("ExampleSqlPool"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/sqlPools/ExampleSqlPool"),
	// 	Location: to.Ptr("West US 2"),
	// 	Properties: &armsynapse.SQLPoolResourceProperties{
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		Status: to.Ptr("Paused"),
	// 	},
	// }
}

Output:

func (*SQLPoolsClient) BeginPause 

func (client *SQLPoolsClient) BeginPause(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolsClientBeginPauseOptions) (*runtime.Poller[SQLPoolsClientPauseResponse], error)

BeginPause - Pause a SQL pool If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolsClientBeginPauseOptions contains the optional parameters for the SQLPoolsClient.BeginPause method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/PauseSqlPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolsClient().BeginPause(ctx, "Default-SQL-SouthEastAsia", "testsvr", "testdwdb", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPool = armsynapse.SQLPool{
	// 	Name: to.Ptr("testdwdb"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/testdwdb"),
	// 	Location: to.Ptr("Japan East"),
	// 	Tags: map[string]*string{
	// 		"tagKey1": to.Ptr("TagValue1"),
	// 	},
	// 	Properties: &armsynapse.SQLPoolResourceProperties{
	// 		Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:56:19.200Z"); return t}()),
	// 		MaxSizeBytes: to.Ptr[int64](268435456000),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
	// 		Status: to.Ptr("Online"),
	// 	},
	// 	SKU: &armsynapse.SKU{
	// 		Name: to.Ptr("DW100c"),
	// 	},
	// }
}

Output:

func (*SQLPoolsClient) BeginResume 

func (client *SQLPoolsClient) BeginResume(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolsClientBeginResumeOptions) (*runtime.Poller[SQLPoolsClientResumeResponse], error)

BeginResume - Resume a SQL pool If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolsClientBeginResumeOptions contains the optional parameters for the SQLPoolsClient.BeginResume method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ResumeSqlPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolsClient().BeginResume(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPool = armsynapse.SQLPool{
	// 	Name: to.Ptr("sqlcrudtest-9187"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187"),
	// 	Location: to.Ptr("Japan East"),
	// 	Tags: map[string]*string{
	// 		"tagKey1": to.Ptr("TagValue1"),
	// 	},
	// 	Properties: &armsynapse.SQLPoolResourceProperties{
	// 		Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:56:19.200Z"); return t}()),
	// 		MaxSizeBytes: to.Ptr[int64](268435456000),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
	// 		Status: to.Ptr("Online"),
	// 	},
	// 	SKU: &armsynapse.SKU{
	// 		Name: to.Ptr("DW100c"),
	// 	},
	// }
}

Output:

func (*SQLPoolsClient) BeginUpdate added in v0.6.0 

func (client *SQLPoolsClient) BeginUpdate(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, sqlPoolInfo SQLPoolPatchInfo, options *SQLPoolsClientBeginUpdateOptions) (*runtime.Poller[SQLPoolsClientUpdateResponse], error)

BeginUpdate - Apply a partial update to a SQL pool If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • sqlPoolInfo - The updated SQL pool properties
  • options - SQLPoolsClientBeginUpdateOptions contains the optional parameters for the SQLPoolsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdateSqlPool.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolsClient().BeginUpdate(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExampleSqlPool", armsynapse.SQLPoolPatchInfo{
		Location: to.Ptr("West US 2"),
		Properties: &armsynapse.SQLPoolResourceProperties{
			Collation:          to.Ptr(""),
			MaxSizeBytes:       to.Ptr[int64](0),
			RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t }()),
		},
		SKU: &armsynapse.SKU{
			Name: to.Ptr(""),
			Tier: to.Ptr(""),
		},
		Tags: map[string]*string{},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPool = armsynapse.SQLPool{
	// 	Name: to.Ptr("ExampleSqlPool"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspaces/sqlPools/ExampleSqlPool"),
	// 	Location: to.Ptr("West US 2"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armsynapse.SQLPoolResourceProperties{
	// 		Collation: to.Ptr(""),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		MaxSizeBytes: to.Ptr[int64](0),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		RecoverableDatabaseID: to.Ptr(""),
	// 		RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		Status: to.Ptr("Paused"),
	// 		StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
	// 	},
	// 	SKU: &armsynapse.SKU{
	// 		Name: to.Ptr(""),
	// 		Tier: to.Ptr(""),
	// 	},
	// }
}

Output:

func (*SQLPoolsClient) Get 

func (client *SQLPoolsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, options *SQLPoolsClientGetOptions) (SQLPoolsClientGetResponse, error)

Get - Get SQL pool properties If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • options - SQLPoolsClientGetOptions contains the optional parameters for the SQLPoolsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetSqlPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLPoolsClient().Get(ctx, "sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-9187", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPool = armsynapse.SQLPool{
	// 	Name: to.Ptr("sqlcrudtest-9187"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187"),
	// 	Location: to.Ptr("Japan East"),
	// 	Tags: map[string]*string{
	// 		"tagKey1": to.Ptr("TagValue1"),
	// 	},
	// 	Properties: &armsynapse.SQLPoolResourceProperties{
	// 		Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:56:19.200Z"); return t}()),
	// 		MaxSizeBytes: to.Ptr[int64](268435456000),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
	// 		Status: to.Ptr("Online"),
	// 		StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
	// 	},
	// 	SKU: &armsynapse.SKU{
	// 		Name: to.Ptr("DW100c"),
	// 	},
	// }
}

Output:

func (*SQLPoolsClient) NewListByWorkspacePager added in v0.4.0 

func (client *SQLPoolsClient) NewListByWorkspacePager(resourceGroupName string, workspaceName string, options *SQLPoolsClientListByWorkspaceOptions) *runtime.Pager[SQLPoolsClientListByWorkspaceResponse]

NewListByWorkspacePager - List all SQL pools

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - SQLPoolsClientListByWorkspaceOptions contains the optional parameters for the SQLPoolsClient.NewListByWorkspacePager method.
Example (ListSqlAnalyticsPoolsInAWorkspace)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolsInWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolsClient().NewListByWorkspacePager("sqlcrudtest-6845", "sqlcrudtest-7177", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLPoolInfoListResult = armsynapse.SQLPoolInfoListResult{
		// 	Value: []*armsynapse.SQLPool{
		// 		{
		// 			Name: to.Ptr("master"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/master"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:59:33.483Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](32212254720),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("GP_Gen5_2"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("sqlcrudtest-1142"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-1142"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T01:03:34.040Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](268435456000),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("DW100c"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("sqlcrudtest-2788"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-2788"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T01:00:21.067Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](268435456000),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("DW100c"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("sqlcrudtest-6877"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-6877"),
		// 			Location: to.Ptr("Southeast Asia"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T01:02:28.853Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](268435456000),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeLRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("DW100c"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("sqlcrudtest-9888"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-9888"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T01:01:25.347Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](268435456000),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("DW100c"),
		// 			},
		// 	}},
		// }
	}
}

Output:
Example (ListSqlAnalyticsPoolsInAWorkspaceWithFilter)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolsInWorkspaceWithFilter.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolsClient().NewListByWorkspacePager("sqlcrudtest-6845", "sqlcrudtest-7177", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLPoolInfoListResult = armsynapse.SQLPoolInfoListResult{
		// 	Value: []*armsynapse.SQLPool{
		// 		{
		// 			Name: to.Ptr("master"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/master"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.SQLPoolResourceProperties{
		// 				Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T00:59:33.483Z"); return t}()),
		// 				MaxSizeBytes: to.Ptr[int64](32212254720),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
		// 				Status: to.Ptr("Online"),
		// 				StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
		// 			},
		// 			SKU: &armsynapse.SKU{
		// 				Name: to.Ptr("GP_Gen5_2"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*SQLPoolsClient) Rename 

func (client *SQLPoolsClient) Rename(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, parameters ResourceMoveDefinition, options *SQLPoolsClientRenameOptions) (SQLPoolsClientRenameResponse, error)

Rename - Rename a SQL pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - SQL pool name
  • parameters - The resource move definition for renaming this Sql pool.
  • options - SQLPoolsClientRenameOptions contains the optional parameters for the SQLPoolsClient.Rename method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/RenameSqlPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSQLPoolsClient().Rename(ctx, "Default-SQL-SouthEastAsia", "testsvr", "testdb", armsynapse.ResourceMoveDefinition{
		ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/newtestdb"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type SQLPoolsClientBeginCreateOptions added in v0.2.0 

type SQLPoolsClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolsClientBeginCreateOptions contains the optional parameters for the SQLPoolsClient.BeginCreate method.

type SQLPoolsClientBeginDeleteOptions added in v0.2.0 

type SQLPoolsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolsClientBeginDeleteOptions contains the optional parameters for the SQLPoolsClient.BeginDelete method.

type SQLPoolsClientBeginPauseOptions added in v0.2.0 

type SQLPoolsClientBeginPauseOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolsClientBeginPauseOptions contains the optional parameters for the SQLPoolsClient.BeginPause method.

type SQLPoolsClientBeginResumeOptions added in v0.2.0 

type SQLPoolsClientBeginResumeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolsClientBeginResumeOptions contains the optional parameters for the SQLPoolsClient.BeginResume method.

type SQLPoolsClientBeginUpdateOptions added in v0.6.0 

type SQLPoolsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLPoolsClientBeginUpdateOptions contains the optional parameters for the SQLPoolsClient.BeginUpdate method.

type SQLPoolsClientCreateResponse added in v0.2.0 

type SQLPoolsClientCreateResponse struct {
	// A SQL Analytics pool
	SQLPool
}

SQLPoolsClientCreateResponse contains the response from method SQLPoolsClient.BeginCreate.

type SQLPoolsClientDeleteResponse added in v0.2.0 

type SQLPoolsClientDeleteResponse struct {
	// A SQL Analytics pool
	SQLPool
}

SQLPoolsClientDeleteResponse contains the response from method SQLPoolsClient.BeginDelete.

type SQLPoolsClientGetOptions added in v0.2.0 

type SQLPoolsClientGetOptions struct {
}

SQLPoolsClientGetOptions contains the optional parameters for the SQLPoolsClient.Get method.

type SQLPoolsClientGetResponse added in v0.2.0 

type SQLPoolsClientGetResponse struct {
	// A SQL Analytics pool
	SQLPool
}

SQLPoolsClientGetResponse contains the response from method SQLPoolsClient.Get.

type SQLPoolsClientListByWorkspaceOptions added in v0.2.0 

type SQLPoolsClientListByWorkspaceOptions struct {
}

SQLPoolsClientListByWorkspaceOptions contains the optional parameters for the SQLPoolsClient.NewListByWorkspacePager method.

type SQLPoolsClientListByWorkspaceResponse added in v0.2.0 

type SQLPoolsClientListByWorkspaceResponse struct {
	// List of SQL pools
	SQLPoolInfoListResult
}

SQLPoolsClientListByWorkspaceResponse contains the response from method SQLPoolsClient.NewListByWorkspacePager.

type SQLPoolsClientPauseResponse added in v0.2.0 

type SQLPoolsClientPauseResponse struct {
	// A SQL Analytics pool
	SQLPool
}

SQLPoolsClientPauseResponse contains the response from method SQLPoolsClient.BeginPause.

type SQLPoolsClientRenameOptions added in v0.2.0 

type SQLPoolsClientRenameOptions struct {
}

SQLPoolsClientRenameOptions contains the optional parameters for the SQLPoolsClient.Rename method.

type SQLPoolsClientRenameResponse added in v0.2.0 

type SQLPoolsClientRenameResponse struct {
}

SQLPoolsClientRenameResponse contains the response from method SQLPoolsClient.Rename.

type SQLPoolsClientResumeResponse added in v0.2.0 

type SQLPoolsClientResumeResponse struct {
	// A SQL Analytics pool
	SQLPool
}

SQLPoolsClientResumeResponse contains the response from method SQLPoolsClient.BeginResume.

type SQLPoolsClientUpdateResponse added in v0.2.0 

type SQLPoolsClientUpdateResponse struct {
	// A SQL Analytics pool
	SQLPool
}

SQLPoolsClientUpdateResponse contains the response from method SQLPoolsClient.BeginUpdate.

type SecretBase 

type SecretBase struct {
	// REQUIRED; Type of the secret.
	Type *string
}

SecretBase - The base definition of a secret type.

func (*SecretBase) GetSecretBase 

func (s *SecretBase) GetSecretBase() *SecretBase

GetSecretBase implements the SecretBaseClassification interface for type SecretBase.

func (SecretBase) MarshalJSON added in v0.6.0 

func (s SecretBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecretBase.

func (*SecretBase) UnmarshalJSON 

func (s *SecretBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecretBase.

type SecretBaseClassification 

type SecretBaseClassification interface {
	// GetSecretBase returns the SecretBase content of the underlying type.
	GetSecretBase() *SecretBase
}

SecretBaseClassification provides polymorphic access to related types. Call the interface's GetSecretBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *SecretBase, *SecureString

type SecureString 

type SecureString struct {
	// REQUIRED; Type of the secret.
	Type *string

	// REQUIRED; Value of secure string.
	Value *string
}

SecureString - Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.

func (*SecureString) GetSecretBase added in v0.2.0 

func (s *SecureString) GetSecretBase() *SecretBase

GetSecretBase implements the SecretBaseClassification interface for type SecureString.

func (SecureString) MarshalJSON 

func (s SecureString) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecureString.

func (*SecureString) UnmarshalJSON 

func (s *SecureString) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecureString.

type SecurityAlertPolicyName 

type SecurityAlertPolicyName string
const (
	SecurityAlertPolicyNameDefault SecurityAlertPolicyName = "default"
)

func PossibleSecurityAlertPolicyNameValues 

func PossibleSecurityAlertPolicyNameValues() []SecurityAlertPolicyName

PossibleSecurityAlertPolicyNameValues returns the possible values for the SecurityAlertPolicyName const type.

type SecurityAlertPolicyNameAutoGenerated 

type SecurityAlertPolicyNameAutoGenerated string
const (
	SecurityAlertPolicyNameAutoGeneratedDefault SecurityAlertPolicyNameAutoGenerated = "Default"
)

func PossibleSecurityAlertPolicyNameAutoGeneratedValues 

func PossibleSecurityAlertPolicyNameAutoGeneratedValues() []SecurityAlertPolicyNameAutoGenerated

PossibleSecurityAlertPolicyNameAutoGeneratedValues returns the possible values for the SecurityAlertPolicyNameAutoGenerated const type.

type SecurityAlertPolicyProperties 

type SecurityAlertPolicyProperties struct {
	// REQUIRED; Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on
	// the specific Sql pool.
	State *SecurityAlertPolicyState

	// Specifies an array of alerts that are disabled. Allowed values are: SqlInjection, SqlInjectionVulnerability, AccessAnomaly,
	// DataExfiltration, UnsafeAction
	DisabledAlerts []*string

	// Specifies that the alert is sent to the account administrators.
	EmailAccountAdmins *bool

	// Specifies an array of e-mail addresses to which the alert is sent.
	EmailAddresses []*string

	// Specifies the number of days to keep in the Threat Detection audit logs.
	RetentionDays *int32

	// Specifies the identifier key of the Threat Detection audit storage account.
	StorageAccountAccessKey *string

	// Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat
	// Detection audit logs.
	StorageEndpoint *string

	// READ-ONLY; Specifies the UTC creation time of the policy.
	CreationTime *time.Time
}

SecurityAlertPolicyProperties - Properties of a security alert policy.

func (SecurityAlertPolicyProperties) MarshalJSON 

func (s SecurityAlertPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityAlertPolicyProperties.

func (*SecurityAlertPolicyProperties) UnmarshalJSON 

func (s *SecurityAlertPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityAlertPolicyProperties.

type SecurityAlertPolicyState 

type SecurityAlertPolicyState string

SecurityAlertPolicyState - Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific Sql pool. 

const (
	SecurityAlertPolicyStateDisabled SecurityAlertPolicyState = "Disabled"
	SecurityAlertPolicyStateEnabled  SecurityAlertPolicyState = "Enabled"
	SecurityAlertPolicyStateNew      SecurityAlertPolicyState = "New"
)

func PossibleSecurityAlertPolicyStateValues 

func PossibleSecurityAlertPolicyStateValues() []SecurityAlertPolicyState

PossibleSecurityAlertPolicyStateValues returns the possible values for the SecurityAlertPolicyState const type.

type SelfHostedIntegrationRuntime 

type SelfHostedIntegrationRuntime struct {
	// REQUIRED; Type of integration runtime.
	Type *IntegrationRuntimeType

	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// Integration runtime description.
	Description *string

	// When this property is not null, means this is a linked integration runtime. The property is used to access original integration
	// runtime.
	TypeProperties *SelfHostedIntegrationRuntimeTypeProperties
}

SelfHostedIntegrationRuntime - Self-hosted integration runtime.

func (*SelfHostedIntegrationRuntime) GetIntegrationRuntime added in v0.2.0 

func (s *SelfHostedIntegrationRuntime) GetIntegrationRuntime() *IntegrationRuntime

GetIntegrationRuntime implements the IntegrationRuntimeClassification interface for type SelfHostedIntegrationRuntime.

func (SelfHostedIntegrationRuntime) MarshalJSON 

func (s SelfHostedIntegrationRuntime) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SelfHostedIntegrationRuntime.

func (*SelfHostedIntegrationRuntime) UnmarshalJSON 

func (s *SelfHostedIntegrationRuntime) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SelfHostedIntegrationRuntime.

type SelfHostedIntegrationRuntimeNode 

type SelfHostedIntegrationRuntimeNode struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// READ-ONLY; The integration runtime capabilities dictionary
	Capabilities map[string]*string

	// READ-ONLY; Maximum concurrent jobs on the integration runtime node.
	ConcurrentJobsLimit *int32

	// READ-ONLY; The time at which the integration runtime will expire in ISO8601 format.
	ExpiryTime *time.Time

	// READ-ONLY; URI for the host machine of the integration runtime.
	HostServiceURI *string

	// READ-ONLY; Indicates whether this node is the active dispatcher for integration runtime requests.
	IsActiveDispatcher *bool

	// READ-ONLY; The most recent time at which the integration runtime was connected in ISO8601 format.
	LastConnectTime *time.Time

	// READ-ONLY; The last time for the integration runtime node update end.
	LastEndUpdateTime *time.Time

	// READ-ONLY; The time the node last started up.
	LastStartTime *time.Time

	// READ-ONLY; The last time for the integration runtime node update start.
	LastStartUpdateTime *time.Time

	// READ-ONLY; The integration runtime node last stop time.
	LastStopTime *time.Time

	// READ-ONLY; The result of the last integration runtime node update.
	LastUpdateResult *IntegrationRuntimeUpdateResult

	// READ-ONLY; Machine name of the integration runtime node.
	MachineName *string

	// READ-ONLY; The maximum concurrent jobs in this integration runtime.
	MaxConcurrentJobs *int32

	// READ-ONLY; Name of the integration runtime node.
	NodeName *string

	// READ-ONLY; The time at which the integration runtime node was registered in ISO8601 format.
	RegisterTime *time.Time

	// READ-ONLY; Status of the integration runtime node.
	Status *SelfHostedIntegrationRuntimeNodeStatus

	// READ-ONLY; Version of the integration runtime node.
	Version *string

	// READ-ONLY; Status of the integration runtime node version.
	VersionStatus *string
}

SelfHostedIntegrationRuntimeNode - Properties of Self-hosted integration runtime node.

func (SelfHostedIntegrationRuntimeNode) MarshalJSON 

func (s SelfHostedIntegrationRuntimeNode) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SelfHostedIntegrationRuntimeNode.

func (*SelfHostedIntegrationRuntimeNode) UnmarshalJSON 

func (s *SelfHostedIntegrationRuntimeNode) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SelfHostedIntegrationRuntimeNode.

type SelfHostedIntegrationRuntimeNodeStatus 

type SelfHostedIntegrationRuntimeNodeStatus string

SelfHostedIntegrationRuntimeNodeStatus - Status of the integration runtime node. 

const (
	SelfHostedIntegrationRuntimeNodeStatusInitializeFailed SelfHostedIntegrationRuntimeNodeStatus = "InitializeFailed"
	SelfHostedIntegrationRuntimeNodeStatusInitializing     SelfHostedIntegrationRuntimeNodeStatus = "Initializing"
	SelfHostedIntegrationRuntimeNodeStatusLimited          SelfHostedIntegrationRuntimeNodeStatus = "Limited"
	SelfHostedIntegrationRuntimeNodeStatusNeedRegistration SelfHostedIntegrationRuntimeNodeStatus = "NeedRegistration"
	SelfHostedIntegrationRuntimeNodeStatusOffline          SelfHostedIntegrationRuntimeNodeStatus = "Offline"
	SelfHostedIntegrationRuntimeNodeStatusOnline           SelfHostedIntegrationRuntimeNodeStatus = "Online"
	SelfHostedIntegrationRuntimeNodeStatusUpgrading        SelfHostedIntegrationRuntimeNodeStatus = "Upgrading"
)

func PossibleSelfHostedIntegrationRuntimeNodeStatusValues 

func PossibleSelfHostedIntegrationRuntimeNodeStatusValues() []SelfHostedIntegrationRuntimeNodeStatus

PossibleSelfHostedIntegrationRuntimeNodeStatusValues returns the possible values for the SelfHostedIntegrationRuntimeNodeStatus const type.

type SelfHostedIntegrationRuntimeStatus 

type SelfHostedIntegrationRuntimeStatus struct {
	// REQUIRED; Type of integration runtime.
	Type *IntegrationRuntimeType

	// REQUIRED; Self-hosted integration runtime status type properties.
	TypeProperties *SelfHostedIntegrationRuntimeStatusTypeProperties

	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// READ-ONLY; The workspace name which the integration runtime belong to.
	DataFactoryName *string

	// READ-ONLY; The state of integration runtime.
	State *IntegrationRuntimeState
}

SelfHostedIntegrationRuntimeStatus - Self-hosted integration runtime status.

func (*SelfHostedIntegrationRuntimeStatus) GetIntegrationRuntimeStatus added in v0.2.0 

func (s *SelfHostedIntegrationRuntimeStatus) GetIntegrationRuntimeStatus() *IntegrationRuntimeStatus

GetIntegrationRuntimeStatus implements the IntegrationRuntimeStatusClassification interface for type SelfHostedIntegrationRuntimeStatus.

func (SelfHostedIntegrationRuntimeStatus) MarshalJSON 

func (s SelfHostedIntegrationRuntimeStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SelfHostedIntegrationRuntimeStatus.

func (*SelfHostedIntegrationRuntimeStatus) UnmarshalJSON 

func (s *SelfHostedIntegrationRuntimeStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SelfHostedIntegrationRuntimeStatus.

type SelfHostedIntegrationRuntimeStatusTypeProperties 

type SelfHostedIntegrationRuntimeStatusTypeProperties struct {
	// The list of linked integration runtimes that are created to share with this integration runtime.
	Links []*LinkedIntegrationRuntime

	// The newer versions on download center.
	NewerVersions []*string

	// The list of nodes for this integration runtime.
	Nodes []*SelfHostedIntegrationRuntimeNode

	// The service region of the integration runtime
	ServiceRegion *string

	// READ-ONLY; Whether Self-hosted integration runtime auto update has been turned on.
	AutoUpdate *IntegrationRuntimeAutoUpdate

	// READ-ONLY; The estimated time when the self-hosted integration runtime will be updated.
	AutoUpdateETA *time.Time

	// READ-ONLY; Object with additional information about integration runtime capabilities.
	Capabilities map[string]*string

	// READ-ONLY; The time at which the integration runtime was created, in ISO8601 format.
	CreateTime *time.Time

	// READ-ONLY; It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration
	// runtime nodes exist).
	InternalChannelEncryption *IntegrationRuntimeInternalChannelEncryptionMode

	// READ-ONLY; The latest version on download center.
	LatestVersion *string

	// READ-ONLY; The local time zone offset in hours.
	LocalTimeZoneOffset *string

	// READ-ONLY; The node communication Channel encryption mode
	NodeCommunicationChannelEncryptionMode *string

	// READ-ONLY; The version that the integration runtime is going to update to.
	PushedVersion *string

	// READ-ONLY; The date at which the integration runtime will be scheduled to update, in ISO8601 format.
	ScheduledUpdateDate *time.Time

	// READ-ONLY; The URLs for the services used in integration runtime backend service.
	ServiceUrls []*string

	// READ-ONLY; The task queue id of the integration runtime.
	TaskQueueID *string

	// READ-ONLY; The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours
	UpdateDelayOffset *string

	// READ-ONLY; Version of the integration runtime.
	Version *string

	// READ-ONLY; Status of the integration runtime version.
	VersionStatus *string
}

SelfHostedIntegrationRuntimeStatusTypeProperties - Self-hosted integration runtime status type properties.

func (SelfHostedIntegrationRuntimeStatusTypeProperties) MarshalJSON 

func (s SelfHostedIntegrationRuntimeStatusTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SelfHostedIntegrationRuntimeStatusTypeProperties.

func (*SelfHostedIntegrationRuntimeStatusTypeProperties) UnmarshalJSON 

func (s *SelfHostedIntegrationRuntimeStatusTypeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SelfHostedIntegrationRuntimeStatusTypeProperties.

type SelfHostedIntegrationRuntimeTypeProperties 

type SelfHostedIntegrationRuntimeTypeProperties struct {
	// Linked integration runtime type from data factory
	LinkedInfo LinkedIntegrationRuntimeTypeClassification
}

SelfHostedIntegrationRuntimeTypeProperties - The self-hosted integration runtime properties.

func (SelfHostedIntegrationRuntimeTypeProperties) MarshalJSON 

func (s SelfHostedIntegrationRuntimeTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SelfHostedIntegrationRuntimeTypeProperties.

func (*SelfHostedIntegrationRuntimeTypeProperties) UnmarshalJSON 

func (s *SelfHostedIntegrationRuntimeTypeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SelfHostedIntegrationRuntimeTypeProperties.

type SensitivityLabel 

type SensitivityLabel struct {
	// Resource properties.
	Properties *SensitivityLabelProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; managed by
	ManagedBy *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SensitivityLabel - A sensitivity label.

func (SensitivityLabel) MarshalJSON 

func (s SensitivityLabel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SensitivityLabel.

func (*SensitivityLabel) UnmarshalJSON 

func (s *SensitivityLabel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SensitivityLabel.

type SensitivityLabelListResult 

type SensitivityLabelListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*SensitivityLabel
}

SensitivityLabelListResult - A list of sensitivity labels.

func (SensitivityLabelListResult) MarshalJSON 

func (s SensitivityLabelListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SensitivityLabelListResult.

func (*SensitivityLabelListResult) UnmarshalJSON added in v0.6.0 

func (s *SensitivityLabelListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SensitivityLabelListResult.

type SensitivityLabelProperties 

type SensitivityLabelProperties struct {
	// The information type.
	InformationType *string

	// The information type ID.
	InformationTypeID *string

	// The label ID.
	LabelID *string

	// The label name.
	LabelName *string
	Rank      *SensitivityLabelRank

	// READ-ONLY; The column name.
	ColumnName *string

	// READ-ONLY; Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether
	// the sensitivity recommendation on this column is disabled (dismissed) or not.
	IsDisabled *bool

	// READ-ONLY; The schema name.
	SchemaName *string

	// READ-ONLY; The table name.
	TableName *string
}

SensitivityLabelProperties - Properties of a sensitivity label.

func (SensitivityLabelProperties) MarshalJSON added in v0.6.0 

func (s SensitivityLabelProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SensitivityLabelProperties.

func (*SensitivityLabelProperties) UnmarshalJSON added in v0.6.0 

func (s *SensitivityLabelProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SensitivityLabelProperties.

type SensitivityLabelRank 

type SensitivityLabelRank string
const (
	SensitivityLabelRankCritical SensitivityLabelRank = "Critical"
	SensitivityLabelRankHigh     SensitivityLabelRank = "High"
	SensitivityLabelRankLow      SensitivityLabelRank = "Low"
	SensitivityLabelRankMedium   SensitivityLabelRank = "Medium"
	SensitivityLabelRankNone     SensitivityLabelRank = "None"
)

func PossibleSensitivityLabelRankValues 

func PossibleSensitivityLabelRankValues() []SensitivityLabelRank

PossibleSensitivityLabelRankValues returns the possible values for the SensitivityLabelRank const type.

type SensitivityLabelSource 

type SensitivityLabelSource string
const (
	SensitivityLabelSourceCurrent     SensitivityLabelSource = "current"
	SensitivityLabelSourceRecommended SensitivityLabelSource = "recommended"
)

func PossibleSensitivityLabelSourceValues 

func PossibleSensitivityLabelSourceValues() []SensitivityLabelSource

PossibleSensitivityLabelSourceValues returns the possible values for the SensitivityLabelSource const type.

type SensitivityLabelUpdate 

type SensitivityLabelUpdate struct {
	// Resource properties.
	Properties *SensitivityLabelUpdateProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SensitivityLabelUpdate - A sensitivity label update operation.

func (SensitivityLabelUpdate) MarshalJSON 

func (s SensitivityLabelUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SensitivityLabelUpdate.

func (*SensitivityLabelUpdate) UnmarshalJSON 

func (s *SensitivityLabelUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SensitivityLabelUpdate.

type SensitivityLabelUpdateKind 

type SensitivityLabelUpdateKind string
const (
	SensitivityLabelUpdateKindRemove SensitivityLabelUpdateKind = "remove"
	SensitivityLabelUpdateKindSet    SensitivityLabelUpdateKind = "set"
)

func PossibleSensitivityLabelUpdateKindValues 

func PossibleSensitivityLabelUpdateKindValues() []SensitivityLabelUpdateKind

PossibleSensitivityLabelUpdateKindValues returns the possible values for the SensitivityLabelUpdateKind const type.

type SensitivityLabelUpdateList 

type SensitivityLabelUpdateList struct {
	Operations []*SensitivityLabelUpdate
}

SensitivityLabelUpdateList - A list of sensitivity label update operations.

func (SensitivityLabelUpdateList) MarshalJSON 

func (s SensitivityLabelUpdateList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SensitivityLabelUpdateList.

func (*SensitivityLabelUpdateList) UnmarshalJSON added in v0.6.0 

func (s *SensitivityLabelUpdateList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SensitivityLabelUpdateList.

type SensitivityLabelUpdateProperties 

type SensitivityLabelUpdateProperties struct {
	// REQUIRED; Column name to update.
	Column *string

	// REQUIRED
	Op *SensitivityLabelUpdateKind

	// REQUIRED; Schema name of the column to update.
	Schema *string

	// REQUIRED; Table name of the column to update.
	Table *string

	// The sensitivity label information to apply on a column.
	SensitivityLabel *SensitivityLabel
}

SensitivityLabelUpdateProperties - Properties of an operation executed on a sensitivity label.

func (SensitivityLabelUpdateProperties) MarshalJSON added in v0.6.0 

func (s SensitivityLabelUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SensitivityLabelUpdateProperties.

func (*SensitivityLabelUpdateProperties) UnmarshalJSON added in v0.6.0 

func (s *SensitivityLabelUpdateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SensitivityLabelUpdateProperties.

type ServerBlobAuditingPolicy 

type ServerBlobAuditingPolicy struct {
	// Resource properties.
	Properties *ServerBlobAuditingPolicyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ServerBlobAuditingPolicy - A server blob auditing policy.

func (ServerBlobAuditingPolicy) MarshalJSON 

func (s ServerBlobAuditingPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServerBlobAuditingPolicy.

func (*ServerBlobAuditingPolicy) UnmarshalJSON 

func (s *ServerBlobAuditingPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerBlobAuditingPolicy.

type ServerBlobAuditingPolicyListResult 

type ServerBlobAuditingPolicyListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*ServerBlobAuditingPolicy
}

ServerBlobAuditingPolicyListResult - A list of server auditing settings.

func (ServerBlobAuditingPolicyListResult) MarshalJSON 

func (s ServerBlobAuditingPolicyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServerBlobAuditingPolicyListResult.

func (*ServerBlobAuditingPolicyListResult) UnmarshalJSON added in v0.6.0 

func (s *ServerBlobAuditingPolicyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerBlobAuditingPolicyListResult.

type ServerBlobAuditingPolicyProperties 

type ServerBlobAuditingPolicyProperties struct {
	// REQUIRED; Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.
	State *BlobAuditingPolicyState

	// Specifies the Actions-Groups and Actions to audit.
	// The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures
	// executed against the database, as well as successful and failed logins:
	// BATCHCOMPLETEDGROUP, SUCCESSFULDATABASEAUTHENTICATIONGROUP, FAILEDDATABASEAUTHENTICATIONGROUP.
	// This above combination is also the set that is configured by default when enabling auditing from the Azure portal.
	// The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary
	// groups could lead to very large quantities of audit records):
	// APPLICATIONROLECHANGEPASSWORDGROUP BACKUPRESTOREGROUP DATABASELOGOUTGROUP DATABASEOBJECTCHANGEGROUP DATABASEOBJECTOWNERSHIPCHANGEGROUP
	// DATABASEOBJECTPERMISSIONCHANGEGROUP DATABASEOPERATIONGROUP
	// DATABASEPERMISSIONCHANGEGROUP DATABASEPRINCIPALCHANGEGROUP DATABASEPRINCIPALIMPERSONATIONGROUP DATABASEROLEMEMBERCHANGEGROUP
	// FAILEDDATABASEAUTHENTICATIONGROUP SCHEMAOBJECTACCESSGROUP SCHEMAOBJECT
	// CHANGEGROUP SCHEMAOBJECTOWNERSHIPCHANGEGROUP SCHEMAOBJECTPERMISSIONCHANGEGROUP SUCCESSFULDATABASEAUTHENTICATIONGROUP USERCHANGEPASSWORDGROUP
	// BATCHSTARTEDGROUP BATCHCOMPLETED_GROUP
	// These are groups that cover all sql statements and stored procedures executed against the database, and should not be used
	// in combination with other groups as this will result in duplicate audit logs.
	// For more information, see Database-Level Audit Action Groups
	// [https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups].
	// For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server
	// auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE
	// EXECUTE RECEIVE REFERENCES
	// The general form for defining an action to be audited is: {action} ON {object} BY {principal}
	// Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or
	// schema. For the latter cases, the forms DATABASE::{dbname} and SCHEMA::{schema
	// name} are used, respectively.
	// For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public
	// For more information, see Database-Level Audit Actions
	// [https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions]
	AuditActionsAndGroups []*string

	// Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'state'
	// as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.
	// When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on
	// the database should be also created. Note that for server level audit you
	// should use the 'master' database as {databaseName}.
	// Diagnostic Settings URI format: PUT
	// https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview
	// For more information, see Diagnostic Settings REST API [https://go.microsoft.com/fwlink/?linkid=2033207]or Diagnostic Settings
	// PowerShell [https://go.microsoft.com/fwlink/?linkid=2033043]
	IsAzureMonitorTargetEnabled *bool

	// Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the
	// events to Azure Monitor, specify 'State' as 'Enabled',
	// 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true
	// When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on
	// the master database should also be created.
	// Diagnostic Settings URI format: PUT
	// https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview
	// For more information, see Diagnostic Settings REST API [https://go.microsoft.com/fwlink/?linkid=2033207]or Diagnostic Settings
	// PowerShell [https://go.microsoft.com/fwlink/?linkid=2033043]
	IsDevopsAuditEnabled *bool

	// Specifies whether storageAccountAccessKey value is the storage's secondary key.
	IsStorageSecondaryKeyInUse *bool

	// Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default
	// minimum value is 1000 (1 second). The maximum is 2,147,483,647.
	QueueDelayMs *int32

	// Specifies the number of days to keep in the audit logs in the storage account.
	RetentionDays *int32

	// Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not
	// specifying the storageAccountAccessKey will use SQL server system-assigned
	// managed identity to access the storage. Prerequisites for using managed identity authentication:
	// 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).
	// 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server
	// identity. For more information, see Auditing to storage using Managed
	// Identity authentication [https://go.microsoft.com/fwlink/?linkid=2114355]
	StorageAccountAccessKey *string

	// Specifies the blob storage subscription Id.
	StorageAccountSubscriptionID *string

	// Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint
	// or isAzureMonitorTargetEnabled is required.
	StorageEndpoint *string
}

ServerBlobAuditingPolicyProperties - Properties of a server blob auditing policy.

func (ServerBlobAuditingPolicyProperties) MarshalJSON 

func (s ServerBlobAuditingPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServerBlobAuditingPolicyProperties.

func (*ServerBlobAuditingPolicyProperties) UnmarshalJSON added in v0.6.0 

func (s *ServerBlobAuditingPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerBlobAuditingPolicyProperties.

type ServerKeyType 

type ServerKeyType string

ServerKeyType - The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. 

const (
	ServerKeyTypeAzureKeyVault  ServerKeyType = "AzureKeyVault"
	ServerKeyTypeServiceManaged ServerKeyType = "ServiceManaged"
)

func PossibleServerKeyTypeValues 

func PossibleServerKeyTypeValues() []ServerKeyType

PossibleServerKeyTypeValues returns the possible values for the ServerKeyType const type.

type ServerSecurityAlertPolicy 

type ServerSecurityAlertPolicy struct {
	// Resource properties.
	Properties *ServerSecurityAlertPolicyProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ServerSecurityAlertPolicy - Workspace managed Sql server security alert policy.

func (ServerSecurityAlertPolicy) MarshalJSON 

func (s ServerSecurityAlertPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServerSecurityAlertPolicy.

func (*ServerSecurityAlertPolicy) UnmarshalJSON 

func (s *ServerSecurityAlertPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerSecurityAlertPolicy.

type ServerSecurityAlertPolicyListResult 

type ServerSecurityAlertPolicyListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*ServerSecurityAlertPolicy
}

ServerSecurityAlertPolicyListResult - A list of the workspace managed sql server's security alert policies.

func (ServerSecurityAlertPolicyListResult) MarshalJSON 

func (s ServerSecurityAlertPolicyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServerSecurityAlertPolicyListResult.

func (*ServerSecurityAlertPolicyListResult) UnmarshalJSON added in v0.6.0 

func (s *ServerSecurityAlertPolicyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerSecurityAlertPolicyListResult.

type ServerSecurityAlertPolicyProperties 

type ServerSecurityAlertPolicyProperties struct {
	// REQUIRED; Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on
	// the specific server
	State *SecurityAlertPolicyState

	// Specifies an array of alerts that are disabled. Allowed values are: SqlInjection, SqlInjectionVulnerability, AccessAnomaly,
	// DataExfiltration, UnsafeAction
	DisabledAlerts []*string

	// Specifies that the alert is sent to the account administrators.
	EmailAccountAdmins *bool

	// Specifies an array of e-mail addresses to which the alert is sent.
	EmailAddresses []*string

	// Specifies the number of days to keep in the Threat Detection audit logs.
	RetentionDays *int32

	// Specifies the identifier key of the Threat Detection audit storage account.
	StorageAccountAccessKey *string

	// Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat
	// Detection audit logs.
	StorageEndpoint *string

	// READ-ONLY; Specifies the UTC creation time of the policy.
	CreationTime *time.Time
}

ServerSecurityAlertPolicyProperties - Properties of a security alert policy.

func (ServerSecurityAlertPolicyProperties) MarshalJSON 

func (s ServerSecurityAlertPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServerSecurityAlertPolicyProperties.

func (*ServerSecurityAlertPolicyProperties) UnmarshalJSON 

func (s *ServerSecurityAlertPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerSecurityAlertPolicyProperties.

type ServerUsage 

type ServerUsage struct {
	// READ-ONLY; The current value of the metric.
	CurrentValue *float64

	// READ-ONLY; The metric display name.
	DisplayName *string

	// READ-ONLY; The current limit of the metric.
	Limit *float64

	// READ-ONLY; Name of the server usage metric.
	Name *string

	// READ-ONLY; The next reset time for the metric (ISO8601 format).
	NextResetTime *time.Time

	// READ-ONLY; The name of the resource.
	ResourceName *string

	// READ-ONLY; The units of the metric.
	Unit *string
}

ServerUsage - Represents server metrics.

func (ServerUsage) MarshalJSON 

func (s ServerUsage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServerUsage.

func (*ServerUsage) UnmarshalJSON 

func (s *ServerUsage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerUsage.

type ServerUsageListResult 

type ServerUsageListResult struct {
	// REQUIRED; The list of server metrics for the server.
	Value []*ServerUsage

	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string
}

ServerUsageListResult - Represents the response to a list server metrics request.

func (ServerUsageListResult) MarshalJSON 

func (s ServerUsageListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServerUsageListResult.

func (*ServerUsageListResult) UnmarshalJSON added in v0.6.0 

func (s *ServerUsageListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerUsageListResult.

type ServerVulnerabilityAssessment 

type ServerVulnerabilityAssessment struct {
	// Resource properties.
	Properties *ServerVulnerabilityAssessmentProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ServerVulnerabilityAssessment - A server vulnerability assessment.

func (ServerVulnerabilityAssessment) MarshalJSON 

func (s ServerVulnerabilityAssessment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServerVulnerabilityAssessment.

func (*ServerVulnerabilityAssessment) UnmarshalJSON 

func (s *ServerVulnerabilityAssessment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerVulnerabilityAssessment.

type ServerVulnerabilityAssessmentListResult 

type ServerVulnerabilityAssessmentListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*ServerVulnerabilityAssessment
}

ServerVulnerabilityAssessmentListResult - A list of the server's vulnerability assessments.

func (ServerVulnerabilityAssessmentListResult) MarshalJSON 

func (s ServerVulnerabilityAssessmentListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServerVulnerabilityAssessmentListResult.

func (*ServerVulnerabilityAssessmentListResult) UnmarshalJSON added in v0.6.0 

func (s *ServerVulnerabilityAssessmentListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerVulnerabilityAssessmentListResult.

type ServerVulnerabilityAssessmentProperties 

type ServerVulnerabilityAssessmentProperties struct {
	// REQUIRED; A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).
	StorageContainerPath *string

	// The recurring scans settings
	RecurringScans *VulnerabilityAssessmentRecurringScansProperties

	// Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey'
	// isn't specified, storageAccountAccessKey is required.
	StorageAccountAccessKey *string

	// A shared access signature (SAS Key) that has read and write access to the blob container specified in 'storageContainerPath'
	// parameter. If 'storageAccountAccessKey' isn't specified,
	// StorageContainerSasKey is required.
	StorageContainerSasKey *string
}

ServerVulnerabilityAssessmentProperties - Properties of a server Vulnerability Assessment.

func (ServerVulnerabilityAssessmentProperties) MarshalJSON added in v0.6.0 

func (s ServerVulnerabilityAssessmentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServerVulnerabilityAssessmentProperties.

func (*ServerVulnerabilityAssessmentProperties) UnmarshalJSON added in v0.6.0 

func (s *ServerVulnerabilityAssessmentProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerVulnerabilityAssessmentProperties.

type SparkConfigProperties 

type SparkConfigProperties struct {
	// The type of the spark config properties file.
	ConfigurationType *ConfigurationType

	// The spark config properties.
	Content *string

	// The filename of the spark config properties file.
	Filename *string

	// READ-ONLY; The last update time of the spark config properties file.
	Time *time.Time
}

SparkConfigProperties - SparkConfig Properties for a Big Data pool powered by Apache Spark

func (SparkConfigProperties) MarshalJSON 

func (s SparkConfigProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SparkConfigProperties.

func (*SparkConfigProperties) UnmarshalJSON 

func (s *SparkConfigProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SparkConfigProperties.

type SparkConfigurationClient 

type SparkConfigurationClient struct {
	// contains filtered or unexported fields
}

SparkConfigurationClient contains the methods for the SparkConfiguration group. Don't use this type directly, use NewSparkConfigurationClient() instead.

func NewSparkConfigurationClient 

func NewSparkConfigurationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SparkConfigurationClient, error)

NewSparkConfigurationClient creates a new instance of SparkConfigurationClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SparkConfigurationClient) Get 

func (client *SparkConfigurationClient) Get(ctx context.Context, resourceGroupName string, sparkConfigurationName string, workspaceName string, options *SparkConfigurationClientGetOptions) (SparkConfigurationClientGetResponse, error)

Get - Get SparkConfiguration by name in a workspace. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • sparkConfigurationName - SparkConfiguration name
  • workspaceName - The name of the workspace.
  • options - SparkConfigurationClientGetOptions contains the optional parameters for the SparkConfigurationClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfiguration_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSparkConfigurationClient().Get(ctx, "exampleResourceGroup", "exampleSparkConfigurationName", "exampleWorkspace", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SparkConfigurationResource = armsynapse.SparkConfigurationResource{
	// 	Name: to.Ptr("exampleSparkConfigurationName"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sparkconfigurations"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkconfigurations/exampleSparkConfigurationName"),
	// 	Etag: to.Ptr("1500474f-0000-0200-0000-5cbe090d0000"),
	// 	Properties: &armsynapse.SparkConfigurationInfo{
	// 		Description: to.Ptr("test sparkconfiguration description"),
	// 		Annotations: []*string{
	// 			to.Ptr("testAnnotation1"),
	// 			to.Ptr("testAnnotation2")},
	// 			ConfigMergeRule: map[string]*string{
	// 				"allowedNextOperations.spark.key1": to.Ptr("replace,delete"),
	// 				"allowedNextOperations.spark.key2": to.Ptr("replace,delete,append"),
	// 				"currentOperation.append.separator.spark.key1": to.Ptr("space"),
	// 				"currentOperation.append.separator.spark.key2": to.Ptr("comma"),
	// 				"currentOperation.spark.key1": to.Ptr("append"),
	// 				"currentOperation.spark.key2": to.Ptr("append"),
	// 			},
	// 			Configs: map[string]*string{
	// 				"prop1": to.Ptr("true"),
	// 				"prop2": to.Ptr("true"),
	// 				"prop3": to.Ptr("123"),
	// 			},
	// 			Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 			CreatedBy: to.Ptr("test@microsoft.com"),
	// 			Notes: to.Ptr("testNotes"),
	// 		},
	// 	}
}

Output:

type SparkConfigurationClientGetOptions added in v0.2.0 

type SparkConfigurationClientGetOptions struct {
}

SparkConfigurationClientGetOptions contains the optional parameters for the SparkConfigurationClient.Get method.

type SparkConfigurationClientGetResponse added in v0.2.0 

type SparkConfigurationClientGetResponse struct {
	// SparkConfiguration response details
	SparkConfigurationResource
}

SparkConfigurationClientGetResponse contains the response from method SparkConfigurationClient.Get.

type SparkConfigurationInfo 

type SparkConfigurationInfo struct {
	// REQUIRED; SparkConfiguration configs.
	Configs map[string]*string

	// Annotations for SparkConfiguration.
	Annotations []*string

	// SparkConfiguration merge configs.
	ConfigMergeRule map[string]*string

	// The timestamp of resource creation.
	Created *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// Description about the SparkConfiguration.
	Description *string

	// additional Notes.
	Notes *string
}

SparkConfigurationInfo - SparkConfiguration Artifact information

func (SparkConfigurationInfo) MarshalJSON 

func (s SparkConfigurationInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SparkConfigurationInfo.

func (*SparkConfigurationInfo) UnmarshalJSON 

func (s *SparkConfigurationInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SparkConfigurationInfo.

type SparkConfigurationListResponse 

type SparkConfigurationListResponse struct {
	// REQUIRED; List of SparkConfiguration.
	Value []*SparkConfigurationResource

	// The link to the next page of results, if any remaining results exist.
	NextLink *string
}

SparkConfigurationListResponse - A list of SparkConfiguration resources.

func (SparkConfigurationListResponse) MarshalJSON 

func (s SparkConfigurationListResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SparkConfigurationListResponse.

func (*SparkConfigurationListResponse) UnmarshalJSON added in v0.6.0 

func (s *SparkConfigurationListResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SparkConfigurationListResponse.

type SparkConfigurationResource 

type SparkConfigurationResource struct {
	// REQUIRED; SparkConfiguration properties.
	Properties *SparkConfigurationInfo

	// READ-ONLY; Resource Etag.
	Etag *string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SparkConfigurationResource - SparkConfiguration response details

func (SparkConfigurationResource) MarshalJSON 

func (s SparkConfigurationResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SparkConfigurationResource.

func (*SparkConfigurationResource) UnmarshalJSON 

func (s *SparkConfigurationResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SparkConfigurationResource.

type SparkConfigurationsClient 

type SparkConfigurationsClient struct {
	// contains filtered or unexported fields
}

SparkConfigurationsClient contains the methods for the SparkConfigurations group. Don't use this type directly, use NewSparkConfigurationsClient() instead.

func NewSparkConfigurationsClient 

func NewSparkConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SparkConfigurationsClient, error)

NewSparkConfigurationsClient creates a new instance of SparkConfigurationsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SparkConfigurationsClient) NewListByWorkspacePager added in v0.4.0 

func (client *SparkConfigurationsClient) NewListByWorkspacePager(resourceGroupName string, workspaceName string, options *SparkConfigurationsClientListByWorkspaceOptions) *runtime.Pager[SparkConfigurationsClientListByWorkspaceResponse]

NewListByWorkspacePager - List sparkConfigurations in a workspace.

Generated from API version 2021-06-01-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - SparkConfigurationsClientListByWorkspaceOptions contains the optional parameters for the SparkConfigurationsClient.NewListByWorkspacePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_ListByWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSparkConfigurationsClient().NewListByWorkspacePager("exampleResourceGroup", "exampleWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SparkConfigurationListResponse = armsynapse.SparkConfigurationListResponse{
		// 	Value: []*armsynapse.SparkConfigurationResource{
		// 		{
		// 			Name: to.Ptr("exampleSparkConfigurationName1"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sparkconfigurations"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkconfigurations/exampleSparkConfigurationName"),
		// 			Etag: to.Ptr("1500474f-0000-0200-0000-5cbe090d0000"),
		// 			Properties: &armsynapse.SparkConfigurationInfo{
		// 				Description: to.Ptr("test sparkconfiguration description1"),
		// 				Annotations: []*string{
		// 					to.Ptr("testAnnotation1"),
		// 					to.Ptr("testAnnotation2")},
		// 					ConfigMergeRule: map[string]*string{
		// 						"allowedNextOperations.spark.key1": to.Ptr("replace,delete"),
		// 						"allowedNextOperations.spark.key2": to.Ptr("replace,delete,append"),
		// 						"currentOperation.append.separator.spark.key1": to.Ptr("space"),
		// 						"currentOperation.append.separator.spark.key2": to.Ptr("comma"),
		// 						"currentOperation.spark.key1": to.Ptr("append"),
		// 						"currentOperation.spark.key2": to.Ptr("append"),
		// 					},
		// 					Configs: map[string]*string{
		// 						"prop1": to.Ptr("true"),
		// 						"prop2": to.Ptr("true"),
		// 						"prop3": to.Ptr("123"),
		// 					},
		// 					Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 					CreatedBy: to.Ptr("test@microsoft.com"),
		// 					Notes: to.Ptr("testNotes"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("exampleSparkConfigurationName2"),
		// 				Type: to.Ptr("Microsoft.Synapse/workspaces/sparkconfigurations"),
		// 				ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkconfigurations/exampleSparkConfigurationName2"),
		// 				Etag: to.Ptr("1500474f-0000-0200-0000-5cbe090d0000"),
		// 				Properties: &armsynapse.SparkConfigurationInfo{
		// 					Description: to.Ptr("test sparkconfiguration description2"),
		// 					Annotations: []*string{
		// 						to.Ptr("testAnnotation1"),
		// 						to.Ptr("testAnnotation2")},
		// 						ConfigMergeRule: map[string]*string{
		// 							"allowedNextOperations.spark.key1": to.Ptr("replace,delete"),
		// 							"allowedNextOperations.spark.key2": to.Ptr("replace,delete,append"),
		// 							"currentOperation.append.separator.spark.key1": to.Ptr("space"),
		// 							"currentOperation.append.separator.spark.key2": to.Ptr("comma"),
		// 							"currentOperation.spark.key1": to.Ptr("append"),
		// 							"currentOperation.spark.key2": to.Ptr("append"),
		// 						},
		// 						Configs: map[string]*string{
		// 							"prop1": to.Ptr("true"),
		// 							"prop2": to.Ptr("true"),
		// 							"prop3": to.Ptr("123"),
		// 						},
		// 						Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
		// 						CreatedBy: to.Ptr("test@microsoft.com"),
		// 						Notes: to.Ptr("testNotes"),
		// 					},
		// 			}},
		// 		}
	}
}

Output:

type SparkConfigurationsClientListByWorkspaceOptions added in v0.2.0 

type SparkConfigurationsClientListByWorkspaceOptions struct {
}

SparkConfigurationsClientListByWorkspaceOptions contains the optional parameters for the SparkConfigurationsClient.NewListByWorkspacePager method.

type SparkConfigurationsClientListByWorkspaceResponse added in v0.2.0 

type SparkConfigurationsClientListByWorkspaceResponse struct {
	// A list of SparkConfiguration resources.
	SparkConfigurationListResponse
}

SparkConfigurationsClientListByWorkspaceResponse contains the response from method SparkConfigurationsClient.NewListByWorkspacePager.

type SsisEnvironment 

type SsisEnvironment struct {
	// REQUIRED; Type of metadata.
	Type *SsisObjectMetadataType

	// Metadata description.
	Description *string

	// Folder id which contains environment.
	FolderID *int64

	// Metadata id.
	ID *int64

	// Metadata name.
	Name *string

	// Variable in environment
	Variables []*SsisVariable
}

SsisEnvironment - Ssis environment.

func (*SsisEnvironment) GetSsisObjectMetadata added in v0.2.0 

func (s *SsisEnvironment) GetSsisObjectMetadata() *SsisObjectMetadata

GetSsisObjectMetadata implements the SsisObjectMetadataClassification interface for type SsisEnvironment.

func (SsisEnvironment) MarshalJSON 

func (s SsisEnvironment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsisEnvironment.

func (*SsisEnvironment) UnmarshalJSON 

func (s *SsisEnvironment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SsisEnvironment.

type SsisEnvironmentReference 

type SsisEnvironmentReference struct {
	// Environment folder name.
	EnvironmentFolderName *string

	// Environment name.
	EnvironmentName *string

	// Environment reference id.
	ID *int64

	// Reference type
	ReferenceType *string
}

SsisEnvironmentReference - Ssis environment reference.

func (SsisEnvironmentReference) MarshalJSON added in v0.6.0 

func (s SsisEnvironmentReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsisEnvironmentReference.

func (*SsisEnvironmentReference) UnmarshalJSON added in v0.6.0 

func (s *SsisEnvironmentReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SsisEnvironmentReference.

type SsisFolder 

type SsisFolder struct {
	// REQUIRED; Type of metadata.
	Type *SsisObjectMetadataType

	// Metadata description.
	Description *string

	// Metadata id.
	ID *int64

	// Metadata name.
	Name *string
}

SsisFolder - Ssis folder.

func (*SsisFolder) GetSsisObjectMetadata added in v0.2.0 

func (s *SsisFolder) GetSsisObjectMetadata() *SsisObjectMetadata

GetSsisObjectMetadata implements the SsisObjectMetadataClassification interface for type SsisFolder.

func (SsisFolder) MarshalJSON 

func (s SsisFolder) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsisFolder.

func (*SsisFolder) UnmarshalJSON added in v0.2.0 

func (s *SsisFolder) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SsisFolder.

type SsisObjectMetadata 

type SsisObjectMetadata struct {
	// REQUIRED; Type of metadata.
	Type *SsisObjectMetadataType

	// Metadata description.
	Description *string

	// Metadata id.
	ID *int64

	// Metadata name.
	Name *string
}

SsisObjectMetadata - SSIS object metadata.

func (*SsisObjectMetadata) GetSsisObjectMetadata 

func (s *SsisObjectMetadata) GetSsisObjectMetadata() *SsisObjectMetadata

GetSsisObjectMetadata implements the SsisObjectMetadataClassification interface for type SsisObjectMetadata.

func (SsisObjectMetadata) MarshalJSON added in v0.6.0 

func (s SsisObjectMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsisObjectMetadata.

func (*SsisObjectMetadata) UnmarshalJSON 

func (s *SsisObjectMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SsisObjectMetadata.

type SsisObjectMetadataClassification 

type SsisObjectMetadataClassification interface {
	// GetSsisObjectMetadata returns the SsisObjectMetadata content of the underlying type.
	GetSsisObjectMetadata() *SsisObjectMetadata
}

SsisObjectMetadataClassification provides polymorphic access to related types. Call the interface's GetSsisObjectMetadata() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *SsisEnvironment, *SsisFolder, *SsisObjectMetadata, *SsisPackage, *SsisProject

type SsisObjectMetadataListResponse 

type SsisObjectMetadataListResponse struct {
	// The link to the next page of results, if any remaining results exist.
	NextLink *string

	// List of SSIS object metadata.
	Value []SsisObjectMetadataClassification
}

SsisObjectMetadataListResponse - A list of SSIS object metadata.

func (SsisObjectMetadataListResponse) MarshalJSON 

func (s SsisObjectMetadataListResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsisObjectMetadataListResponse.

func (*SsisObjectMetadataListResponse) UnmarshalJSON 

func (s *SsisObjectMetadataListResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SsisObjectMetadataListResponse.

type SsisObjectMetadataStatusResponse 

type SsisObjectMetadataStatusResponse struct {
	// The operation error message.
	Error *string

	// The operation name.
	Name *string

	// The operation properties.
	Properties *string

	// The status of the operation.
	Status *string
}

SsisObjectMetadataStatusResponse - The status of the operation.

func (SsisObjectMetadataStatusResponse) MarshalJSON added in v0.6.0 

func (s SsisObjectMetadataStatusResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsisObjectMetadataStatusResponse.

func (*SsisObjectMetadataStatusResponse) UnmarshalJSON added in v0.6.0 

func (s *SsisObjectMetadataStatusResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SsisObjectMetadataStatusResponse.

type SsisObjectMetadataType 

type SsisObjectMetadataType string

SsisObjectMetadataType - The type of SSIS object metadata. 

const (
	SsisObjectMetadataTypeEnvironment SsisObjectMetadataType = "Environment"
	SsisObjectMetadataTypeFolder      SsisObjectMetadataType = "Folder"
	SsisObjectMetadataTypePackage     SsisObjectMetadataType = "Package"
	SsisObjectMetadataTypeProject     SsisObjectMetadataType = "Project"
)

func PossibleSsisObjectMetadataTypeValues 

func PossibleSsisObjectMetadataTypeValues() []SsisObjectMetadataType

PossibleSsisObjectMetadataTypeValues returns the possible values for the SsisObjectMetadataType const type.

type SsisPackage 

type SsisPackage struct {
	// REQUIRED; Type of metadata.
	Type *SsisObjectMetadataType

	// Metadata description.
	Description *string

	// Folder id which contains package.
	FolderID *int64

	// Metadata id.
	ID *int64

	// Metadata name.
	Name *string

	// Parameters in package
	Parameters []*SsisParameter

	// Project id which contains package.
	ProjectID *int64

	// Project version which contains package.
	ProjectVersion *int64
}

SsisPackage - Ssis Package.

func (*SsisPackage) GetSsisObjectMetadata added in v0.2.0 

func (s *SsisPackage) GetSsisObjectMetadata() *SsisObjectMetadata

GetSsisObjectMetadata implements the SsisObjectMetadataClassification interface for type SsisPackage.

func (SsisPackage) MarshalJSON 

func (s SsisPackage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsisPackage.

func (*SsisPackage) UnmarshalJSON 

func (s *SsisPackage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SsisPackage.

type SsisParameter 

type SsisParameter struct {
	// Parameter type.
	DataType *string

	// Default value of parameter.
	DefaultValue *string

	// Parameter description.
	Description *string

	// Design default value of parameter.
	DesignDefaultValue *string

	// Parameter id.
	ID *int64

	// Parameter name.
	Name *string

	// Whether parameter is required.
	Required *bool

	// Whether parameter is sensitive.
	Sensitive *bool

	// Default sensitive value of parameter.
	SensitiveDefaultValue *string

	// Parameter value set.
	ValueSet *bool

	// Parameter value type.
	ValueType *string

	// Parameter reference variable.
	Variable *string
}

SsisParameter - Ssis parameter.

func (SsisParameter) MarshalJSON added in v0.6.0 

func (s SsisParameter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsisParameter.

func (*SsisParameter) UnmarshalJSON added in v0.6.0 

func (s *SsisParameter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SsisParameter.

type SsisProject 

type SsisProject struct {
	// REQUIRED; Type of metadata.
	Type *SsisObjectMetadataType

	// Metadata description.
	Description *string

	// Environment reference in project
	EnvironmentRefs []*SsisEnvironmentReference

	// Folder id which contains project.
	FolderID *int64

	// Metadata id.
	ID *int64

	// Metadata name.
	Name *string

	// Parameters in project
	Parameters []*SsisParameter

	// Project version.
	Version *int64
}

SsisProject - Ssis project.

func (*SsisProject) GetSsisObjectMetadata added in v0.2.0 

func (s *SsisProject) GetSsisObjectMetadata() *SsisObjectMetadata

GetSsisObjectMetadata implements the SsisObjectMetadataClassification interface for type SsisProject.

func (SsisProject) MarshalJSON 

func (s SsisProject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsisProject.

func (*SsisProject) UnmarshalJSON 

func (s *SsisProject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SsisProject.

type SsisVariable 

type SsisVariable struct {
	// Variable type.
	DataType *string

	// Variable description.
	Description *string

	// Variable id.
	ID *int64

	// Variable name.
	Name *string

	// Whether variable is sensitive.
	Sensitive *bool

	// Variable sensitive value.
	SensitiveValue *string

	// Variable value.
	Value *string
}

SsisVariable - Ssis variable.

func (SsisVariable) MarshalJSON added in v0.6.0 

func (s SsisVariable) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SsisVariable.

func (*SsisVariable) UnmarshalJSON added in v0.6.0 

func (s *SsisVariable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SsisVariable.

type State 

type State string

State - The state of the resource. 

const (
	StateCreating    State = "Creating"
	StateDeleted     State = "Deleted"
	StateDeleting    State = "Deleting"
	StateRunning     State = "Running"
	StateStarting    State = "Starting"
	StateStopped     State = "Stopped"
	StateStopping    State = "Stopping"
	StateUnavailable State = "Unavailable"
	StateUpdating    State = "Updating"
)

func PossibleStateValues 

func PossibleStateValues() []State

PossibleStateValues returns the possible values for the State const type.

type StateValue 

type StateValue string

StateValue - property configuration state 

const (
	StateValueConsistent   StateValue = "Consistent"
	StateValueInConsistent StateValue = "InConsistent"
	StateValueUpdating     StateValue = "Updating"
)

func PossibleStateValueValues 

func PossibleStateValueValues() []StateValue

PossibleStateValueValues returns the possible values for the StateValue const type.

type StorageAccountType 

type StorageAccountType string

StorageAccountType - The storage account type used to store backups for this sql pool. 

const (
	StorageAccountTypeGRS StorageAccountType = "GRS"
	StorageAccountTypeLRS StorageAccountType = "LRS"
)

func PossibleStorageAccountTypeValues 

func PossibleStorageAccountTypeValues() []StorageAccountType

PossibleStorageAccountTypeValues returns the possible values for the StorageAccountType const type.

type SubResource 

type SubResource struct {
	// READ-ONLY; Resource Etag.
	Etag *string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SubResource - Azure Synapse nested resource, which belongs to a workspace.

func (SubResource) MarshalJSON added in v0.6.0 

func (s SubResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubResource.

func (*SubResource) UnmarshalJSON added in v0.6.0 

func (s *SubResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SubResource.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TableLevelSharingProperties 

type TableLevelSharingProperties struct {
	// List of external tables exclude from the follower database
	ExternalTablesToExclude []*string

	// List of external tables to include in the follower database
	ExternalTablesToInclude []*string

	// List of materialized views exclude from the follower database
	MaterializedViewsToExclude []*string

	// List of materialized views to include in the follower database
	MaterializedViewsToInclude []*string

	// List of tables to exclude from the follower database
	TablesToExclude []*string

	// List of tables to include in the follower database
	TablesToInclude []*string
}

TableLevelSharingProperties - Tables that will be included and excluded in the follower database

func (TableLevelSharingProperties) MarshalJSON 

func (t TableLevelSharingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TableLevelSharingProperties.

func (*TableLevelSharingProperties) UnmarshalJSON added in v0.6.0 

func (t *TableLevelSharingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TableLevelSharingProperties.

type TopQueries 

type TopQueries struct {
	// READ-ONLY; The function that is used to aggregate each query's metrics.
	AggregationFunction *QueryAggregationFunction

	// READ-ONLY; The execution type that is used to filter the query instances that are returned.
	ExecutionType *QueryExecutionType

	// READ-ONLY; The duration of the interval (ISO8601 duration format).
	IntervalType *string

	// READ-ONLY; The number of requested queries.
	NumberOfTopQueries *int32

	// READ-ONLY; The end time for queries that are returned (ISO8601 format)
	ObservationEndTime *time.Time

	// READ-ONLY; The start time for queries that are returned (ISO8601 format)
	ObservationStartTime *time.Time

	// READ-ONLY; The type of metric to use for ordering the top metrics.
	ObservedMetric *QueryObservedMetricType

	// READ-ONLY; The list of queries.
	Queries []*QueryStatistic
}

TopQueries - A database query.

func (TopQueries) MarshalJSON 

func (t TopQueries) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopQueries.

func (*TopQueries) UnmarshalJSON 

func (t *TopQueries) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopQueries.

type TopQueriesListResult 

type TopQueriesListResult struct {
	// REQUIRED; The list of top queries.
	Value []*TopQueries
}

TopQueriesListResult - Represents the response to a get top queries request.

func (TopQueriesListResult) MarshalJSON 

func (t TopQueriesListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopQueriesListResult.

func (*TopQueriesListResult) UnmarshalJSON added in v0.6.0 

func (t *TopQueriesListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopQueriesListResult.

type TrackedResource 

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

func (*TrackedResource) UnmarshalJSON 

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

type TransparentDataEncryption 

type TransparentDataEncryption struct {
	// Represents the properties of the resource.
	Properties *TransparentDataEncryptionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; Resource location.
	Location *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

TransparentDataEncryption - Represents a Sql pool transparent data encryption configuration.

func (TransparentDataEncryption) MarshalJSON 

func (t TransparentDataEncryption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TransparentDataEncryption.

func (*TransparentDataEncryption) UnmarshalJSON 

func (t *TransparentDataEncryption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TransparentDataEncryption.

type TransparentDataEncryptionListResult 

type TransparentDataEncryptionListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*TransparentDataEncryption
}

TransparentDataEncryptionListResult - A list of transparent data encryption configurations.

func (TransparentDataEncryptionListResult) MarshalJSON 

func (t TransparentDataEncryptionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TransparentDataEncryptionListResult.

func (*TransparentDataEncryptionListResult) UnmarshalJSON added in v0.6.0 

func (t *TransparentDataEncryptionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TransparentDataEncryptionListResult.

type TransparentDataEncryptionName 

type TransparentDataEncryptionName string
const (
	TransparentDataEncryptionNameCurrent TransparentDataEncryptionName = "current"
)

func PossibleTransparentDataEncryptionNameValues 

func PossibleTransparentDataEncryptionNameValues() []TransparentDataEncryptionName

PossibleTransparentDataEncryptionNameValues returns the possible values for the TransparentDataEncryptionName const type.

type TransparentDataEncryptionProperties 

type TransparentDataEncryptionProperties struct {
	// The status of the database transparent data encryption.
	Status *TransparentDataEncryptionStatus
}

TransparentDataEncryptionProperties - Represents the properties of a database transparent data encryption.

func (TransparentDataEncryptionProperties) MarshalJSON added in v0.6.0 

func (t TransparentDataEncryptionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TransparentDataEncryptionProperties.

func (*TransparentDataEncryptionProperties) UnmarshalJSON added in v0.6.0 

func (t *TransparentDataEncryptionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TransparentDataEncryptionProperties.

type TransparentDataEncryptionStatus 

type TransparentDataEncryptionStatus string

TransparentDataEncryptionStatus - The status of the database transparent data encryption. 

const (
	TransparentDataEncryptionStatusDisabled TransparentDataEncryptionStatus = "Disabled"
	TransparentDataEncryptionStatusEnabled  TransparentDataEncryptionStatus = "Enabled"
)

func PossibleTransparentDataEncryptionStatusValues 

func PossibleTransparentDataEncryptionStatusValues() []TransparentDataEncryptionStatus

PossibleTransparentDataEncryptionStatusValues returns the possible values for the TransparentDataEncryptionStatus const type.

type Type 

type Type string

Type - The type of resource, for instance Microsoft.Synapse/workspaces/kustoPools/databases. 

const (
	TypeMicrosoftSynapseWorkspacesKustoPoolsAttachedDatabaseConfigurations Type = "Microsoft.Synapse/workspaces/kustoPools/attachedDatabaseConfigurations"
	TypeMicrosoftSynapseWorkspacesKustoPoolsDatabases                      Type = "Microsoft.Synapse/workspaces/kustoPools/databases"
)

func PossibleTypeValues 

func PossibleTypeValues() []Type

PossibleTypeValues returns the possible values for the Type const type.

type UpdateIntegrationRuntimeNodeRequest 

type UpdateIntegrationRuntimeNodeRequest struct {
	// The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive)
	// are allowed.
	ConcurrentJobsLimit *int32
}

UpdateIntegrationRuntimeNodeRequest - Update integration runtime node request.

func (UpdateIntegrationRuntimeNodeRequest) MarshalJSON 

func (u UpdateIntegrationRuntimeNodeRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateIntegrationRuntimeNodeRequest.

func (*UpdateIntegrationRuntimeNodeRequest) UnmarshalJSON added in v0.6.0 

func (u *UpdateIntegrationRuntimeNodeRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateIntegrationRuntimeNodeRequest.

type UpdateIntegrationRuntimeRequest 

type UpdateIntegrationRuntimeRequest struct {
	// Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189.
	AutoUpdate *IntegrationRuntimeAutoUpdate

	// The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that
	// time.
	UpdateDelayOffset *string
}

UpdateIntegrationRuntimeRequest - Update integration runtime request.

func (UpdateIntegrationRuntimeRequest) MarshalJSON 

func (u UpdateIntegrationRuntimeRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateIntegrationRuntimeRequest.

func (*UpdateIntegrationRuntimeRequest) UnmarshalJSON added in v0.6.0 

func (u *UpdateIntegrationRuntimeRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateIntegrationRuntimeRequest.

type UserAssignedManagedIdentity 

type UserAssignedManagedIdentity struct {
	// READ-ONLY; The client ID.
	ClientID *string

	// READ-ONLY; The principal ID.
	PrincipalID *string
}

UserAssignedManagedIdentity - User Assigned Managed Identity

func (UserAssignedManagedIdentity) MarshalJSON added in v0.6.0 

func (u UserAssignedManagedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAssignedManagedIdentity.

func (*UserAssignedManagedIdentity) UnmarshalJSON added in v0.6.0 

func (u *UserAssignedManagedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAssignedManagedIdentity.

type VirtualNetworkProfile 

type VirtualNetworkProfile struct {
	// Subnet ID used for computes in workspace
	ComputeSubnetID *string
}

VirtualNetworkProfile - Virtual Network Profile

func (VirtualNetworkProfile) MarshalJSON added in v0.6.0 

func (v VirtualNetworkProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkProfile.

func (*VirtualNetworkProfile) UnmarshalJSON added in v0.6.0 

func (v *VirtualNetworkProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkProfile.

type VulnerabilityAssessmentName 

type VulnerabilityAssessmentName string
const (
	VulnerabilityAssessmentNameDefault VulnerabilityAssessmentName = "default"
)

func PossibleVulnerabilityAssessmentNameValues 

func PossibleVulnerabilityAssessmentNameValues() []VulnerabilityAssessmentName

PossibleVulnerabilityAssessmentNameValues returns the possible values for the VulnerabilityAssessmentName const type.

type VulnerabilityAssessmentPolicyBaselineName 

type VulnerabilityAssessmentPolicyBaselineName string
const (
	VulnerabilityAssessmentPolicyBaselineNameDefault VulnerabilityAssessmentPolicyBaselineName = "default"
	VulnerabilityAssessmentPolicyBaselineNameMaster  VulnerabilityAssessmentPolicyBaselineName = "master"
)

func PossibleVulnerabilityAssessmentPolicyBaselineNameValues 

func PossibleVulnerabilityAssessmentPolicyBaselineNameValues() []VulnerabilityAssessmentPolicyBaselineName

PossibleVulnerabilityAssessmentPolicyBaselineNameValues returns the possible values for the VulnerabilityAssessmentPolicyBaselineName const type.

type VulnerabilityAssessmentRecurringScansProperties 

type VulnerabilityAssessmentRecurringScansProperties struct {
	// Specifies that the schedule scan notification will be is sent to the subscription administrators.
	EmailSubscriptionAdmins *bool

	// Specifies an array of e-mail addresses to which the scan notification is sent.
	Emails []*string

	// Recurring scans state.
	IsEnabled *bool
}

VulnerabilityAssessmentRecurringScansProperties - Properties of a Vulnerability Assessment recurring scans.

func (VulnerabilityAssessmentRecurringScansProperties) MarshalJSON 

func (v VulnerabilityAssessmentRecurringScansProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VulnerabilityAssessmentRecurringScansProperties.

func (*VulnerabilityAssessmentRecurringScansProperties) UnmarshalJSON added in v0.6.0 

func (v *VulnerabilityAssessmentRecurringScansProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VulnerabilityAssessmentRecurringScansProperties.

type VulnerabilityAssessmentScanError 

type VulnerabilityAssessmentScanError struct {
	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error message.
	Message *string
}

VulnerabilityAssessmentScanError - Properties of a vulnerability assessment scan error.

func (VulnerabilityAssessmentScanError) MarshalJSON added in v0.6.0 

func (v VulnerabilityAssessmentScanError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VulnerabilityAssessmentScanError.

func (*VulnerabilityAssessmentScanError) UnmarshalJSON added in v0.6.0 

func (v *VulnerabilityAssessmentScanError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VulnerabilityAssessmentScanError.

type VulnerabilityAssessmentScanRecord 

type VulnerabilityAssessmentScanRecord struct {
	// Resource properties.
	Properties *VulnerabilityAssessmentScanRecordProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

VulnerabilityAssessmentScanRecord - A vulnerability assessment scan record.

func (VulnerabilityAssessmentScanRecord) MarshalJSON 

func (v VulnerabilityAssessmentScanRecord) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VulnerabilityAssessmentScanRecord.

func (*VulnerabilityAssessmentScanRecord) UnmarshalJSON 

func (v *VulnerabilityAssessmentScanRecord) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VulnerabilityAssessmentScanRecord.

type VulnerabilityAssessmentScanRecordListResult 

type VulnerabilityAssessmentScanRecordListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*VulnerabilityAssessmentScanRecord
}

VulnerabilityAssessmentScanRecordListResult - A list of vulnerability assessment scan records.

func (VulnerabilityAssessmentScanRecordListResult) MarshalJSON 

func (v VulnerabilityAssessmentScanRecordListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VulnerabilityAssessmentScanRecordListResult.

func (*VulnerabilityAssessmentScanRecordListResult) UnmarshalJSON added in v0.6.0 

func (v *VulnerabilityAssessmentScanRecordListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VulnerabilityAssessmentScanRecordListResult.

type VulnerabilityAssessmentScanRecordProperties 

type VulnerabilityAssessmentScanRecordProperties struct {
	// READ-ONLY; The scan end time (UTC).
	EndTime *time.Time

	// READ-ONLY; The scan errors.
	Errors []*VulnerabilityAssessmentScanError

	// READ-ONLY; The number of failed security checks.
	NumberOfFailedSecurityChecks *int32

	// READ-ONLY; The scan ID.
	ScanID *string

	// READ-ONLY; The scan start time (UTC).
	StartTime *time.Time

	// READ-ONLY; The scan status.
	State *VulnerabilityAssessmentScanState

	// READ-ONLY; The scan results storage container path.
	StorageContainerPath *string

	// READ-ONLY; The scan trigger type.
	TriggerType *VulnerabilityAssessmentScanTriggerType
}

VulnerabilityAssessmentScanRecordProperties - Properties of a vulnerability assessment scan record.

func (VulnerabilityAssessmentScanRecordProperties) MarshalJSON 

func (v VulnerabilityAssessmentScanRecordProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VulnerabilityAssessmentScanRecordProperties.

func (*VulnerabilityAssessmentScanRecordProperties) UnmarshalJSON 

func (v *VulnerabilityAssessmentScanRecordProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VulnerabilityAssessmentScanRecordProperties.

type VulnerabilityAssessmentScanState 

type VulnerabilityAssessmentScanState string

VulnerabilityAssessmentScanState - The scan status. 

const (
	VulnerabilityAssessmentScanStateFailed      VulnerabilityAssessmentScanState = "Failed"
	VulnerabilityAssessmentScanStateFailedToRun VulnerabilityAssessmentScanState = "FailedToRun"
	VulnerabilityAssessmentScanStateInProgress  VulnerabilityAssessmentScanState = "InProgress"
	VulnerabilityAssessmentScanStatePassed      VulnerabilityAssessmentScanState = "Passed"
)

func PossibleVulnerabilityAssessmentScanStateValues 

func PossibleVulnerabilityAssessmentScanStateValues() []VulnerabilityAssessmentScanState

PossibleVulnerabilityAssessmentScanStateValues returns the possible values for the VulnerabilityAssessmentScanState const type.

type VulnerabilityAssessmentScanTriggerType 

type VulnerabilityAssessmentScanTriggerType string

VulnerabilityAssessmentScanTriggerType - The scan trigger type. 

const (
	VulnerabilityAssessmentScanTriggerTypeOnDemand  VulnerabilityAssessmentScanTriggerType = "OnDemand"
	VulnerabilityAssessmentScanTriggerTypeRecurring VulnerabilityAssessmentScanTriggerType = "Recurring"
)

func PossibleVulnerabilityAssessmentScanTriggerTypeValues 

func PossibleVulnerabilityAssessmentScanTriggerTypeValues() []VulnerabilityAssessmentScanTriggerType

PossibleVulnerabilityAssessmentScanTriggerTypeValues returns the possible values for the VulnerabilityAssessmentScanTriggerType const type.

type WorkloadClassifier 

type WorkloadClassifier struct {
	// Resource properties.
	Properties *WorkloadClassifierProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

WorkloadClassifier - Workload classifier operations for a data warehouse

func (WorkloadClassifier) MarshalJSON 

func (w WorkloadClassifier) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkloadClassifier.

func (*WorkloadClassifier) UnmarshalJSON 

func (w *WorkloadClassifier) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkloadClassifier.

type WorkloadClassifierListResult 

type WorkloadClassifierListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*WorkloadClassifier
}

WorkloadClassifierListResult - A list of workload classifiers for a workload group.

func (WorkloadClassifierListResult) MarshalJSON 

func (w WorkloadClassifierListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkloadClassifierListResult.

func (*WorkloadClassifierListResult) UnmarshalJSON added in v0.6.0 

func (w *WorkloadClassifierListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkloadClassifierListResult.

type WorkloadClassifierProperties 

type WorkloadClassifierProperties struct {
	// REQUIRED; The workload classifier member name.
	MemberName *string

	// The workload classifier context.
	Context *string

	// The workload classifier end time for classification.
	EndTime *string

	// The workload classifier importance.
	Importance *string

	// The workload classifier label.
	Label *string

	// The workload classifier start time for classification.
	StartTime *string
}

WorkloadClassifierProperties - Workload classifier definition. For more information look at sys.workloadmanagementworkload_classifiers (DMV).

func (WorkloadClassifierProperties) MarshalJSON added in v0.6.0 

func (w WorkloadClassifierProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkloadClassifierProperties.

func (*WorkloadClassifierProperties) UnmarshalJSON added in v0.6.0 

func (w *WorkloadClassifierProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkloadClassifierProperties.

type WorkloadGroup 

type WorkloadGroup struct {
	// Resource properties.
	Properties *WorkloadGroupProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

WorkloadGroup - Workload group operations for a sql pool

func (WorkloadGroup) MarshalJSON 

func (w WorkloadGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkloadGroup.

func (*WorkloadGroup) UnmarshalJSON 

func (w *WorkloadGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkloadGroup.

type WorkloadGroupListResult 

type WorkloadGroupListResult struct {
	// READ-ONLY; Link to retrieve next page of results.
	NextLink *string

	// READ-ONLY; Array of results.
	Value []*WorkloadGroup
}

WorkloadGroupListResult - A list of workload groups.

func (WorkloadGroupListResult) MarshalJSON 

func (w WorkloadGroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkloadGroupListResult.

func (*WorkloadGroupListResult) UnmarshalJSON added in v0.6.0 

func (w *WorkloadGroupListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkloadGroupListResult.

type WorkloadGroupProperties 

type WorkloadGroupProperties struct {
	// REQUIRED; The workload group cap percentage resource.
	MaxResourcePercent *int32

	// REQUIRED; The workload group minimum percentage resource.
	MinResourcePercent *int32

	// REQUIRED; The workload group request minimum grant percentage.
	MinResourcePercentPerRequest *float64

	// The workload group importance level.
	Importance *string

	// The workload group request maximum grant percentage.
	MaxResourcePercentPerRequest *float64

	// The workload group query execution timeout.
	QueryExecutionTimeout *int32
}

WorkloadGroupProperties - Workload group definition. For more information look at sys.workloadmanagementworkload_groups (DMV).

func (WorkloadGroupProperties) MarshalJSON added in v0.6.0 

func (w WorkloadGroupProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkloadGroupProperties.

func (*WorkloadGroupProperties) UnmarshalJSON added in v0.6.0 

func (w *WorkloadGroupProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkloadGroupProperties.

type Workspace 

type Workspace struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Identity of the workspace
	Identity *ManagedIdentity

	// Workspace resource properties
	Properties *WorkspaceProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Workspace - A workspace

func (Workspace) MarshalJSON 

func (w Workspace) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Workspace.

func (*Workspace) UnmarshalJSON 

func (w *Workspace) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Workspace.

type WorkspaceAADAdminInfo 

type WorkspaceAADAdminInfo struct {
	// Workspace active directory administrator properties
	Properties *AADAdminProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

WorkspaceAADAdminInfo - Workspace active directory administrator

func (WorkspaceAADAdminInfo) MarshalJSON 

func (w WorkspaceAADAdminInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceAADAdminInfo.

func (*WorkspaceAADAdminInfo) UnmarshalJSON 

func (w *WorkspaceAADAdminInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceAADAdminInfo.

type WorkspaceAADAdminsClient 

type WorkspaceAADAdminsClient struct {
	// contains filtered or unexported fields
}

WorkspaceAADAdminsClient contains the methods for the WorkspaceAADAdmins group. Don't use this type directly, use NewWorkspaceAADAdminsClient() instead.

func NewWorkspaceAADAdminsClient 

func NewWorkspaceAADAdminsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceAADAdminsClient, error)

NewWorkspaceAADAdminsClient creates a new instance of WorkspaceAADAdminsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceAADAdminsClient) BeginCreateOrUpdate 

func (client *WorkspaceAADAdminsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, aadAdminInfo WorkspaceAADAdminInfo, options *WorkspaceAADAdminsClientBeginCreateOrUpdateOptions) (*runtime.Poller[WorkspaceAADAdminsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a workspace active directory admin If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • aadAdminInfo - Workspace active directory administrator properties
  • options - WorkspaceAADAdminsClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceAADAdminsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateWorkspaceAadAdmin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceAADAdminsClient().BeginCreateOrUpdate(ctx, "resourceGroup1", "workspace1", armsynapse.WorkspaceAADAdminInfo{
		Properties: &armsynapse.AADAdminProperties{
			AdministratorType: to.Ptr("ActiveDirectory"),
			Login:             to.Ptr("bob@contoso.com"),
			Sid:               to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
			TenantID:          to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkspaceAADAdminInfo = armsynapse.WorkspaceAADAdminInfo{
	// 	Name: to.Ptr("activeDirectory"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/administrators/activeDirectory"),
	// 	Properties: &armsynapse.AADAdminProperties{
	// 		AdministratorType: to.Ptr("ActiveDirectory"),
	// 		Login: to.Ptr("bob@contoso.com"),
	// 		Sid: to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
	// 		TenantID: to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
	// 	},
	// }
}

Output:

func (*WorkspaceAADAdminsClient) BeginDelete 

func (client *WorkspaceAADAdminsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspaceAADAdminsClientBeginDeleteOptions) (*runtime.Poller[WorkspaceAADAdminsClientDeleteResponse], error)

BeginDelete - Deletes a workspace active directory admin If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceAADAdminsClientBeginDeleteOptions contains the optional parameters for the WorkspaceAADAdminsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteWorkspaceAadAdmin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceAADAdminsClient().BeginDelete(ctx, "resourceGroup1", "workspace1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*WorkspaceAADAdminsClient) Get 

func (client *WorkspaceAADAdminsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspaceAADAdminsClientGetOptions) (WorkspaceAADAdminsClientGetResponse, error)

Get - Gets a workspace active directory admin If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceAADAdminsClientGetOptions contains the optional parameters for the WorkspaceAADAdminsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetWorkspaceAadAdmin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceAADAdminsClient().Get(ctx, "resourceGroup1", "workspace1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkspaceAADAdminInfo = armsynapse.WorkspaceAADAdminInfo{
	// 	Name: to.Ptr("activeDirectory"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/administrators/activeDirectory"),
	// 	Properties: &armsynapse.AADAdminProperties{
	// 		AdministratorType: to.Ptr("ActiveDirectory"),
	// 		Login: to.Ptr("bob@contoso.com"),
	// 		Sid: to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
	// 		TenantID: to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
	// 	},
	// }
}

Output:

type WorkspaceAADAdminsClientBeginCreateOrUpdateOptions added in v0.2.0 

type WorkspaceAADAdminsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceAADAdminsClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceAADAdminsClient.BeginCreateOrUpdate method.

type WorkspaceAADAdminsClientBeginDeleteOptions added in v0.2.0 

type WorkspaceAADAdminsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceAADAdminsClientBeginDeleteOptions contains the optional parameters for the WorkspaceAADAdminsClient.BeginDelete method.

type WorkspaceAADAdminsClientCreateOrUpdateResponse added in v0.2.0 

type WorkspaceAADAdminsClientCreateOrUpdateResponse struct {
	// Workspace active directory administrator
	WorkspaceAADAdminInfo
}

WorkspaceAADAdminsClientCreateOrUpdateResponse contains the response from method WorkspaceAADAdminsClient.BeginCreateOrUpdate.

type WorkspaceAADAdminsClientDeleteResponse added in v0.2.0 

type WorkspaceAADAdminsClientDeleteResponse struct {
}

WorkspaceAADAdminsClientDeleteResponse contains the response from method WorkspaceAADAdminsClient.BeginDelete.

type WorkspaceAADAdminsClientGetOptions added in v0.2.0 

type WorkspaceAADAdminsClientGetOptions struct {
}

WorkspaceAADAdminsClientGetOptions contains the optional parameters for the WorkspaceAADAdminsClient.Get method.

type WorkspaceAADAdminsClientGetResponse added in v0.2.0 

type WorkspaceAADAdminsClientGetResponse struct {
	// Workspace active directory administrator
	WorkspaceAADAdminInfo
}

WorkspaceAADAdminsClientGetResponse contains the response from method WorkspaceAADAdminsClient.Get.

type WorkspaceInfoListResult 

type WorkspaceInfoListResult struct {
	// Link to the next page of results
	NextLink *string

	// List of workspaces
	Value []*Workspace
}

WorkspaceInfoListResult - List of workspaces

func (WorkspaceInfoListResult) MarshalJSON 

func (w WorkspaceInfoListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceInfoListResult.

func (*WorkspaceInfoListResult) UnmarshalJSON added in v0.6.0 

func (w *WorkspaceInfoListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceInfoListResult.

type WorkspaceKeyDetails 

type WorkspaceKeyDetails struct {
	// Workspace Key sub-resource key vault url
	KeyVaultURL *string

	// Workspace Key sub-resource name
	Name *string
}

WorkspaceKeyDetails - Details of the customer managed key associated with the workspace

func (WorkspaceKeyDetails) MarshalJSON added in v0.6.0 

func (w WorkspaceKeyDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceKeyDetails.

func (*WorkspaceKeyDetails) UnmarshalJSON added in v0.6.0 

func (w *WorkspaceKeyDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceKeyDetails.

type WorkspaceManagedIdentitySQLControlSettingsClient 

type WorkspaceManagedIdentitySQLControlSettingsClient struct {
	// contains filtered or unexported fields
}

WorkspaceManagedIdentitySQLControlSettingsClient contains the methods for the WorkspaceManagedIdentitySQLControlSettings group. Don't use this type directly, use NewWorkspaceManagedIdentitySQLControlSettingsClient() instead.

func NewWorkspaceManagedIdentitySQLControlSettingsClient 

func NewWorkspaceManagedIdentitySQLControlSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceManagedIdentitySQLControlSettingsClient, error)

NewWorkspaceManagedIdentitySQLControlSettingsClient creates a new instance of WorkspaceManagedIdentitySQLControlSettingsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceManagedIdentitySQLControlSettingsClient) BeginCreateOrUpdate 

func (client *WorkspaceManagedIdentitySQLControlSettingsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, managedIdentitySQLControlSettings ManagedIdentitySQLControlSettingsModel, options *WorkspaceManagedIdentitySQLControlSettingsClientBeginCreateOrUpdateOptions) (*runtime.Poller[WorkspaceManagedIdentitySQLControlSettingsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update Managed Identity Sql Control Settings If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • managedIdentitySQLControlSettings - Managed Identity Sql Control Settings
  • options - WorkspaceManagedIdentitySQLControlSettingsClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedIdentitySQLControlSettingsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateManagedIdentitySqlControlSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedIdentitySQLControlSettingsClient().BeginCreateOrUpdate(ctx, "resourceGroup1", "workspace1", armsynapse.ManagedIdentitySQLControlSettingsModel{
		Properties: &armsynapse.ManagedIdentitySQLControlSettingsModelProperties{
			GrantSQLControlToManagedIdentity: &armsynapse.ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity{
				DesiredState: to.Ptr(armsynapse.DesiredStateEnabled),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ManagedIdentitySQLControlSettingsModel = armsynapse.ManagedIdentitySQLControlSettingsModel{
	// 	Name: to.Ptr("default"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/managedIdentitySqlControlSettings/default"),
	// 	Properties: &armsynapse.ManagedIdentitySQLControlSettingsModelProperties{
	// 		GrantSQLControlToManagedIdentity: &armsynapse.ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity{
	// 			ActualState: to.Ptr(armsynapse.ActualStateEnabling),
	// 			DesiredState: to.Ptr(armsynapse.DesiredStateEnabled),
	// 		},
	// 	},
	// }
}

Output:

func (*WorkspaceManagedIdentitySQLControlSettingsClient) Get 

func (client *WorkspaceManagedIdentitySQLControlSettingsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspaceManagedIdentitySQLControlSettingsClientGetOptions) (WorkspaceManagedIdentitySQLControlSettingsClientGetResponse, error)

Get - Get Managed Identity Sql Control Settings If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceManagedIdentitySQLControlSettingsClientGetOptions contains the optional parameters for the WorkspaceManagedIdentitySQLControlSettingsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetManagedIdentitySqlControlSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagedIdentitySQLControlSettingsClient().Get(ctx, "resourceGroup1", "workspace1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ManagedIdentitySQLControlSettingsModel = armsynapse.ManagedIdentitySQLControlSettingsModel{
	// 	Name: to.Ptr("default"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/managedIdentitySqlControlSettings/default"),
	// 	Properties: &armsynapse.ManagedIdentitySQLControlSettingsModelProperties{
	// 		GrantSQLControlToManagedIdentity: &armsynapse.ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity{
	// 			ActualState: to.Ptr(armsynapse.ActualStateEnabled),
	// 			DesiredState: to.Ptr(armsynapse.DesiredStateEnabled),
	// 		},
	// 	},
	// }
}

Output:

type WorkspaceManagedIdentitySQLControlSettingsClientBeginCreateOrUpdateOptions added in v0.2.0 

type WorkspaceManagedIdentitySQLControlSettingsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceManagedIdentitySQLControlSettingsClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedIdentitySQLControlSettingsClient.BeginCreateOrUpdate method.

type WorkspaceManagedIdentitySQLControlSettingsClientCreateOrUpdateResponse added in v0.2.0 

type WorkspaceManagedIdentitySQLControlSettingsClientCreateOrUpdateResponse struct {
	// Sql Control Settings for workspace managed identity
	ManagedIdentitySQLControlSettingsModel
}

WorkspaceManagedIdentitySQLControlSettingsClientCreateOrUpdateResponse contains the response from method WorkspaceManagedIdentitySQLControlSettingsClient.BeginCreateOrUpdate.

type WorkspaceManagedIdentitySQLControlSettingsClientGetOptions added in v0.2.0 

type WorkspaceManagedIdentitySQLControlSettingsClientGetOptions struct {
}

WorkspaceManagedIdentitySQLControlSettingsClientGetOptions contains the optional parameters for the WorkspaceManagedIdentitySQLControlSettingsClient.Get method.

type WorkspaceManagedIdentitySQLControlSettingsClientGetResponse added in v0.2.0 

type WorkspaceManagedIdentitySQLControlSettingsClientGetResponse struct {
	// Sql Control Settings for workspace managed identity
	ManagedIdentitySQLControlSettingsModel
}

WorkspaceManagedIdentitySQLControlSettingsClientGetResponse contains the response from method WorkspaceManagedIdentitySQLControlSettingsClient.Get.

type WorkspaceManagedSQLServerBlobAuditingPoliciesClient 

type WorkspaceManagedSQLServerBlobAuditingPoliciesClient struct {
	// contains filtered or unexported fields
}

WorkspaceManagedSQLServerBlobAuditingPoliciesClient contains the methods for the WorkspaceManagedSQLServerBlobAuditingPolicies group. Don't use this type directly, use NewWorkspaceManagedSQLServerBlobAuditingPoliciesClient() instead.

func NewWorkspaceManagedSQLServerBlobAuditingPoliciesClient 

func NewWorkspaceManagedSQLServerBlobAuditingPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceManagedSQLServerBlobAuditingPoliciesClient, error)

NewWorkspaceManagedSQLServerBlobAuditingPoliciesClient creates a new instance of WorkspaceManagedSQLServerBlobAuditingPoliciesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceManagedSQLServerBlobAuditingPoliciesClient) BeginCreateOrUpdate 

func (client *WorkspaceManagedSQLServerBlobAuditingPoliciesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, blobAuditingPolicyName BlobAuditingPolicyName, parameters ServerBlobAuditingPolicy, options *WorkspaceManagedSQLServerBlobAuditingPoliciesClientBeginCreateOrUpdateOptions) (*runtime.Poller[WorkspaceManagedSQLServerBlobAuditingPoliciesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or Update a workspace managed sql server's blob auditing policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • blobAuditingPolicyName - The name of the blob auditing policy.
  • parameters - Properties of extended blob auditing policy.
  • options - WorkspaceManagedSQLServerBlobAuditingPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerBlobAuditingPoliciesClient.BeginCreateOrUpdate method.
Example (CreateOrUpdateBlobAuditingPolicyOfWorkspaceManagedSqlServerWithMinimalParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithMinParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerBlobAuditingPoliciesClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.BlobAuditingPolicyNameDefault, armsynapse.ServerBlobAuditingPolicy{
		Properties: &armsynapse.ServerBlobAuditingPolicyProperties{
			State:                   to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
			StorageAccountAccessKey: to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageEndpoint:         to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerBlobAuditingPolicy = armsynapse.ServerBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/auditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/auditingSettings/default"),
	// 	Properties: &armsynapse.ServerBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 			to.Ptr("SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("FAILED_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("BATCH_COMPLETED_GROUP")},
	// 			IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 			RetentionDays: to.Ptr[int32](6),
	// 			State: to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
	// 			StorageAccountSubscriptionID: to.Ptr("00000000-1234-0000-5678-000000000000"),
	// 			StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 		},
	// 	}
}

Output:
Example (CreateOrUpdateBlobAuditingPolicyOfWorkspaceSqlServerWithAllParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithAllParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerBlobAuditingPoliciesClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.BlobAuditingPolicyNameDefault, armsynapse.ServerBlobAuditingPolicy{
		Properties: &armsynapse.ServerBlobAuditingPolicyProperties{
			AuditActionsAndGroups: []*string{
				to.Ptr("SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"),
				to.Ptr("FAILED_DATABASE_AUTHENTICATION_GROUP"),
				to.Ptr("BATCH_COMPLETED_GROUP")},
			IsAzureMonitorTargetEnabled:  to.Ptr(true),
			IsStorageSecondaryKeyInUse:   to.Ptr(false),
			QueueDelayMs:                 to.Ptr[int32](4000),
			RetentionDays:                to.Ptr[int32](6),
			State:                        to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
			StorageAccountAccessKey:      to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageAccountSubscriptionID: to.Ptr("00000000-1234-0000-5678-000000000000"),
			StorageEndpoint:              to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerBlobAuditingPolicy = armsynapse.ServerBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/auditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/auditingSettings/default"),
	// 	Properties: &armsynapse.ServerBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 			to.Ptr("SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("FAILED_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("BATCH_COMPLETED_GROUP")},
	// 			IsAzureMonitorTargetEnabled: to.Ptr(true),
	// 			IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 			QueueDelayMs: to.Ptr[int32](4000),
	// 			RetentionDays: to.Ptr[int32](6),
	// 			State: to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
	// 			StorageAccountSubscriptionID: to.Ptr("00000000-1234-0000-5678-000000000000"),
	// 			StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 		},
	// 	}
}

Output:

func (*WorkspaceManagedSQLServerBlobAuditingPoliciesClient) Get 

func (client *WorkspaceManagedSQLServerBlobAuditingPoliciesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, blobAuditingPolicyName BlobAuditingPolicyName, options *WorkspaceManagedSQLServerBlobAuditingPoliciesClientGetOptions) (WorkspaceManagedSQLServerBlobAuditingPoliciesClientGetResponse, error)

Get - Get a workspace managed sql server's blob auditing policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • blobAuditingPolicyName - The name of the blob auditing policy.
  • options - WorkspaceManagedSQLServerBlobAuditingPoliciesClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerBlobAuditingPoliciesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetWorkspaceManagedSqlServerBlobAuditingSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagedSQLServerBlobAuditingPoliciesClient().Get(ctx, "wsg-7398", "testWorkspace", armsynapse.BlobAuditingPolicyNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerBlobAuditingPolicy = armsynapse.ServerBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/auditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/auditingSettings/default"),
	// 	Properties: &armsynapse.ServerBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 		},
	// 		IsAzureMonitorTargetEnabled: to.Ptr(false),
	// 		IsDevopsAuditEnabled: to.Ptr(false),
	// 		IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 		RetentionDays: to.Ptr[int32](0),
	// 		State: to.Ptr(armsynapse.BlobAuditingPolicyStateDisabled),
	// 		StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		StorageEndpoint: to.Ptr(""),
	// 	},
	// }
}

Output:

func (*WorkspaceManagedSQLServerBlobAuditingPoliciesClient) NewListByWorkspacePager added in v0.4.0 

func (client *WorkspaceManagedSQLServerBlobAuditingPoliciesClient) NewListByWorkspacePager(resourceGroupName string, workspaceName string, options *WorkspaceManagedSQLServerBlobAuditingPoliciesClientListByWorkspaceOptions) *runtime.Pager[WorkspaceManagedSQLServerBlobAuditingPoliciesClientListByWorkspaceResponse]

NewListByWorkspacePager - List workspace managed sql server's blob auditing policies.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceManagedSQLServerBlobAuditingPoliciesClientListByWorkspaceOptions contains the optional parameters for the WorkspaceManagedSQLServerBlobAuditingPoliciesClient.NewListByWorkspacePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspaceManagedSqlServerBlobAuditingSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkspaceManagedSQLServerBlobAuditingPoliciesClient().NewListByWorkspacePager("wsg-7398", "testWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServerBlobAuditingPolicyListResult = armsynapse.ServerBlobAuditingPolicyListResult{
		// 	Value: []*armsynapse.ServerBlobAuditingPolicy{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/auditingSettings"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/auditingSettings/default"),
		// 			Properties: &armsynapse.ServerBlobAuditingPolicyProperties{
		// 				AuditActionsAndGroups: []*string{
		// 				},
		// 				IsAzureMonitorTargetEnabled: to.Ptr(false),
		// 				IsStorageSecondaryKeyInUse: to.Ptr(false),
		// 				RetentionDays: to.Ptr[int32](0),
		// 				State: to.Ptr(armsynapse.BlobAuditingPolicyStateDisabled),
		// 				StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				StorageEndpoint: to.Ptr(""),
		// 			},
		// 	}},
		// }
	}
}

Output:

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientBeginCreateOrUpdateOptions added in v0.2.0 

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceManagedSQLServerBlobAuditingPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerBlobAuditingPoliciesClient.BeginCreateOrUpdate method.

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientCreateOrUpdateResponse added in v0.2.0 

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientCreateOrUpdateResponse struct {
	// A server blob auditing policy.
	ServerBlobAuditingPolicy
}

WorkspaceManagedSQLServerBlobAuditingPoliciesClientCreateOrUpdateResponse contains the response from method WorkspaceManagedSQLServerBlobAuditingPoliciesClient.BeginCreateOrUpdate.

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientGetOptions added in v0.2.0 

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientGetOptions struct {
}

WorkspaceManagedSQLServerBlobAuditingPoliciesClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerBlobAuditingPoliciesClient.Get method.

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientGetResponse added in v0.2.0 

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientGetResponse struct {
	// A server blob auditing policy.
	ServerBlobAuditingPolicy
}

WorkspaceManagedSQLServerBlobAuditingPoliciesClientGetResponse contains the response from method WorkspaceManagedSQLServerBlobAuditingPoliciesClient.Get.

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientListByWorkspaceOptions added in v0.2.0 

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientListByWorkspaceOptions struct {
}

WorkspaceManagedSQLServerBlobAuditingPoliciesClientListByWorkspaceOptions contains the optional parameters for the WorkspaceManagedSQLServerBlobAuditingPoliciesClient.NewListByWorkspacePager method.

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientListByWorkspaceResponse added in v0.2.0 

type WorkspaceManagedSQLServerBlobAuditingPoliciesClientListByWorkspaceResponse struct {
	// A list of server auditing settings.
	ServerBlobAuditingPolicyListResult
}

WorkspaceManagedSQLServerBlobAuditingPoliciesClientListByWorkspaceResponse contains the response from method WorkspaceManagedSQLServerBlobAuditingPoliciesClient.NewListByWorkspacePager.

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient added in v0.3.0 

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient struct {
	// contains filtered or unexported fields
}

WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient contains the methods for the WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettings group. Don't use this type directly, use NewWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient() instead.

func NewWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient added in v0.3.0 

func NewWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient, error)

NewWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient creates a new instance of WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient) BeginUpdate added in v0.3.0 

func (client *WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient) BeginUpdate(ctx context.Context, resourceGroupName string, workspaceName string, dedicatedSQLminimalTLSSettingsName DedicatedSQLMinimalTLSSettingsName, parameters DedicatedSQLminimalTLSSettings, options *WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientBeginUpdateOptions) (*runtime.Poller[WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientUpdateResponse], error)

BeginUpdate - Update workspace managed sql server's minimal tls settings. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • dedicatedSQLminimalTLSSettingsName - The name of the dedicated sql minimal tls settings.
  • parameters - minimal tls settings
  • options - WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientBeginUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdateWorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient().BeginUpdate(ctx, "workspace-6852", "workspace-2080", armsynapse.DedicatedSQLMinimalTLSSettingsNameDefault, armsynapse.DedicatedSQLminimalTLSSettings{
		Properties: &armsynapse.DedicatedSQLminimalTLSSettingsProperties{
			MinimalTLSVersion: to.Ptr("1.1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DedicatedSQLminimalTLSSettings = armsynapse.DedicatedSQLminimalTLSSettings{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default"),
	// 	Properties: &armsynapse.DedicatedSQLminimalTLSSettingsProperties{
	// 		MinimalTLSVersion: to.Ptr("1.1"),
	// 	},
	// }
}

Output:

func (*WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient) Get added in v0.3.0 

func (client *WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, dedicatedSQLminimalTLSSettingsName string, options *WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientGetOptions) (WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientGetResponse, error)

Get - Get workspace managed sql server's minimal tls settings. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • dedicatedSQLminimalTLSSettingsName - The name of the dedicated sql minimal tls settings.
  • options - WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetWorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient().Get(ctx, "workspace-6852", "workspace-2080", "default", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DedicatedSQLminimalTLSSettings = armsynapse.DedicatedSQLminimalTLSSettings{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armsynapse.DedicatedSQLminimalTLSSettingsProperties{
	// 		MinimalTLSVersion: to.Ptr("1.1"),
	// 	},
	// }
}

Output:

func (*WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient) NewListPager added in v0.4.0 

func (client *WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient) NewListPager(resourceGroupName string, workspaceName string, options *WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientListOptions) *runtime.Pager[WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientListResponse]

NewListPager - List workspace managed sql server's minimal tls settings.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient().NewListPager("workspace-6852", "workspace-2080", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DedicatedSQLminimalTLSSettingsListResult = armsynapse.DedicatedSQLminimalTLSSettingsListResult{
		// 	Value: []*armsynapse.DedicatedSQLminimalTLSSettings{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default"),
		// 			Location: to.Ptr("eastus"),
		// 			Properties: &armsynapse.DedicatedSQLminimalTLSSettingsProperties{
		// 				MinimalTLSVersion: to.Ptr("1.1"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default"),
		// 			Location: to.Ptr("eastus"),
		// 			Properties: &armsynapse.DedicatedSQLminimalTLSSettingsProperties{
		// 				MinimalTLSVersion: to.Ptr("1.1"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientBeginUpdateOptions added in v0.3.0 

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientBeginUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient.BeginUpdate method.

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientGetOptions added in v0.3.0 

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientGetOptions struct {
}

WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient.Get method.

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientGetResponse added in v0.3.0 

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientGetResponse struct {
	// Dedicated Sql Minimal Tls Settings Info
	DedicatedSQLminimalTLSSettings
}

WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientGetResponse contains the response from method WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient.Get.

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientListOptions added in v0.3.0 

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientListOptions struct {
}

WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient.NewListPager method.

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientListResponse added in v0.3.0 

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientListResponse struct {
	// A list of the server's dedicated sql minimal tls settings.
	DedicatedSQLminimalTLSSettingsListResult
}

WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientListResponse contains the response from method WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient.NewListPager.

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientUpdateResponse added in v0.3.0 

type WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientUpdateResponse struct {
	// Dedicated Sql Minimal Tls Settings Info
	DedicatedSQLminimalTLSSettings
}

WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClientUpdateResponse contains the response from method WorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient.BeginUpdate.

type WorkspaceManagedSQLServerEncryptionProtectorClient 

type WorkspaceManagedSQLServerEncryptionProtectorClient struct {
	// contains filtered or unexported fields
}

WorkspaceManagedSQLServerEncryptionProtectorClient contains the methods for the WorkspaceManagedSQLServerEncryptionProtector group. Don't use this type directly, use NewWorkspaceManagedSQLServerEncryptionProtectorClient() instead.

func NewWorkspaceManagedSQLServerEncryptionProtectorClient 

func NewWorkspaceManagedSQLServerEncryptionProtectorClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceManagedSQLServerEncryptionProtectorClient, error)

NewWorkspaceManagedSQLServerEncryptionProtectorClient creates a new instance of WorkspaceManagedSQLServerEncryptionProtectorClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceManagedSQLServerEncryptionProtectorClient) BeginCreateOrUpdate 

func (client *WorkspaceManagedSQLServerEncryptionProtectorClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, encryptionProtectorName EncryptionProtectorName, parameters EncryptionProtector, options *WorkspaceManagedSQLServerEncryptionProtectorClientBeginCreateOrUpdateOptions) (*runtime.Poller[WorkspaceManagedSQLServerEncryptionProtectorClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Updates workspace managed sql server's encryption protector. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • encryptionProtectorName - The name of the encryption protector.
  • parameters - The requested encryption protector resource state.
  • options - WorkspaceManagedSQLServerEncryptionProtectorClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerEncryptionProtectorClient.BeginCreateOrUpdate method.
Example (UpdateTheEncryptionProtectorToKeyVault)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateKeyVault.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerEncryptionProtectorClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.EncryptionProtectorNameCurrent, armsynapse.EncryptionProtector{
		Properties: &armsynapse.EncryptionProtectorProperties{
			ServerKeyName: to.Ptr("someVault_someKey_01234567890123456789012345678901"),
			ServerKeyType: to.Ptr(armsynapse.ServerKeyTypeAzureKeyVault),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.EncryptionProtector = armsynapse.EncryptionProtector{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/encryptionProtector"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current"),
	// 	Kind: to.Ptr("azurekeyvault"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armsynapse.EncryptionProtectorProperties{
	// 		ServerKeyName: to.Ptr("someVault_someKey_01234567890123456789012345678901"),
	// 		ServerKeyType: to.Ptr(armsynapse.ServerKeyTypeAzureKeyVault),
	// 	},
	// }
}

Output:
Example (UpdateTheEncryptionProtectorToServiceManaged)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateServiceManaged.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerEncryptionProtectorClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.EncryptionProtectorNameCurrent, armsynapse.EncryptionProtector{
		Properties: &armsynapse.EncryptionProtectorProperties{
			ServerKeyName: to.Ptr("ServiceManaged"),
			ServerKeyType: to.Ptr(armsynapse.ServerKeyTypeServiceManaged),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.EncryptionProtector = armsynapse.EncryptionProtector{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/encryptionProtector"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current"),
	// 	Kind: to.Ptr("servicemanaged"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armsynapse.EncryptionProtectorProperties{
	// 		ServerKeyName: to.Ptr("ServiceManaged"),
	// 		ServerKeyType: to.Ptr(armsynapse.ServerKeyTypeServiceManaged),
	// 	},
	// }
}

Output:

func (*WorkspaceManagedSQLServerEncryptionProtectorClient) BeginRevalidate 

func (client *WorkspaceManagedSQLServerEncryptionProtectorClient) BeginRevalidate(ctx context.Context, resourceGroupName string, workspaceName string, encryptionProtectorName EncryptionProtectorName, options *WorkspaceManagedSQLServerEncryptionProtectorClientBeginRevalidateOptions) (*runtime.Poller[WorkspaceManagedSQLServerEncryptionProtectorClientRevalidateResponse], error)

BeginRevalidate - Revalidates workspace managed sql server's existing encryption protector. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • encryptionProtectorName - The name of the encryption protector.
  • options - WorkspaceManagedSQLServerEncryptionProtectorClientBeginRevalidateOptions contains the optional parameters for the WorkspaceManagedSQLServerEncryptionProtectorClient.BeginRevalidate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerEncryptionProtectorRevalidate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerEncryptionProtectorClient().BeginRevalidate(ctx, "wsg-7398", "testWorkspace", armsynapse.EncryptionProtectorNameCurrent, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*WorkspaceManagedSQLServerEncryptionProtectorClient) Get 

func (client *WorkspaceManagedSQLServerEncryptionProtectorClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, encryptionProtectorName EncryptionProtectorName, options *WorkspaceManagedSQLServerEncryptionProtectorClientGetOptions) (WorkspaceManagedSQLServerEncryptionProtectorClientGetResponse, error)

Get - Get workspace managed sql server's encryption protector. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • encryptionProtectorName - The name of the encryption protector.
  • options - WorkspaceManagedSQLServerEncryptionProtectorClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerEncryptionProtectorClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetWorkspaceManagedSqlServerEncryptionProtector.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagedSQLServerEncryptionProtectorClient().Get(ctx, "wsg-7398", "testWorkspace", armsynapse.EncryptionProtectorNameCurrent, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.EncryptionProtector = armsynapse.EncryptionProtector{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/encryptionProtector"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current"),
	// 	Kind: to.Ptr("azurekeyvault"),
	// 	Location: to.Ptr("Japan East"),
	// 	Properties: &armsynapse.EncryptionProtectorProperties{
	// 		ServerKeyName: to.Ptr("someVault_someKey_01234567890123456789012345678901"),
	// 		ServerKeyType: to.Ptr(armsynapse.ServerKeyTypeAzureKeyVault),
	// 		URI: to.Ptr("https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"),
	// 	},
	// }
}

Output:

func (*WorkspaceManagedSQLServerEncryptionProtectorClient) NewListPager added in v0.4.0 

func (client *WorkspaceManagedSQLServerEncryptionProtectorClient) NewListPager(resourceGroupName string, workspaceName string, options *WorkspaceManagedSQLServerEncryptionProtectorClientListOptions) *runtime.Pager[WorkspaceManagedSQLServerEncryptionProtectorClientListResponse]

NewListPager - Get list of encryption protectors for workspace managed sql server.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceManagedSQLServerEncryptionProtectorClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerEncryptionProtectorClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetWorkspaceManagedSqlServerEncryptionProtectorList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkspaceManagedSQLServerEncryptionProtectorClient().NewListPager("wsg-7398", "testWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.EncryptionProtectorListResult = armsynapse.EncryptionProtectorListResult{
		// 	Value: []*armsynapse.EncryptionProtector{
		// 		{
		// 			Name: to.Ptr("current"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/encryptionProtector"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current"),
		// 			Kind: to.Ptr("azurekeyvault"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.EncryptionProtectorProperties{
		// 				ServerKeyName: to.Ptr("someVault_someKey_01234567890123456789012345678901"),
		// 				ServerKeyType: to.Ptr(armsynapse.ServerKeyTypeAzureKeyVault),
		// 				URI: to.Ptr("https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type WorkspaceManagedSQLServerEncryptionProtectorClientBeginCreateOrUpdateOptions added in v0.2.0 

type WorkspaceManagedSQLServerEncryptionProtectorClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceManagedSQLServerEncryptionProtectorClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerEncryptionProtectorClient.BeginCreateOrUpdate method.

type WorkspaceManagedSQLServerEncryptionProtectorClientBeginRevalidateOptions added in v0.2.0 

type WorkspaceManagedSQLServerEncryptionProtectorClientBeginRevalidateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceManagedSQLServerEncryptionProtectorClientBeginRevalidateOptions contains the optional parameters for the WorkspaceManagedSQLServerEncryptionProtectorClient.BeginRevalidate method.

type WorkspaceManagedSQLServerEncryptionProtectorClientCreateOrUpdateResponse added in v0.2.0 

type WorkspaceManagedSQLServerEncryptionProtectorClientCreateOrUpdateResponse struct {
	// The server encryption protector.
	EncryptionProtector
}

WorkspaceManagedSQLServerEncryptionProtectorClientCreateOrUpdateResponse contains the response from method WorkspaceManagedSQLServerEncryptionProtectorClient.BeginCreateOrUpdate.

type WorkspaceManagedSQLServerEncryptionProtectorClientGetOptions added in v0.2.0 

type WorkspaceManagedSQLServerEncryptionProtectorClientGetOptions struct {
}

WorkspaceManagedSQLServerEncryptionProtectorClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerEncryptionProtectorClient.Get method.

type WorkspaceManagedSQLServerEncryptionProtectorClientGetResponse added in v0.2.0 

type WorkspaceManagedSQLServerEncryptionProtectorClientGetResponse struct {
	// The server encryption protector.
	EncryptionProtector
}

WorkspaceManagedSQLServerEncryptionProtectorClientGetResponse contains the response from method WorkspaceManagedSQLServerEncryptionProtectorClient.Get.

type WorkspaceManagedSQLServerEncryptionProtectorClientListOptions added in v0.2.0 

type WorkspaceManagedSQLServerEncryptionProtectorClientListOptions struct {
}

WorkspaceManagedSQLServerEncryptionProtectorClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerEncryptionProtectorClient.NewListPager method.

type WorkspaceManagedSQLServerEncryptionProtectorClientListResponse added in v0.2.0 

type WorkspaceManagedSQLServerEncryptionProtectorClientListResponse struct {
	// A list of server encryption protectors.
	EncryptionProtectorListResult
}

WorkspaceManagedSQLServerEncryptionProtectorClientListResponse contains the response from method WorkspaceManagedSQLServerEncryptionProtectorClient.NewListPager.

type WorkspaceManagedSQLServerEncryptionProtectorClientRevalidateResponse added in v0.2.0 

type WorkspaceManagedSQLServerEncryptionProtectorClientRevalidateResponse struct {
}

WorkspaceManagedSQLServerEncryptionProtectorClientRevalidateResponse contains the response from method WorkspaceManagedSQLServerEncryptionProtectorClient.BeginRevalidate.

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient 

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient struct {
	// contains filtered or unexported fields
}

WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient contains the methods for the WorkspaceManagedSQLServerExtendedBlobAuditingPolicies group. Don't use this type directly, use NewWorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient() instead.

func NewWorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient 

func NewWorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient, error)

NewWorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient creates a new instance of WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient) BeginCreateOrUpdate 

func (client *WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, blobAuditingPolicyName BlobAuditingPolicyName, parameters ExtendedServerBlobAuditingPolicy, options *WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientBeginCreateOrUpdateOptions) (*runtime.Poller[WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or Update a workspace managed sql server's extended blob auditing policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • blobAuditingPolicyName - The name of the blob auditing policy.
  • parameters - Properties of extended blob auditing policy.
  • options - WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient.BeginCreateOrUpdate method.
Example (CreateOrUpdateWorkspaceManagedSqlServersExtendedBlobAuditingPolicyOfWithAllParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateWorkspaceManagedSqlServerExtendedBlobAuditingSettingsWithAllParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.BlobAuditingPolicyNameDefault, armsynapse.ExtendedServerBlobAuditingPolicy{
		Properties: &armsynapse.ExtendedServerBlobAuditingPolicyProperties{
			AuditActionsAndGroups: []*string{
				to.Ptr("SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"),
				to.Ptr("FAILED_DATABASE_AUTHENTICATION_GROUP"),
				to.Ptr("BATCH_COMPLETED_GROUP")},
			IsAzureMonitorTargetEnabled:  to.Ptr(true),
			IsStorageSecondaryKeyInUse:   to.Ptr(false),
			PredicateExpression:          to.Ptr("object_name = 'SensitiveData'"),
			RetentionDays:                to.Ptr[int32](6),
			State:                        to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
			StorageAccountAccessKey:      to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageAccountSubscriptionID: to.Ptr("00000000-1234-0000-5678-000000000000"),
			StorageEndpoint:              to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExtendedServerBlobAuditingPolicy = armsynapse.ExtendedServerBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/extendedAuditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/extendedAuditingSettings/default"),
	// 	Properties: &armsynapse.ExtendedServerBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 			to.Ptr("SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("FAILED_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("BATCH_COMPLETED_GROUP")},
	// 			IsAzureMonitorTargetEnabled: to.Ptr(true),
	// 			IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 			PredicateExpression: to.Ptr("object_name = 'SensitiveData'"),
	// 			RetentionDays: to.Ptr[int32](6),
	// 			State: to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
	// 			StorageAccountSubscriptionID: to.Ptr("00000000-1234-0000-5678-000000000000"),
	// 			StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 		},
	// 	}
}

Output:
Example (CreateOrUpdateWorkspaceManagedSqlServersExtendedBlobAuditingPolicyOfWithMinimalParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateWorkspaceManagedSqlServerExetendedBlobAuditingSettingsWithMinParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.BlobAuditingPolicyNameDefault, armsynapse.ExtendedServerBlobAuditingPolicy{
		Properties: &armsynapse.ExtendedServerBlobAuditingPolicyProperties{
			State:                   to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
			StorageAccountAccessKey: to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageEndpoint:         to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExtendedServerBlobAuditingPolicy = armsynapse.ExtendedServerBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/extendedAuditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/extendedAuditingSettings/default"),
	// 	Properties: &armsynapse.ExtendedServerBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 			to.Ptr("SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("FAILED_DATABASE_AUTHENTICATION_GROUP"),
	// 			to.Ptr("BATCH_COMPLETED_GROUP")},
	// 			IsAzureMonitorTargetEnabled: to.Ptr(false),
	// 			IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 			RetentionDays: to.Ptr[int32](6),
	// 			State: to.Ptr(armsynapse.BlobAuditingPolicyStateEnabled),
	// 			StorageAccountSubscriptionID: to.Ptr("00000000-1234-0000-5678-000000000000"),
	// 			StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 		},
	// 	}
}

Output:

func (*WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient) Get 

func (client *WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, blobAuditingPolicyName BlobAuditingPolicyName, options *WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientGetOptions) (WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientGetResponse, error)

Get - Get a workspace SQL server's extended blob auditing policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • blobAuditingPolicyName - The name of the blob auditing policy.
  • options - WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetWorkspaceManagedSqlExtendedServerBlobAuditingSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient().Get(ctx, "wsg-7398", "testWorkspace", armsynapse.BlobAuditingPolicyNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExtendedServerBlobAuditingPolicy = armsynapse.ExtendedServerBlobAuditingPolicy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/extendedAuditingSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/extendedAuditingSettings/default"),
	// 	Properties: &armsynapse.ExtendedServerBlobAuditingPolicyProperties{
	// 		AuditActionsAndGroups: []*string{
	// 		},
	// 		IsAzureMonitorTargetEnabled: to.Ptr(false),
	// 		IsStorageSecondaryKeyInUse: to.Ptr(false),
	// 		PredicateExpression: to.Ptr("object_name = 'SensitiveData'"),
	// 		RetentionDays: to.Ptr[int32](0),
	// 		State: to.Ptr(armsynapse.BlobAuditingPolicyStateDisabled),
	// 		StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		StorageEndpoint: to.Ptr(""),
	// 	},
	// }
}

Output:

func (*WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient) NewListByWorkspacePager added in v0.4.0 

func (client *WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient) NewListByWorkspacePager(resourceGroupName string, workspaceName string, options *WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientListByWorkspaceOptions) *runtime.Pager[WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientListByWorkspaceResponse]

NewListByWorkspacePager - List workspace managed sql server's extended blob auditing policies.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientListByWorkspaceOptions contains the optional parameters for the WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient.NewListByWorkspacePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspaceManagedSqlServerExtendedBlobAuditingSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient().NewListByWorkspacePager("wsg-7398", "testWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ExtendedServerBlobAuditingPolicyListResult = armsynapse.ExtendedServerBlobAuditingPolicyListResult{
		// 	Value: []*armsynapse.ExtendedServerBlobAuditingPolicy{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/extendedAuditingSettings"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/extendedAuditingSettings/default"),
		// 			Properties: &armsynapse.ExtendedServerBlobAuditingPolicyProperties{
		// 				AuditActionsAndGroups: []*string{
		// 				},
		// 				IsAzureMonitorTargetEnabled: to.Ptr(false),
		// 				IsStorageSecondaryKeyInUse: to.Ptr(false),
		// 				PredicateExpression: to.Ptr("object_name = 'SensitiveData'"),
		// 				RetentionDays: to.Ptr[int32](0),
		// 				State: to.Ptr(armsynapse.BlobAuditingPolicyStateDisabled),
		// 				StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				StorageEndpoint: to.Ptr(""),
		// 			},
		// 	}},
		// }
	}
}

Output:

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientBeginCreateOrUpdateOptions added in v0.2.0 

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient.BeginCreateOrUpdate method.

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientCreateOrUpdateResponse added in v0.2.0 

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientCreateOrUpdateResponse struct {
	// An extended server blob auditing policy.
	ExtendedServerBlobAuditingPolicy
}

WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientCreateOrUpdateResponse contains the response from method WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient.BeginCreateOrUpdate.

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientGetOptions added in v0.2.0 

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientGetOptions struct {
}

WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient.Get method.

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientGetResponse added in v0.2.0 

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientGetResponse struct {
	// An extended server blob auditing policy.
	ExtendedServerBlobAuditingPolicy
}

WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientGetResponse contains the response from method WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient.Get.

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientListByWorkspaceOptions added in v0.2.0 

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientListByWorkspaceOptions struct {
}

WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientListByWorkspaceOptions contains the optional parameters for the WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient.NewListByWorkspacePager method.

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientListByWorkspaceResponse added in v0.2.0 

type WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientListByWorkspaceResponse struct {
	// A list of server extended auditing settings.
	ExtendedServerBlobAuditingPolicyListResult
}

WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClientListByWorkspaceResponse contains the response from method WorkspaceManagedSQLServerExtendedBlobAuditingPoliciesClient.NewListByWorkspacePager.

type WorkspaceManagedSQLServerRecoverableSQLPoolsClient 

type WorkspaceManagedSQLServerRecoverableSQLPoolsClient struct {
	// contains filtered or unexported fields
}

WorkspaceManagedSQLServerRecoverableSQLPoolsClient contains the methods for the WorkspaceManagedSQLServerRecoverableSQLPools group. Don't use this type directly, use NewWorkspaceManagedSQLServerRecoverableSQLPoolsClient() instead.

func NewWorkspaceManagedSQLServerRecoverableSQLPoolsClient 

func NewWorkspaceManagedSQLServerRecoverableSQLPoolsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceManagedSQLServerRecoverableSQLPoolsClient, error)

NewWorkspaceManagedSQLServerRecoverableSQLPoolsClient creates a new instance of WorkspaceManagedSQLServerRecoverableSQLPoolsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceManagedSQLServerRecoverableSQLPoolsClient) Get 

func (client *WorkspaceManagedSQLServerRecoverableSQLPoolsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, sqlPoolName string, options *WorkspaceManagedSQLServerRecoverableSQLPoolsClientGetOptions) (WorkspaceManagedSQLServerRecoverableSQLPoolsClientGetResponse, error)

Get - Get recoverable sql pools for workspace managed sql server. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • sqlPoolName - The name of the sql pool
  • options - WorkspaceManagedSQLServerRecoverableSQLPoolsClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerRecoverableSQLPoolsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetWorkspaceManagedSqlServerRecoverableSqlPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagedSQLServerRecoverableSQLPoolsClient().Get(ctx, "wsg-7398", "testWorkspace", "recoverableSqlpools-1235", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RecoverableSQLPool = armsynapse.RecoverableSQLPool{
	// 	Name: to.Ptr("recoverableSqlpools-1235"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/recoverableSqlpools"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/recoverableSqlpools/recoverableSqlpools-1235"),
	// 	Properties: &armsynapse.RecoverableSQLPoolProperties{
	// 		Edition: to.Ptr("Standard"),
	// 		LastAvailableBackupDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T01:06:29.780Z"); return t}()),
	// 		ServiceLevelObjective: to.Ptr("S0"),
	// 	},
	// }
}

Output:

func (*WorkspaceManagedSQLServerRecoverableSQLPoolsClient) NewListPager added in v0.4.0 

func (client *WorkspaceManagedSQLServerRecoverableSQLPoolsClient) NewListPager(resourceGroupName string, workspaceName string, options *WorkspaceManagedSQLServerRecoverableSQLPoolsClientListOptions) *runtime.Pager[WorkspaceManagedSQLServerRecoverableSQLPoolsClientListResponse]

NewListPager - Get list of recoverable sql pools for workspace managed sql server.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceManagedSQLServerRecoverableSQLPoolsClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerRecoverableSQLPoolsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspaceManagedSqlServerRecoverableSqlPool.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkspaceManagedSQLServerRecoverableSQLPoolsClient().NewListPager("wsg-7398", "testWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RecoverableSQLPoolListResult = armsynapse.RecoverableSQLPoolListResult{
		// 	Value: []*armsynapse.RecoverableSQLPool{
		// 		{
		// 			Name: to.Ptr("recoverableSqlpools-1235"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/recoverableSqlpools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/recoverableSqlpools/recoverableSqlpools-1235"),
		// 			Properties: &armsynapse.RecoverableSQLPoolProperties{
		// 				Edition: to.Ptr("Standard"),
		// 				LastAvailableBackupDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T01:06:29.780Z"); return t}()),
		// 				ServiceLevelObjective: to.Ptr("S0"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("recoverableSqlpools-9231"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/recoverableSqlpools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/recoverableSqlpools/recoverableSqlpools-9231"),
		// 			Properties: &armsynapse.RecoverableSQLPoolProperties{
		// 				Edition: to.Ptr("Premium"),
		// 				LastAvailableBackupDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T03:20:31.780Z"); return t}()),
		// 				ServiceLevelObjective: to.Ptr("P1"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("recoverableSqlpools-0342"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/recoverableSqlpools"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/recoverableSqlpools/recoverableSqlpools-0342"),
		// 			Properties: &armsynapse.RecoverableSQLPoolProperties{
		// 				Edition: to.Ptr("Basic"),
		// 				LastAvailableBackupDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-24T02:06:18.780Z"); return t}()),
		// 				ServiceLevelObjective: to.Ptr("Basic"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type WorkspaceManagedSQLServerRecoverableSQLPoolsClientGetOptions added in v0.2.0 

type WorkspaceManagedSQLServerRecoverableSQLPoolsClientGetOptions struct {
}

WorkspaceManagedSQLServerRecoverableSQLPoolsClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerRecoverableSQLPoolsClient.Get method.

type WorkspaceManagedSQLServerRecoverableSQLPoolsClientGetResponse added in v0.2.0 

type WorkspaceManagedSQLServerRecoverableSQLPoolsClientGetResponse struct {
	// A recoverable sql pool
	RecoverableSQLPool
}

WorkspaceManagedSQLServerRecoverableSQLPoolsClientGetResponse contains the response from method WorkspaceManagedSQLServerRecoverableSQLPoolsClient.Get.

type WorkspaceManagedSQLServerRecoverableSQLPoolsClientListOptions added in v0.2.0 

type WorkspaceManagedSQLServerRecoverableSQLPoolsClientListOptions struct {
}

WorkspaceManagedSQLServerRecoverableSQLPoolsClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerRecoverableSQLPoolsClient.NewListPager method.

type WorkspaceManagedSQLServerRecoverableSQLPoolsClientListResponse added in v0.2.0 

type WorkspaceManagedSQLServerRecoverableSQLPoolsClientListResponse struct {
	// The response to a list recoverable sql pools request
	RecoverableSQLPoolListResult
}

WorkspaceManagedSQLServerRecoverableSQLPoolsClientListResponse contains the response from method WorkspaceManagedSQLServerRecoverableSQLPoolsClient.NewListPager.

type WorkspaceManagedSQLServerSecurityAlertPolicyClient 

type WorkspaceManagedSQLServerSecurityAlertPolicyClient struct {
	// contains filtered or unexported fields
}

WorkspaceManagedSQLServerSecurityAlertPolicyClient contains the methods for the WorkspaceManagedSQLServerSecurityAlertPolicy group. Don't use this type directly, use NewWorkspaceManagedSQLServerSecurityAlertPolicyClient() instead.

func NewWorkspaceManagedSQLServerSecurityAlertPolicyClient 

func NewWorkspaceManagedSQLServerSecurityAlertPolicyClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceManagedSQLServerSecurityAlertPolicyClient, error)

NewWorkspaceManagedSQLServerSecurityAlertPolicyClient creates a new instance of WorkspaceManagedSQLServerSecurityAlertPolicyClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceManagedSQLServerSecurityAlertPolicyClient) BeginCreateOrUpdate 

func (client *WorkspaceManagedSQLServerSecurityAlertPolicyClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, securityAlertPolicyName SecurityAlertPolicyNameAutoGenerated, parameters ServerSecurityAlertPolicy, options *WorkspaceManagedSQLServerSecurityAlertPolicyClientBeginCreateOrUpdateOptions) (*runtime.Poller[WorkspaceManagedSQLServerSecurityAlertPolicyClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or Update a workspace managed sql server's threat detection policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • securityAlertPolicyName - The name of the security alert policy.
  • parameters - The workspace managed sql server security alert policy.
  • options - WorkspaceManagedSQLServerSecurityAlertPolicyClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerSecurityAlertPolicyClient.BeginCreateOrUpdate method.
Example (UpdateAWorkspaceManagedSqlServersThreatDetectionPolicyWithAllParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertWithAllParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerSecurityAlertPolicyClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.SecurityAlertPolicyNameAutoGeneratedDefault, armsynapse.ServerSecurityAlertPolicy{
		Properties: &armsynapse.ServerSecurityAlertPolicyProperties{
			DisabledAlerts: []*string{
				to.Ptr("Access_Anomaly"),
				to.Ptr("Usage_Anomaly")},
			EmailAccountAdmins: to.Ptr(true),
			EmailAddresses: []*string{
				to.Ptr("testSecurityAlert@microsoft.com")},
			RetentionDays:           to.Ptr[int32](5),
			State:                   to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
			StorageAccountAccessKey: to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageEndpoint:         to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerSecurityAlertPolicy = armsynapse.ServerSecurityAlertPolicy{
	// 	Name: to.Ptr("Default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/securityAlertPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default"),
	// 	Properties: &armsynapse.ServerSecurityAlertPolicyProperties{
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-23T04:52:49.520Z"); return t}()),
	// 		DisabledAlerts: []*string{
	// 			to.Ptr("Access_Anomaly"),
	// 			to.Ptr("Usage_Anomaly")},
	// 			EmailAccountAdmins: to.Ptr(true),
	// 			EmailAddresses: []*string{
	// 				to.Ptr("testSecurityAlert@microsoft.com")},
	// 				RetentionDays: to.Ptr[int32](5),
	// 				State: to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
	// 				StorageAccountAccessKey: to.Ptr(""),
	// 				StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 			},
	// 		}
}

Output:
Example (UpdateAWorkspaceManagedSqlServersThreatDetectionPolicyWithMinimalParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertCreateWithMinParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerSecurityAlertPolicyClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.SecurityAlertPolicyNameAutoGeneratedDefault, armsynapse.ServerSecurityAlertPolicy{
		Properties: &armsynapse.ServerSecurityAlertPolicyProperties{
			EmailAccountAdmins:      to.Ptr(true),
			State:                   to.Ptr(armsynapse.SecurityAlertPolicyStateDisabled),
			StorageAccountAccessKey: to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageEndpoint:         to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerSecurityAlertPolicy = armsynapse.ServerSecurityAlertPolicy{
	// 	Name: to.Ptr("Default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/securityAlertPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default"),
	// 	Properties: &armsynapse.ServerSecurityAlertPolicyProperties{
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-23T04:52:49.520Z"); return t}()),
	// 		DisabledAlerts: []*string{
	// 			to.Ptr("")},
	// 			EmailAccountAdmins: to.Ptr(true),
	// 			EmailAddresses: []*string{
	// 				to.Ptr("")},
	// 				RetentionDays: to.Ptr[int32](0),
	// 				State: to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
	// 				StorageAccountAccessKey: to.Ptr(""),
	// 				StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 			},
	// 		}
}

Output:

func (*WorkspaceManagedSQLServerSecurityAlertPolicyClient) Get 

func (client *WorkspaceManagedSQLServerSecurityAlertPolicyClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, securityAlertPolicyName SecurityAlertPolicyNameAutoGenerated, options *WorkspaceManagedSQLServerSecurityAlertPolicyClientGetOptions) (WorkspaceManagedSQLServerSecurityAlertPolicyClientGetResponse, error)

Get - Get a workspace managed sql server's security alert policy. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • securityAlertPolicyName - The name of the security alert policy.
  • options - WorkspaceManagedSQLServerSecurityAlertPolicyClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerSecurityAlertPolicyClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetWorkspaceManagedSqlServerSecurityAlertPolicy.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagedSQLServerSecurityAlertPolicyClient().Get(ctx, "wsg-7398", "testWorkspace", armsynapse.SecurityAlertPolicyNameAutoGeneratedDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerSecurityAlertPolicy = armsynapse.ServerSecurityAlertPolicy{
	// 	Name: to.Ptr("Default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/securityAlertPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default"),
	// 	Properties: &armsynapse.ServerSecurityAlertPolicyProperties{
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-23T04:52:49.520Z"); return t}()),
	// 		DisabledAlerts: []*string{
	// 			to.Ptr("Access_Anomaly")},
	// 			EmailAccountAdmins: to.Ptr(true),
	// 			EmailAddresses: []*string{
	// 				to.Ptr("test@microsoft.com;user@microsoft.com")},
	// 				RetentionDays: to.Ptr[int32](0),
	// 				State: to.Ptr(armsynapse.SecurityAlertPolicyStateDisabled),
	// 				StorageAccountAccessKey: to.Ptr(""),
	// 				StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 			},
	// 		}
}

Output:

func (*WorkspaceManagedSQLServerSecurityAlertPolicyClient) NewListPager added in v0.4.0 

func (client *WorkspaceManagedSQLServerSecurityAlertPolicyClient) NewListPager(resourceGroupName string, workspaceName string, options *WorkspaceManagedSQLServerSecurityAlertPolicyClientListOptions) *runtime.Pager[WorkspaceManagedSQLServerSecurityAlertPolicyClientListResponse]

NewListPager - Get workspace managed sql server's threat detection policies.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceManagedSQLServerSecurityAlertPolicyClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerSecurityAlertPolicyClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspaceManagedSqlServerSecurityAlertPolicies.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkspaceManagedSQLServerSecurityAlertPolicyClient().NewListPager("wsg-7398", "testWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServerSecurityAlertPolicyListResult = armsynapse.ServerSecurityAlertPolicyListResult{
		// 	Value: []*armsynapse.ServerSecurityAlertPolicy{
		// 		{
		// 			Name: to.Ptr("Default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/securityAlertPolicies"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies"),
		// 			Properties: &armsynapse.ServerSecurityAlertPolicyProperties{
		// 				CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-23T04:52:49.520Z"); return t}()),
		// 				DisabledAlerts: []*string{
		// 					to.Ptr("Access_Anomaly")},
		// 					EmailAccountAdmins: to.Ptr(true),
		// 					EmailAddresses: []*string{
		// 						to.Ptr("test@microsoft.com;user@microsoft.com")},
		// 						RetentionDays: to.Ptr[int32](0),
		// 						State: to.Ptr(armsynapse.SecurityAlertPolicyStateDisabled),
		// 						StorageAccountAccessKey: to.Ptr(""),
		// 						StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
		// 					},
		// 			}},
		// 		}
	}
}

Output:

type WorkspaceManagedSQLServerSecurityAlertPolicyClientBeginCreateOrUpdateOptions added in v0.2.0 

type WorkspaceManagedSQLServerSecurityAlertPolicyClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceManagedSQLServerSecurityAlertPolicyClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerSecurityAlertPolicyClient.BeginCreateOrUpdate method.

type WorkspaceManagedSQLServerSecurityAlertPolicyClientCreateOrUpdateResponse added in v0.2.0 

type WorkspaceManagedSQLServerSecurityAlertPolicyClientCreateOrUpdateResponse struct {
	// Workspace managed Sql server security alert policy.
	ServerSecurityAlertPolicy
}

WorkspaceManagedSQLServerSecurityAlertPolicyClientCreateOrUpdateResponse contains the response from method WorkspaceManagedSQLServerSecurityAlertPolicyClient.BeginCreateOrUpdate.

type WorkspaceManagedSQLServerSecurityAlertPolicyClientGetOptions added in v0.2.0 

type WorkspaceManagedSQLServerSecurityAlertPolicyClientGetOptions struct {
}

WorkspaceManagedSQLServerSecurityAlertPolicyClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerSecurityAlertPolicyClient.Get method.

type WorkspaceManagedSQLServerSecurityAlertPolicyClientGetResponse added in v0.2.0 

type WorkspaceManagedSQLServerSecurityAlertPolicyClientGetResponse struct {
	// Workspace managed Sql server security alert policy.
	ServerSecurityAlertPolicy
}

WorkspaceManagedSQLServerSecurityAlertPolicyClientGetResponse contains the response from method WorkspaceManagedSQLServerSecurityAlertPolicyClient.Get.

type WorkspaceManagedSQLServerSecurityAlertPolicyClientListOptions added in v0.2.0 

type WorkspaceManagedSQLServerSecurityAlertPolicyClientListOptions struct {
}

WorkspaceManagedSQLServerSecurityAlertPolicyClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerSecurityAlertPolicyClient.NewListPager method.

type WorkspaceManagedSQLServerSecurityAlertPolicyClientListResponse added in v0.2.0 

type WorkspaceManagedSQLServerSecurityAlertPolicyClientListResponse struct {
	// A list of the workspace managed sql server's security alert policies.
	ServerSecurityAlertPolicyListResult
}

WorkspaceManagedSQLServerSecurityAlertPolicyClientListResponse contains the response from method WorkspaceManagedSQLServerSecurityAlertPolicyClient.NewListPager.

type WorkspaceManagedSQLServerUsagesClient 

type WorkspaceManagedSQLServerUsagesClient struct {
	// contains filtered or unexported fields
}

WorkspaceManagedSQLServerUsagesClient contains the methods for the WorkspaceManagedSQLServerUsages group. Don't use this type directly, use NewWorkspaceManagedSQLServerUsagesClient() instead.

func NewWorkspaceManagedSQLServerUsagesClient 

func NewWorkspaceManagedSQLServerUsagesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceManagedSQLServerUsagesClient, error)

NewWorkspaceManagedSQLServerUsagesClient creates a new instance of WorkspaceManagedSQLServerUsagesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceManagedSQLServerUsagesClient) NewListPager added in v0.4.0 

func (client *WorkspaceManagedSQLServerUsagesClient) NewListPager(resourceGroupName string, workspaceName string, options *WorkspaceManagedSQLServerUsagesClientListOptions) *runtime.Pager[WorkspaceManagedSQLServerUsagesClientListResponse]

NewListPager - Get list of server usages metric for workspace managed sql server.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceManagedSQLServerUsagesClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerUsagesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspaceManagedSqlServerUsages.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkspaceManagedSQLServerUsagesClient().NewListPager("wsg-7398", "testWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServerUsageListResult = armsynapse.ServerUsageListResult{
		// 	Value: []*armsynapse.ServerUsage{
		// 		{
		// 			Name: to.Ptr("server_dtu_quota"),
		// 			CurrentValue: to.Ptr[float64](0),
		// 			DisplayName: to.Ptr("Database Throughput Unit Quota"),
		// 			Limit: to.Ptr[float64](45000),
		// 			ResourceName: to.Ptr("testWorkspace"),
		// 			Unit: to.Ptr("DTUs"),
		// 		},
		// 		{
		// 			Name: to.Ptr("server_dtu_quota_current"),
		// 			CurrentValue: to.Ptr[float64](0),
		// 			DisplayName: to.Ptr("Database Throughput Unit Quota"),
		// 			Limit: to.Ptr[float64](45000),
		// 			ResourceName: to.Ptr("testWorkspace"),
		// 			Unit: to.Ptr("DTUs"),
		// 	}},
		// }
	}
}

Output:

type WorkspaceManagedSQLServerUsagesClientListOptions added in v0.2.0 

type WorkspaceManagedSQLServerUsagesClientListOptions struct {
}

WorkspaceManagedSQLServerUsagesClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerUsagesClient.NewListPager method.

type WorkspaceManagedSQLServerUsagesClientListResponse added in v0.2.0 

type WorkspaceManagedSQLServerUsagesClientListResponse struct {
	// Represents the response to a list server metrics request.
	ServerUsageListResult
}

WorkspaceManagedSQLServerUsagesClientListResponse contains the response from method WorkspaceManagedSQLServerUsagesClient.NewListPager.

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClient 

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClient struct {
	// contains filtered or unexported fields
}

WorkspaceManagedSQLServerVulnerabilityAssessmentsClient contains the methods for the WorkspaceManagedSQLServerVulnerabilityAssessments group. Don't use this type directly, use NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient() instead.

func NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient 

func NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceManagedSQLServerVulnerabilityAssessmentsClient, error)

NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient creates a new instance of WorkspaceManagedSQLServerVulnerabilityAssessmentsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceManagedSQLServerVulnerabilityAssessmentsClient) CreateOrUpdate 

func (client *WorkspaceManagedSQLServerVulnerabilityAssessmentsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, parameters ServerVulnerabilityAssessment, options *WorkspaceManagedSQLServerVulnerabilityAssessmentsClientCreateOrUpdateOptions) (WorkspaceManagedSQLServerVulnerabilityAssessmentsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or Update workspace managed sql server's vulnerability assessment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • parameters - Properties for vulnerability assessment.
  • options - WorkspaceManagedSQLServerVulnerabilityAssessmentsClientCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.CreateOrUpdate method.
Example (CreateOrUpdateAWorkspaceManagedSqlServersVulnerabilityAssessmentWithAllParameters)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/PutWorkspaceManagedSqlServerVulnerabilityAssessmentWithAllParameters.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient().CreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.VulnerabilityAssessmentNameDefault, armsynapse.ServerVulnerabilityAssessment{
		Properties: &armsynapse.ServerVulnerabilityAssessmentProperties{
			RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
				EmailSubscriptionAdmins: to.Ptr(true),
				Emails: []*string{
					to.Ptr("email1@mail.com"),
					to.Ptr("email2@mail.com")},
				IsEnabled: to.Ptr(true),
			},
			StorageAccountAccessKey: to.Ptr("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"),
			StorageContainerPath:    to.Ptr("https://myStorage.blob.core.windows.net/vulnerability-assessment/"),
			StorageContainerSasKey:  to.Ptr("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerVulnerabilityAssessment = armsynapse.ServerVulnerabilityAssessment{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/vulnerabilityAssessments"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default"),
	// 	Properties: &armsynapse.ServerVulnerabilityAssessmentProperties{
	// 		RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
	// 			EmailSubscriptionAdmins: to.Ptr(true),
	// 			Emails: []*string{
	// 				to.Ptr("email1@mail.com"),
	// 				to.Ptr("email2@mail.com")},
	// 				IsEnabled: to.Ptr(true),
	// 			},
	// 			StorageContainerPath: to.Ptr("https://myStorage.blob.core.windows.net/vulnerability-assessment/"),
	// 		},
	// 	}
}

Output:
Example (CreateOrUpdateAWorkspaceManagedSqlServersVulnerabilityAssessmentWithMinimalParametersWhenStorageAccountAccessKeyIsSpecified)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateStorageAccessKeyMin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient().CreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.VulnerabilityAssessmentNameDefault, armsynapse.ServerVulnerabilityAssessment{
		Properties: &armsynapse.ServerVulnerabilityAssessmentProperties{
			StorageAccountAccessKey: to.Ptr("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"),
			StorageContainerPath:    to.Ptr("https://myStorage.blob.core.windows.net/vulnerability-assessment/"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerVulnerabilityAssessment = armsynapse.ServerVulnerabilityAssessment{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/vulnerabilityAssessments"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default"),
	// 	Properties: &armsynapse.ServerVulnerabilityAssessmentProperties{
	// 		RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
	// 			EmailSubscriptionAdmins: to.Ptr(false),
	// 			Emails: []*string{
	// 			},
	// 			IsEnabled: to.Ptr(true),
	// 		},
	// 		StorageContainerPath: to.Ptr("https://myStorage.blob.core.windows.net/vulnerability-assessment/"),
	// 	},
	// }
}

Output:
Example (CreateOrUpdateAWorkspaceManagedSqlServersVulnerabilityAssessmentWithMinimalParametersWhenStorageContainerSasKeyIsSpecified)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateContainerSasKeyMin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient().CreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.VulnerabilityAssessmentNameDefault, armsynapse.ServerVulnerabilityAssessment{
		Properties: &armsynapse.ServerVulnerabilityAssessmentProperties{
			StorageContainerPath:   to.Ptr("https://myStorage.blob.core.windows.net/vulnerability-assessment/"),
			StorageContainerSasKey: to.Ptr("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerVulnerabilityAssessment = armsynapse.ServerVulnerabilityAssessment{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/vulnerabilityAssessments"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default"),
	// 	Properties: &armsynapse.ServerVulnerabilityAssessmentProperties{
	// 		RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
	// 			EmailSubscriptionAdmins: to.Ptr(false),
	// 			Emails: []*string{
	// 			},
	// 			IsEnabled: to.Ptr(true),
	// 		},
	// 		StorageContainerPath: to.Ptr("https://myStorage.blob.core.windows.net/vulnerability-assessment/"),
	// 	},
	// }
}

Output:

func (*WorkspaceManagedSQLServerVulnerabilityAssessmentsClient) Delete 

func (client *WorkspaceManagedSQLServerVulnerabilityAssessmentsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, options *WorkspaceManagedSQLServerVulnerabilityAssessmentsClientDeleteOptions) (WorkspaceManagedSQLServerVulnerabilityAssessmentsClientDeleteResponse, error)

Delete - Remove workspace managed sql server's vulnerability assessment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • options - WorkspaceManagedSQLServerVulnerabilityAssessmentsClientDeleteOptions contains the optional parameters for the WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteWorkspaceManagedSqlServerVulnerabilityAssessment.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient().Delete(ctx, "wsg-7398", "testWorkspace", armsynapse.VulnerabilityAssessmentNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*WorkspaceManagedSQLServerVulnerabilityAssessmentsClient) Get 

func (client *WorkspaceManagedSQLServerVulnerabilityAssessmentsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, vulnerabilityAssessmentName VulnerabilityAssessmentName, options *WorkspaceManagedSQLServerVulnerabilityAssessmentsClientGetOptions) (WorkspaceManagedSQLServerVulnerabilityAssessmentsClientGetResponse, error)

Get - Get workspace managed sql server's vulnerability assessment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • vulnerabilityAssessmentName - The name of the vulnerability assessment.
  • options - WorkspaceManagedSQLServerVulnerabilityAssessmentsClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetWorkspaceManagedSqlServerVulnerabilityAssessment.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient().Get(ctx, "wsg-7398", "testWorkspace", armsynapse.VulnerabilityAssessmentNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerVulnerabilityAssessment = armsynapse.ServerVulnerabilityAssessment{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/vulnerabilityAssessments"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default"),
	// 	Properties: &armsynapse.ServerVulnerabilityAssessmentProperties{
	// 		RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
	// 			EmailSubscriptionAdmins: to.Ptr(true),
	// 			Emails: []*string{
	// 				to.Ptr("email1@mail.com"),
	// 				to.Ptr("email2@mail.com")},
	// 				IsEnabled: to.Ptr(true),
	// 			},
	// 			StorageContainerPath: to.Ptr("https://myStorage.blob.core.windows.net/vulnerability-assessment/"),
	// 		},
	// 	}
}

Output:

func (*WorkspaceManagedSQLServerVulnerabilityAssessmentsClient) NewListPager added in v0.4.0 

func (client *WorkspaceManagedSQLServerVulnerabilityAssessmentsClient) NewListPager(resourceGroupName string, workspaceName string, options *WorkspaceManagedSQLServerVulnerabilityAssessmentsClientListOptions) *runtime.Pager[WorkspaceManagedSQLServerVulnerabilityAssessmentsClientListResponse]

NewListPager - Lists the vulnerability assessment policies associated with a workspace managed sql server.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceManagedSQLServerVulnerabilityAssessmentsClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspaceManagedSqlServerVulnerabilityAssessmentPolicies.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkspaceManagedSQLServerVulnerabilityAssessmentsClient().NewListPager("wsg-7398", "testWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServerVulnerabilityAssessmentListResult = armsynapse.ServerVulnerabilityAssessmentListResult{
		// 	Value: []*armsynapse.ServerVulnerabilityAssessment{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/vulnerabilityAssessments"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default"),
		// 			Properties: &armsynapse.ServerVulnerabilityAssessmentProperties{
		// 				RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
		// 					EmailSubscriptionAdmins: to.Ptr(true),
		// 					Emails: []*string{
		// 						to.Ptr("email1@mail.com"),
		// 						to.Ptr("email2@mail.com")},
		// 						IsEnabled: to.Ptr(true),
		// 					},
		// 					StorageContainerPath: to.Ptr("https://myStorage.blob.core.windows.net/vulnerability-assessment/"),
		// 				},
		// 		}},
		// 	}
	}
}

Output:

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientCreateOrUpdateOptions added in v0.2.0 

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientCreateOrUpdateOptions struct {
}

WorkspaceManagedSQLServerVulnerabilityAssessmentsClientCreateOrUpdateOptions contains the optional parameters for the WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.CreateOrUpdate method.

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientCreateOrUpdateResponse added in v0.2.0 

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientCreateOrUpdateResponse struct {
	// A server vulnerability assessment.
	ServerVulnerabilityAssessment
}

WorkspaceManagedSQLServerVulnerabilityAssessmentsClientCreateOrUpdateResponse contains the response from method WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.CreateOrUpdate.

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientDeleteOptions added in v0.2.0 

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientDeleteOptions struct {
}

WorkspaceManagedSQLServerVulnerabilityAssessmentsClientDeleteOptions contains the optional parameters for the WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.Delete method.

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientDeleteResponse added in v0.2.0 

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientDeleteResponse struct {
}

WorkspaceManagedSQLServerVulnerabilityAssessmentsClientDeleteResponse contains the response from method WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.Delete.

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientGetOptions added in v0.2.0 

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientGetOptions struct {
}

WorkspaceManagedSQLServerVulnerabilityAssessmentsClientGetOptions contains the optional parameters for the WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.Get method.

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientGetResponse added in v0.2.0 

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientGetResponse struct {
	// A server vulnerability assessment.
	ServerVulnerabilityAssessment
}

WorkspaceManagedSQLServerVulnerabilityAssessmentsClientGetResponse contains the response from method WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.Get.

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientListOptions added in v0.2.0 

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientListOptions struct {
}

WorkspaceManagedSQLServerVulnerabilityAssessmentsClientListOptions contains the optional parameters for the WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.NewListPager method.

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientListResponse added in v0.2.0 

type WorkspaceManagedSQLServerVulnerabilityAssessmentsClientListResponse struct {
	// A list of the server's vulnerability assessments.
	ServerVulnerabilityAssessmentListResult
}

WorkspaceManagedSQLServerVulnerabilityAssessmentsClientListResponse contains the response from method WorkspaceManagedSQLServerVulnerabilityAssessmentsClient.NewListPager.

type WorkspacePatchInfo 

type WorkspacePatchInfo struct {
	// The identity of the workspace
	Identity *ManagedIdentity

	// Workspace patch properties
	Properties *WorkspacePatchProperties

	// Resource tags
	Tags map[string]*string
}

WorkspacePatchInfo - Workspace patch details

func (WorkspacePatchInfo) MarshalJSON 

func (w WorkspacePatchInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspacePatchInfo.

func (*WorkspacePatchInfo) UnmarshalJSON added in v0.6.0 

func (w *WorkspacePatchInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspacePatchInfo.

type WorkspacePatchProperties 

type WorkspacePatchProperties struct {
	// The encryption details of the workspace
	Encryption *EncryptionDetails

	// Managed Virtual Network Settings
	ManagedVirtualNetworkSettings *ManagedVirtualNetworkSettings

	// Enable or Disable public network access to workspace
	PublicNetworkAccess *WorkspacePublicNetworkAccess

	// Purview Configuration
	PurviewConfiguration *PurviewConfiguration

	// SQL administrator login password
	SQLAdministratorLoginPassword *string

	// Git integration settings
	WorkspaceRepositoryConfiguration *WorkspaceRepositoryConfiguration

	// READ-ONLY; Resource provisioning state
	ProvisioningState *string
}

WorkspacePatchProperties - Workspace patch properties

func (WorkspacePatchProperties) MarshalJSON added in v0.6.0 

func (w WorkspacePatchProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspacePatchProperties.

func (*WorkspacePatchProperties) UnmarshalJSON added in v0.6.0 

func (w *WorkspacePatchProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspacePatchProperties.

type WorkspaceProperties 

type WorkspaceProperties struct {
	// Enable or Disable AzureADOnlyAuthentication on All Workspace subresource
	AzureADOnlyAuthentication *bool

	// Connectivity endpoints
	ConnectivityEndpoints map[string]*string

	// Initial workspace AAD admin properties for a CSP subscription
	CspWorkspaceAdminProperties *CspWorkspaceAdminProperties

	// Workspace default data lake storage account details
	DefaultDataLakeStorage *DataLakeStorageAccountDetails

	// The encryption details of the workspace
	Encryption *EncryptionDetails

	// Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId.
	// The resource group name must be no longer than 90 characters long, and
	// must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with
	// '.'
	ManagedResourceGroupName *string

	// Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of
	// the user.
	ManagedVirtualNetwork *string

	// Managed Virtual Network Settings
	ManagedVirtualNetworkSettings *ManagedVirtualNetworkSettings

	// Private endpoint connections to the workspace
	PrivateEndpointConnections []*PrivateEndpointConnection

	// Enable or Disable public network access to workspace
	PublicNetworkAccess *WorkspacePublicNetworkAccess

	// Purview Configuration
	PurviewConfiguration *PurviewConfiguration

	// Login for workspace SQL active directory administrator
	SQLAdministratorLogin *string

	// SQL administrator login password
	SQLAdministratorLoginPassword *string

	// Is trustedServiceBypassEnabled for the workspace
	TrustedServiceBypassEnabled *bool

	// Virtual Network profile
	VirtualNetworkProfile *VirtualNetworkProfile

	// Git integration settings
	WorkspaceRepositoryConfiguration *WorkspaceRepositoryConfiguration

	// READ-ONLY; The ADLA resource ID.
	AdlaResourceID *string

	// READ-ONLY; Workspace level configs and feature flags
	ExtraProperties map[string]any

	// READ-ONLY; Resource provisioning state
	ProvisioningState *string

	// READ-ONLY; Workspace settings
	Settings map[string]any

	// READ-ONLY; The workspace unique identifier
	WorkspaceUID *string
}

WorkspaceProperties - Workspace properties

func (WorkspaceProperties) MarshalJSON 

func (w WorkspaceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceProperties.

func (*WorkspaceProperties) UnmarshalJSON added in v0.6.0 

func (w *WorkspaceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceProperties.

type WorkspacePublicNetworkAccess 

type WorkspacePublicNetworkAccess string

WorkspacePublicNetworkAccess - Enable or Disable public network access to workspace 

const (
	WorkspacePublicNetworkAccessDisabled WorkspacePublicNetworkAccess = "Disabled"
	WorkspacePublicNetworkAccessEnabled  WorkspacePublicNetworkAccess = "Enabled"
)

func PossibleWorkspacePublicNetworkAccessValues 

func PossibleWorkspacePublicNetworkAccessValues() []WorkspacePublicNetworkAccess

PossibleWorkspacePublicNetworkAccessValues returns the possible values for the WorkspacePublicNetworkAccess const type.

type WorkspaceRepositoryConfiguration 

type WorkspaceRepositoryConfiguration struct {
	// Account name
	AccountName *string

	// Collaboration branch
	CollaborationBranch *string

	// GitHub Enterprise host name. For example: https://github.mydomain.com
	HostName *string

	// The last commit ID
	LastCommitID *string

	// VSTS project name
	ProjectName *string

	// Repository name
	RepositoryName *string

	// Root folder to use in the repository
	RootFolder *string

	// The VSTS tenant ID
	TenantID *string

	// Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration
	Type *string
}

WorkspaceRepositoryConfiguration - Git integration settings

func (WorkspaceRepositoryConfiguration) MarshalJSON added in v0.6.0 

func (w WorkspaceRepositoryConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceRepositoryConfiguration.

func (*WorkspaceRepositoryConfiguration) UnmarshalJSON added in v0.6.0 

func (w *WorkspaceRepositoryConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceRepositoryConfiguration.

type WorkspaceSQLAADAdminsClient 

type WorkspaceSQLAADAdminsClient struct {
	// contains filtered or unexported fields
}

WorkspaceSQLAADAdminsClient contains the methods for the WorkspaceSQLAADAdmins group. Don't use this type directly, use NewWorkspaceSQLAADAdminsClient() instead.

func NewWorkspaceSQLAADAdminsClient 

func NewWorkspaceSQLAADAdminsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceSQLAADAdminsClient, error)

NewWorkspaceSQLAADAdminsClient creates a new instance of WorkspaceSQLAADAdminsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceSQLAADAdminsClient) BeginCreateOrUpdate 

func (client *WorkspaceSQLAADAdminsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, aadAdminInfo WorkspaceAADAdminInfo, options *WorkspaceSQLAADAdminsClientBeginCreateOrUpdateOptions) (*runtime.Poller[WorkspaceSQLAADAdminsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a workspace SQL active directory admin If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • aadAdminInfo - Workspace active directory administrator properties
  • options - WorkspaceSQLAADAdminsClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceSQLAADAdminsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateWorkspaceAadAdmin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceSQLAADAdminsClient().BeginCreateOrUpdate(ctx, "resourceGroup1", "workspace1", armsynapse.WorkspaceAADAdminInfo{
		Properties: &armsynapse.AADAdminProperties{
			AdministratorType: to.Ptr("ActiveDirectory"),
			Login:             to.Ptr("bob@contoso.com"),
			Sid:               to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
			TenantID:          to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkspaceAADAdminInfo = armsynapse.WorkspaceAADAdminInfo{
	// 	Name: to.Ptr("activeDirectory"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/administrators/activeDirectory"),
	// 	Properties: &armsynapse.AADAdminProperties{
	// 		AdministratorType: to.Ptr("ActiveDirectory"),
	// 		Login: to.Ptr("bob@contoso.com"),
	// 		Sid: to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
	// 		TenantID: to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
	// 	},
	// }
}

Output:

func (*WorkspaceSQLAADAdminsClient) BeginDelete 

func (client *WorkspaceSQLAADAdminsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspaceSQLAADAdminsClientBeginDeleteOptions) (*runtime.Poller[WorkspaceSQLAADAdminsClientDeleteResponse], error)

BeginDelete - Deletes a workspace SQL active directory admin If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceSQLAADAdminsClientBeginDeleteOptions contains the optional parameters for the WorkspaceSQLAADAdminsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteWorkspaceAadAdmin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceSQLAADAdminsClient().BeginDelete(ctx, "resourceGroup1", "workspace1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*WorkspaceSQLAADAdminsClient) Get 

func (client *WorkspaceSQLAADAdminsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspaceSQLAADAdminsClientGetOptions) (WorkspaceSQLAADAdminsClientGetResponse, error)

Get - Gets a workspace SQL active directory admin If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspaceSQLAADAdminsClientGetOptions contains the optional parameters for the WorkspaceSQLAADAdminsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetWorkspaceAadAdmin.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceSQLAADAdminsClient().Get(ctx, "resourceGroup1", "workspace1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkspaceAADAdminInfo = armsynapse.WorkspaceAADAdminInfo{
	// 	Name: to.Ptr("activeDirectory"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/administrators/activeDirectory"),
	// 	Properties: &armsynapse.AADAdminProperties{
	// 		AdministratorType: to.Ptr("ActiveDirectory"),
	// 		Login: to.Ptr("bob@contoso.com"),
	// 		Sid: to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
	// 		TenantID: to.Ptr("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"),
	// 	},
	// }
}

Output:

type WorkspaceSQLAADAdminsClientBeginCreateOrUpdateOptions added in v0.2.0 

type WorkspaceSQLAADAdminsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceSQLAADAdminsClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspaceSQLAADAdminsClient.BeginCreateOrUpdate method.

type WorkspaceSQLAADAdminsClientBeginDeleteOptions added in v0.2.0 

type WorkspaceSQLAADAdminsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceSQLAADAdminsClientBeginDeleteOptions contains the optional parameters for the WorkspaceSQLAADAdminsClient.BeginDelete method.

type WorkspaceSQLAADAdminsClientCreateOrUpdateResponse added in v0.2.0 

type WorkspaceSQLAADAdminsClientCreateOrUpdateResponse struct {
	// Workspace active directory administrator
	WorkspaceAADAdminInfo
}

WorkspaceSQLAADAdminsClientCreateOrUpdateResponse contains the response from method WorkspaceSQLAADAdminsClient.BeginCreateOrUpdate.

type WorkspaceSQLAADAdminsClientDeleteResponse added in v0.2.0 

type WorkspaceSQLAADAdminsClientDeleteResponse struct {
}

WorkspaceSQLAADAdminsClientDeleteResponse contains the response from method WorkspaceSQLAADAdminsClient.BeginDelete.

type WorkspaceSQLAADAdminsClientGetOptions added in v0.2.0 

type WorkspaceSQLAADAdminsClientGetOptions struct {
}

WorkspaceSQLAADAdminsClientGetOptions contains the optional parameters for the WorkspaceSQLAADAdminsClient.Get method.

type WorkspaceSQLAADAdminsClientGetResponse added in v0.2.0 

type WorkspaceSQLAADAdminsClientGetResponse struct {
	// Workspace active directory administrator
	WorkspaceAADAdminInfo
}

WorkspaceSQLAADAdminsClientGetResponse contains the response from method WorkspaceSQLAADAdminsClient.Get.

type WorkspaceStatus added in v0.6.0 

type WorkspaceStatus string

WorkspaceStatus - status of Start Integrationruntimes. 

const (
	WorkspaceStatusFailed     WorkspaceStatus = "Failed"
	WorkspaceStatusInProgress WorkspaceStatus = "InProgress"
	WorkspaceStatusSucceeded  WorkspaceStatus = "Succeeded"
)

func PossibleWorkspaceStatusValues added in v0.6.0 

func PossibleWorkspaceStatusValues() []WorkspaceStatus

PossibleWorkspaceStatusValues returns the possible values for the WorkspaceStatus const type.

type WorkspacesClient 

type WorkspacesClient struct {
	// contains filtered or unexported fields
}

WorkspacesClient contains the methods for the Workspaces group. Don't use this type directly, use NewWorkspacesClient() instead.

func NewWorkspacesClient 

func NewWorkspacesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspacesClient, error)

NewWorkspacesClient creates a new instance of WorkspacesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspacesClient) BeginCreateOrUpdate 

func (client *WorkspacesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, workspaceInfo Workspace, options *WorkspacesClientBeginCreateOrUpdateOptions) (*runtime.Poller[WorkspacesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a workspace If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • workspaceInfo - Workspace create or update request properties
  • options - WorkspacesClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspacesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateOrUpdateWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspacesClient().BeginCreateOrUpdate(ctx, "resourceGroup1", "workspace1", armsynapse.Workspace{
		Location: to.Ptr("East US"),
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
		Identity: &armsynapse.ManagedIdentity{
			Type: to.Ptr(armsynapse.ResourceIdentityTypeSystemAssignedUserAssigned),
			UserAssignedIdentities: map[string]*armsynapse.UserAssignedManagedIdentity{
				"/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": {},
			},
		},
		Properties: &armsynapse.WorkspaceProperties{
			CspWorkspaceAdminProperties: &armsynapse.CspWorkspaceAdminProperties{
				InitialWorkspaceAdminObjectID: to.Ptr("6c20646f-8050-49ec-b3b1-80a0e58e454d"),
			},
			DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
				AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
				Filesystem: to.Ptr("default"),
			},
			Encryption: &armsynapse.EncryptionDetails{
				Cmk: &armsynapse.CustomerManagedKeyDetails{
					KekIdentity: &armsynapse.KekIdentityProperties{
						UseSystemAssignedIdentity: false,
						UserAssignedIdentity:      to.Ptr("/subscriptions/b64d7b94-73e7-4d36-94b2-7764ea3fd74a/resourcegroups/SynapseCI/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1"),
					},
					Key: &armsynapse.WorkspaceKeyDetails{
						Name:        to.Ptr("default"),
						KeyVaultURL: to.Ptr("https://vault.azure.net/keys/key1"),
					},
				},
			},
			ManagedResourceGroupName: to.Ptr("workspaceManagedResourceGroupUnique"),
			ManagedVirtualNetwork:    to.Ptr("default"),
			ManagedVirtualNetworkSettings: &armsynapse.ManagedVirtualNetworkSettings{
				AllowedAADTenantIDsForLinking: []*string{
					to.Ptr("740239CE-A25B-485B-86A0-262F29F6EBDB")},
				LinkedAccessCheckOnTargetResource: to.Ptr(false),
				PreventDataExfiltration:           to.Ptr(false),
			},
			PublicNetworkAccess: to.Ptr(armsynapse.WorkspacePublicNetworkAccessEnabled),
			PurviewConfiguration: &armsynapse.PurviewConfiguration{
				PurviewResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"),
			},
			SQLAdministratorLogin:         to.Ptr("login"),
			SQLAdministratorLoginPassword: to.Ptr("password"),
			WorkspaceRepositoryConfiguration: &armsynapse.WorkspaceRepositoryConfiguration{
				Type:                to.Ptr("FactoryGitHubConfiguration"),
				AccountName:         to.Ptr("mygithubaccount"),
				CollaborationBranch: to.Ptr("master"),
				HostName:            to.Ptr(""),
				ProjectName:         to.Ptr("myproject"),
				RepositoryName:      to.Ptr("myrepository"),
				RootFolder:          to.Ptr("/"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Workspace = armsynapse.Workspace{
	// 	Name: to.Ptr("workspace1"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Identity: &armsynapse.ManagedIdentity{
	// 		Type: to.Ptr(armsynapse.ResourceIdentityTypeSystemAssignedUserAssigned),
	// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 		UserAssignedIdentities: map[string]*armsynapse.UserAssignedManagedIdentity{
	// 			"/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": &armsynapse.UserAssignedManagedIdentity{
	// 				ClientID: to.Ptr("ffffffff-8888-4444-8888-333333333333"),
	// 				PrincipalID: to.Ptr("eeeeeeee-9999-4444-8888-333333333333"),
	// 			},
	// 		},
	// 	},
	// 	Properties: &armsynapse.WorkspaceProperties{
	// 		ConnectivityEndpoints: map[string]*string{
	// 			"dev": to.Ptr("workspace1.dev.projectarcadia.net"),
	// 			"sql": to.Ptr("workspace1.sql.projectarcadia.net"),
	// 		},
	// 		DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
	// 			AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
	// 			Filesystem: to.Ptr("default"),
	// 		},
	// 		Encryption: &armsynapse.EncryptionDetails{
	// 			Cmk: &armsynapse.CustomerManagedKeyDetails{
	// 				KekIdentity: &armsynapse.KekIdentityProperties{
	// 					UseSystemAssignedIdentity: false,
	// 					UserAssignedIdentity: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1"),
	// 				},
	// 				Key: &armsynapse.WorkspaceKeyDetails{
	// 					Name: to.Ptr("default"),
	// 					KeyVaultURL: to.Ptr("https://vault.azure.net/keys/key1"),
	// 				},
	// 				Status: to.Ptr("Consistent"),
	// 			},
	// 			DoubleEncryptionEnabled: to.Ptr(true),
	// 		},
	// 		ManagedResourceGroupName: to.Ptr("workspaceManagedResourceGroupUnique"),
	// 		ManagedVirtualNetwork: to.Ptr("default"),
	// 		ManagedVirtualNetworkSettings: &armsynapse.ManagedVirtualNetworkSettings{
	// 			AllowedAADTenantIDsForLinking: []*string{
	// 				to.Ptr("740239CE-A25B-485B-86A0-262F29F6EBDB")},
	// 				LinkedAccessCheckOnTargetResource: to.Ptr(false),
	// 				PreventDataExfiltration: to.Ptr(false),
	// 			},
	// 			PrivateEndpointConnections: []*armsynapse.PrivateEndpointConnection{
	// 				{
	// 					Name: to.Ptr("sql"),
	// 					Type: to.Ptr("Microsoft.Synapse/workspaces/privateEndpointConnections"),
	// 					ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection"),
	// 					Properties: &armsynapse.PrivateEndpointConnectionProperties{
	// 						PrivateEndpoint: &armsynapse.PrivateEndpoint{
	// 							ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"),
	// 						},
	// 						PrivateLinkServiceConnectionState: &armsynapse.PrivateLinkServiceConnectionState{
	// 							Description: to.Ptr("Auto-approved"),
	// 							ActionsRequired: to.Ptr("None"),
	// 							Status: to.Ptr("Approved"),
	// 						},
	// 						ProvisioningState: to.Ptr("Succeeded"),
	// 					},
	// 			}},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			PublicNetworkAccess: to.Ptr(armsynapse.WorkspacePublicNetworkAccessEnabled),
	// 			PurviewConfiguration: &armsynapse.PurviewConfiguration{
	// 				PurviewResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"),
	// 			},
	// 			SQLAdministratorLogin: to.Ptr("login"),
	// 			WorkspaceUID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 		},
	// 	}
}

Output:

func (*WorkspacesClient) BeginDelete 

func (client *WorkspacesClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientBeginDeleteOptions) (*runtime.Poller[WorkspacesClientDeleteResponse], error)

BeginDelete - Deletes a workspace If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspacesClientBeginDeleteOptions contains the optional parameters for the WorkspacesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/DeleteWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspacesClient().BeginDelete(ctx, "resourceGroup1", "workspace1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Workspace = armsynapse.Workspace{
	// 	Name: to.Ptr("workspace1"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armsynapse.WorkspaceProperties{
	// 		ConnectivityEndpoints: map[string]*string{
	// 			"dev": to.Ptr("workspace1.dev.projectarcadia.net"),
	// 			"sql": to.Ptr("workspace1.sql.projectarcadia.net"),
	// 		},
	// 		DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
	// 			AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
	// 			Filesystem: to.Ptr("default"),
	// 		},
	// 		ManagedResourceGroupName: to.Ptr("resourceGroup2"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SQLAdministratorLogin: to.Ptr("login"),
	// 	},
	// }
}

Output:

func (*WorkspacesClient) BeginUpdate 

func (client *WorkspacesClient) BeginUpdate(ctx context.Context, resourceGroupName string, workspaceName string, workspacePatchInfo WorkspacePatchInfo, options *WorkspacesClientBeginUpdateOptions) (*runtime.Poller[WorkspacesClientUpdateResponse], error)

BeginUpdate - Updates a workspace If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • workspacePatchInfo - Workspace patch request properties
  • options - WorkspacesClientBeginUpdateOptions contains the optional parameters for the WorkspacesClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdateWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspacesClient().BeginUpdate(ctx, "resourceGroup1", "workspace1", armsynapse.WorkspacePatchInfo{
		Identity: &armsynapse.ManagedIdentity{
			Type: to.Ptr(armsynapse.ResourceIdentityTypeSystemAssigned),
		},
		Properties: &armsynapse.WorkspacePatchProperties{
			Encryption: &armsynapse.EncryptionDetails{
				Cmk: &armsynapse.CustomerManagedKeyDetails{
					Key: &armsynapse.WorkspaceKeyDetails{
						Name:        to.Ptr("default"),
						KeyVaultURL: to.Ptr("https://vault.azure.net/keys/key1"),
					},
				},
			},
			ManagedVirtualNetworkSettings: &armsynapse.ManagedVirtualNetworkSettings{
				AllowedAADTenantIDsForLinking: []*string{
					to.Ptr("740239CE-A25B-485B-86A0-262F29F6EBDB")},
				LinkedAccessCheckOnTargetResource: to.Ptr(false),
				PreventDataExfiltration:           to.Ptr(false),
			},
			PublicNetworkAccess: to.Ptr(armsynapse.WorkspacePublicNetworkAccessEnabled),
			PurviewConfiguration: &armsynapse.PurviewConfiguration{
				PurviewResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"),
			},
			SQLAdministratorLoginPassword: to.Ptr("password"),
			WorkspaceRepositoryConfiguration: &armsynapse.WorkspaceRepositoryConfiguration{
				Type:                to.Ptr("FactoryGitHubConfiguration"),
				AccountName:         to.Ptr("adifferentacount"),
				CollaborationBranch: to.Ptr("master"),
				HostName:            to.Ptr(""),
				ProjectName:         to.Ptr("myproject"),
				RepositoryName:      to.Ptr("myrepository"),
				RootFolder:          to.Ptr("/"),
			},
		},
		Tags: map[string]*string{
			"key": to.Ptr("value"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Workspace = armsynapse.Workspace{
	// 	Name: to.Ptr("workspace1"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armsynapse.WorkspaceProperties{
	// 		ConnectivityEndpoints: map[string]*string{
	// 			"dev": to.Ptr("workspace1.dev.projectarcadia.net"),
	// 			"sql": to.Ptr("workspace1.sql.projectarcadia.net"),
	// 		},
	// 		DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
	// 			AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
	// 			Filesystem: to.Ptr("default"),
	// 		},
	// 		Encryption: &armsynapse.EncryptionDetails{
	// 			Cmk: &armsynapse.CustomerManagedKeyDetails{
	// 				Key: &armsynapse.WorkspaceKeyDetails{
	// 					Name: to.Ptr("default"),
	// 					KeyVaultURL: to.Ptr("https://vault.azure.net/keys/key1"),
	// 				},
	// 				Status: to.Ptr("Consistent"),
	// 			},
	// 			DoubleEncryptionEnabled: to.Ptr(true),
	// 		},
	// 		ManagedResourceGroupName: to.Ptr("resourceGroup2"),
	// 		ManagedVirtualNetworkSettings: &armsynapse.ManagedVirtualNetworkSettings{
	// 			AllowedAADTenantIDsForLinking: []*string{
	// 				to.Ptr("740239CE-A25B-485B-86A0-262F29F6EBDB")},
	// 				LinkedAccessCheckOnTargetResource: to.Ptr(false),
	// 				PreventDataExfiltration: to.Ptr(false),
	// 			},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			PublicNetworkAccess: to.Ptr(armsynapse.WorkspacePublicNetworkAccessEnabled),
	// 			PurviewConfiguration: &armsynapse.PurviewConfiguration{
	// 				PurviewResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"),
	// 			},
	// 			SQLAdministratorLogin: to.Ptr("login"),
	// 			WorkspaceUID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 		},
	// 	}
}

Output:

func (*WorkspacesClient) Get 

func (client *WorkspacesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientGetOptions) (WorkspacesClientGetResponse, error)

Get - Gets a workspace If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - The name of the workspace.
  • options - WorkspacesClientGetOptions contains the optional parameters for the WorkspacesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetWorkspace.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspacesClient().Get(ctx, "resourceGroup1", "workspace1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Workspace = armsynapse.Workspace{
	// 	Name: to.Ptr("workspace1"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 		"key": to.Ptr("value"),
	// 	},
	// 	Properties: &armsynapse.WorkspaceProperties{
	// 		ConnectivityEndpoints: map[string]*string{
	// 			"dev": to.Ptr("workspace1.dev.projectarcadia.net"),
	// 			"sql": to.Ptr("workspace1.sql.projectarcadia.net"),
	// 		},
	// 		CspWorkspaceAdminProperties: &armsynapse.CspWorkspaceAdminProperties{
	// 			InitialWorkspaceAdminObjectID: to.Ptr("6c20646f-8050-49ec-b3b1-80a0e58e454d"),
	// 		},
	// 		DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
	// 			AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
	// 			Filesystem: to.Ptr("default"),
	// 		},
	// 		ExtraProperties: map[string]any{
	// 			"IsScopeEnabled": "false",
	// 			"WorkspaceType": "Normal",
	// 		},
	// 		ManagedResourceGroupName: to.Ptr("resourceGroup2"),
	// 		ManagedVirtualNetworkSettings: &armsynapse.ManagedVirtualNetworkSettings{
	// 			AllowedAADTenantIDsForLinking: []*string{
	// 				to.Ptr("740239CE-A25B-485B-86A0-262F29F6EBDB")},
	// 				LinkedAccessCheckOnTargetResource: to.Ptr(false),
	// 				PreventDataExfiltration: to.Ptr(false),
	// 			},
	// 			PrivateEndpointConnections: []*armsynapse.PrivateEndpointConnection{
	// 				{
	// 					Name: to.Ptr("sql"),
	// 					Type: to.Ptr("Microsoft.Synapse/workspaces/privateEndpointConnections"),
	// 					ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection"),
	// 					Properties: &armsynapse.PrivateEndpointConnectionProperties{
	// 						PrivateEndpoint: &armsynapse.PrivateEndpoint{
	// 							ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"),
	// 						},
	// 						PrivateLinkServiceConnectionState: &armsynapse.PrivateLinkServiceConnectionState{
	// 							Description: to.Ptr("Auto-approved"),
	// 							ActionsRequired: to.Ptr("None"),
	// 							Status: to.Ptr("Approved"),
	// 						},
	// 						ProvisioningState: to.Ptr("Succeeded"),
	// 					},
	// 			}},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			PurviewConfiguration: &armsynapse.PurviewConfiguration{
	// 				PurviewResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"),
	// 			},
	// 			SQLAdministratorLogin: to.Ptr("login"),
	// 			WorkspaceRepositoryConfiguration: &armsynapse.WorkspaceRepositoryConfiguration{
	// 				Type: to.Ptr("FactoryGitHubConfiguration"),
	// 				AccountName: to.Ptr("myGithubAccount"),
	// 				CollaborationBranch: to.Ptr("master"),
	// 				HostName: to.Ptr(""),
	// 				ProjectName: to.Ptr("myProject"),
	// 				RepositoryName: to.Ptr("myRepository"),
	// 				RootFolder: to.Ptr("/"),
	// 				TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 			},
	// 			WorkspaceUID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 		},
	// 	}
}

Output:

func (*WorkspacesClient) NewListByResourceGroupPager added in v0.4.0 

func (client *WorkspacesClient) NewListByResourceGroupPager(resourceGroupName string, options *WorkspacesClientListByResourceGroupOptions) *runtime.Pager[WorkspacesClientListByResourceGroupResponse]

NewListByResourceGroupPager - Returns a list of workspaces in a resource group

Generated from API version 2021-06-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - WorkspacesClientListByResourceGroupOptions contains the optional parameters for the WorkspacesClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspacesInResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkspacesClient().NewListByResourceGroupPager("resourceGroup1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.WorkspaceInfoListResult = armsynapse.WorkspaceInfoListResult{
		// 	Value: []*armsynapse.Workspace{
		// 		{
		// 			Name: to.Ptr("workspace1"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armsynapse.WorkspaceProperties{
		// 				ConnectivityEndpoints: map[string]*string{
		// 					"dev": to.Ptr("workspace1.dev.projectarcadia.net"),
		// 					"sql": to.Ptr("workspace1.sql.projectarcadia.net"),
		// 				},
		// 				DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
		// 					AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
		// 					Filesystem: to.Ptr("default"),
		// 				},
		// 				ManagedResourceGroupName: to.Ptr("resourceGroup2"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SQLAdministratorLogin: to.Ptr("login"),
		// 				SQLAdministratorLoginPassword: to.Ptr("password"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("workspace2"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace2"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armsynapse.WorkspaceProperties{
		// 				ConnectivityEndpoints: map[string]*string{
		// 					"dev": to.Ptr("workspace2.dev.projectarcadia.net"),
		// 					"sql": to.Ptr("workspace2.sql.projectarcadia.net"),
		// 				},
		// 				DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
		// 					AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
		// 					Filesystem: to.Ptr("default"),
		// 				},
		// 				ManagedResourceGroupName: to.Ptr("resourceGroup2"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SQLAdministratorLogin: to.Ptr("login"),
		// 				SQLAdministratorLoginPassword: to.Ptr("password"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*WorkspacesClient) NewListPager added in v0.4.0 

func (client *WorkspacesClient) NewListPager(options *WorkspacesClientListOptions) *runtime.Pager[WorkspacesClientListResponse]

NewListPager - Returns a list of workspaces in a subscription

Generated from API version 2021-06-01

  • options - WorkspacesClientListOptions contains the optional parameters for the WorkspacesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspacesInSubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkspacesClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.WorkspaceInfoListResult = armsynapse.WorkspaceInfoListResult{
		// 	Value: []*armsynapse.Workspace{
		// 		{
		// 			Name: to.Ptr("workspace1"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armsynapse.WorkspaceProperties{
		// 				ConnectivityEndpoints: map[string]*string{
		// 					"dev": to.Ptr("workspace1.dev.projectarcadia.net"),
		// 					"sql": to.Ptr("workspace1.sql.projectarcadia.net"),
		// 				},
		// 				DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
		// 					AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
		// 					Filesystem: to.Ptr("default"),
		// 				},
		// 				ManagedResourceGroupName: to.Ptr("resourceGroup2"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SQLAdministratorLogin: to.Ptr("login"),
		// 				WorkspaceUID: to.Ptr("00000000-1111-2222-3333-444444444444"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("workspace2"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace2"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armsynapse.WorkspaceProperties{
		// 				ConnectivityEndpoints: map[string]*string{
		// 					"dev": to.Ptr("workspace2.dev.projectarcadia.net"),
		// 					"sql": to.Ptr("workspace2.sql.projectarcadia.net"),
		// 				},
		// 				DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
		// 					AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
		// 					Filesystem: to.Ptr("default"),
		// 				},
		// 				ManagedResourceGroupName: to.Ptr("resourceGroup2"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SQLAdministratorLogin: to.Ptr("login"),
		// 				WorkspaceUID: to.Ptr("00000000-1111-2222-3333-444444444444"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type WorkspacesClientBeginCreateOrUpdateOptions added in v0.2.0 

type WorkspacesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspacesClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspacesClient.BeginCreateOrUpdate method.

type WorkspacesClientBeginDeleteOptions added in v0.2.0 

type WorkspacesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspacesClientBeginDeleteOptions contains the optional parameters for the WorkspacesClient.BeginDelete method.

type WorkspacesClientBeginUpdateOptions added in v0.2.0 

type WorkspacesClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspacesClientBeginUpdateOptions contains the optional parameters for the WorkspacesClient.BeginUpdate method.

type WorkspacesClientCreateOrUpdateResponse added in v0.2.0 

type WorkspacesClientCreateOrUpdateResponse struct {
	// A workspace
	Workspace
}

WorkspacesClientCreateOrUpdateResponse contains the response from method WorkspacesClient.BeginCreateOrUpdate.

type WorkspacesClientDeleteResponse added in v0.2.0 

type WorkspacesClientDeleteResponse struct {
	// A workspace
	Workspace
}

WorkspacesClientDeleteResponse contains the response from method WorkspacesClient.BeginDelete.

type WorkspacesClientGetOptions added in v0.2.0 

type WorkspacesClientGetOptions struct {
}

WorkspacesClientGetOptions contains the optional parameters for the WorkspacesClient.Get method.

type WorkspacesClientGetResponse added in v0.2.0 

type WorkspacesClientGetResponse struct {
	// A workspace
	Workspace
}

WorkspacesClientGetResponse contains the response from method WorkspacesClient.Get.

type WorkspacesClientListByResourceGroupOptions added in v0.2.0 

type WorkspacesClientListByResourceGroupOptions struct {
}

WorkspacesClientListByResourceGroupOptions contains the optional parameters for the WorkspacesClient.NewListByResourceGroupPager method.

type WorkspacesClientListByResourceGroupResponse added in v0.2.0 

type WorkspacesClientListByResourceGroupResponse struct {
	// List of workspaces
	WorkspaceInfoListResult
}

WorkspacesClientListByResourceGroupResponse contains the response from method WorkspacesClient.NewListByResourceGroupPager.

type WorkspacesClientListOptions added in v0.2.0 

type WorkspacesClientListOptions struct {
}

WorkspacesClientListOptions contains the optional parameters for the WorkspacesClient.NewListPager method.

type WorkspacesClientListResponse added in v0.2.0 

type WorkspacesClientListResponse struct {
	// List of workspaces
	WorkspaceInfoListResult
}

WorkspacesClientListResponse contains the response from method WorkspacesClient.NewListPager.

type WorkspacesClientUpdateResponse added in v0.2.0 

type WorkspacesClientUpdateResponse struct {
	// A workspace
	Workspace
}

WorkspacesClientUpdateResponse contains the response from method WorkspacesClient.BeginUpdate.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.