armkusto

package module
v2.2.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: 0

README

Azure Kusto Module for Go

PkgGoDev

The armkusto module provides operations for working with Azure Kusto.

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 Kusto module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kusto/armkusto

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Kusto. 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 Kusto 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 := armkusto.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 := armkusto.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.NewDatabasesClient()

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 Kusto 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 AcceptedAudiences 

type AcceptedAudiences struct {
	// GUID or valid URL representing an accepted audience.
	Value *string
}

AcceptedAudiences - Represents an accepted audience trusted by the cluster.

func (AcceptedAudiences) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AcceptedAudiences.

func (*AcceptedAudiences) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AcceptedAudiences.

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; 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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AttachedDatabaseConfigurationListResult.

type AttachedDatabaseConfigurationProperties 

type AttachedDatabaseConfigurationProperties struct {
	// REQUIRED; The resource id of the cluster where the databases you would like to attach reside.
	ClusterResourceID *string

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

	// Overrides the original database name. Relevant only when attaching to a specific database.
	DatabaseNameOverride *string

	// Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the
	// databases original names from leader cluster.
	DatabaseNamePrefix *string

	// Table level sharing specifications
	TableLevelSharingProperties *TableLevelSharingProperties

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

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

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AttachedDatabaseConfigurationProperties.

type AttachedDatabaseConfigurationsCheckNameRequest 

type AttachedDatabaseConfigurationsCheckNameRequest struct {
	// REQUIRED; Attached database resource name.
	Name *string

	// CONSTANT; The type of resource, for instance Microsoft.Kusto/clusters/attachedDatabaseConfigurations.
	// Field has constant value "Microsoft.Kusto/clusters/attachedDatabaseConfigurations", any specified value is ignored.
	Type *string
}

AttachedDatabaseConfigurationsCheckNameRequest - The result returned from a AttachedDatabaseConfigurations check name availability request.

func (AttachedDatabaseConfigurationsCheckNameRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AttachedDatabaseConfigurationsCheckNameRequest.

func (*AttachedDatabaseConfigurationsCheckNameRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AttachedDatabaseConfigurationsCheckNameRequest.

type AttachedDatabaseConfigurationsClient 

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

AttachedDatabaseConfigurationsClient contains the methods for the AttachedDatabaseConfigurations group. Don't use this type directly, use NewAttachedDatabaseConfigurationsClient() instead.

func NewAttachedDatabaseConfigurationsClient 

func NewAttachedDatabaseConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AttachedDatabaseConfigurationsClient, error)

NewAttachedDatabaseConfigurationsClient creates a new instance of AttachedDatabaseConfigurationsClient 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 (*AttachedDatabaseConfigurationsClient) BeginCreateOrUpdate 

func (client *AttachedDatabaseConfigurationsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, attachedDatabaseConfigurationName string, parameters AttachedDatabaseConfiguration, options *AttachedDatabaseConfigurationsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AttachedDatabaseConfigurationsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates an attached database configuration. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • attachedDatabaseConfigurationName - The name of the attached database configuration.
  • parameters - The database parameters supplied to the CreateOrUpdate operation.
  • options - AttachedDatabaseConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the AttachedDatabaseConfigurationsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAttachedDatabaseConfigurationsClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster2", "attachedDatabaseConfigurationsTest", armkusto.AttachedDatabaseConfiguration{
	Location: to.Ptr("westus"),
	Properties: &armkusto.AttachedDatabaseConfigurationProperties{
		ClusterResourceID:                 to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2"),
		DatabaseName:                      to.Ptr("kustodatabase"),
		DatabaseNameOverride:              to.Ptr("overridekustodatabase"),
		DefaultPrincipalsModificationKind: to.Ptr(armkusto.DefaultPrincipalsModificationKindUnion),
		TableLevelSharingProperties: &armkusto.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 = armkusto.AttachedDatabaseConfiguration{
// 	Name: to.Ptr("kustoCluster2/attachedDatabaseConfigurationsTest"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2/attachedDatabaseConfigurations/attachedDatabaseConfigurationsTest"),
// 	Location: to.Ptr("westus"),
// 	Properties: &armkusto.AttachedDatabaseConfigurationProperties{
// 		ClusterResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2"),
// 		DatabaseName: to.Ptr("db1"),
// 		DatabaseNameOverride: to.Ptr("overridekustodatabase"),
// 		DefaultPrincipalsModificationKind: to.Ptr(armkusto.DefaultPrincipalsModificationKindUnion),
// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 		TableLevelSharingProperties: &armkusto.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 (*AttachedDatabaseConfigurationsClient) BeginDelete 

func (client *AttachedDatabaseConfigurationsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, attachedDatabaseConfigurationName string, options *AttachedDatabaseConfigurationsClientBeginDeleteOptions) (*runtime.Poller[AttachedDatabaseConfigurationsClientDeleteResponse], 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 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • attachedDatabaseConfigurationName - The name of the attached database configuration.
  • options - AttachedDatabaseConfigurationsClientBeginDeleteOptions contains the optional parameters for the AttachedDatabaseConfigurationsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoAttachedDatabaseConfigurationsDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAttachedDatabaseConfigurationsClient().BeginDelete(ctx, "kustorptest", "kustoCluster", "attachedDatabaseConfigurationsTest", 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 (*AttachedDatabaseConfigurationsClient) CheckNameAvailability 

func (client *AttachedDatabaseConfigurationsClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, clusterName string, resourceName AttachedDatabaseConfigurationsCheckNameRequest, options *AttachedDatabaseConfigurationsClientCheckNameAvailabilityOptions) (AttachedDatabaseConfigurationsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the attached database configuration resource name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • resourceName - The name of the resource.
  • options - AttachedDatabaseConfigurationsClientCheckNameAvailabilityOptions contains the optional parameters for the AttachedDatabaseConfigurationsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoAttachedDatabaseConfigurationCheckNameAvailability.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAttachedDatabaseConfigurationsClient().CheckNameAvailability(ctx, "kustorptest", "kustoCluster", armkusto.AttachedDatabaseConfigurationsCheckNameRequest{
	Name: to.Ptr("adc1"),
	Type: to.Ptr("Microsoft.Kusto/clusters/attachedDatabaseConfigurations"),
}, 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 = armkusto.CheckNameResult{
// 	Name: to.Ptr("adc1"),
// 	Message: to.Ptr("Name 'adc1' is already taken. Please specify a different name"),
// 	NameAvailable: to.Ptr(false),
// }

Output:

func (*AttachedDatabaseConfigurationsClient) Get 

func (client *AttachedDatabaseConfigurationsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, attachedDatabaseConfigurationName string, options *AttachedDatabaseConfigurationsClientGetOptions) (AttachedDatabaseConfigurationsClientGetResponse, error)

Get - Returns an attached database configuration. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • attachedDatabaseConfigurationName - The name of the attached database configuration.
  • options - AttachedDatabaseConfigurationsClientGetOptions contains the optional parameters for the AttachedDatabaseConfigurationsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoAttachedDatabaseConfigurationsGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAttachedDatabaseConfigurationsClient().Get(ctx, "kustorptest", "kustoCluster2", "attachedDatabaseConfigurationsTest", 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 = armkusto.AttachedDatabaseConfiguration{
// 	Name: to.Ptr("kustoCluster2/attachedDatabaseConfigurationsTest"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2/AttachedDatabaseConfigurations/attachedDatabaseConfigurationsTest"),
// 	Location: to.Ptr("westus"),
// 	Properties: &armkusto.AttachedDatabaseConfigurationProperties{
// 		ClusterResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2"),
// 		DatabaseName: to.Ptr("*"),
// 		DatabaseNamePrefix: to.Ptr("prefix"),
// 		DefaultPrincipalsModificationKind: to.Ptr(armkusto.DefaultPrincipalsModificationKindUnion),
// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 	},
// }

Output:

func (*AttachedDatabaseConfigurationsClient) NewListByClusterPager 

func (client *AttachedDatabaseConfigurationsClient) NewListByClusterPager(resourceGroupName string, clusterName string, options *AttachedDatabaseConfigurationsClientListByClusterOptions) *runtime.Pager[AttachedDatabaseConfigurationsClientListByClusterResponse]

NewListByClusterPager - Returns the list of attached database configurations of the given Kusto cluster.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - AttachedDatabaseConfigurationsClientListByClusterOptions contains the optional parameters for the AttachedDatabaseConfigurationsClient.NewListByClusterPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoAttachedDatabaseConfigurationsListByCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewAttachedDatabaseConfigurationsClient().NewListByClusterPager("kustorptest", "kustoCluster2", 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 = armkusto.AttachedDatabaseConfigurationListResult{
	// 	Value: []*armkusto.AttachedDatabaseConfiguration{
	// 		{
	// 			Name: to.Ptr("kustoCluster2/KustoDatabase8"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2/AttachedDatabaseConfigurations/KustoDatabase8"),
	// 			Location: to.Ptr("westus"),
	// 			Properties: &armkusto.AttachedDatabaseConfigurationProperties{
	// 				ClusterResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader"),
	// 				DatabaseName: to.Ptr("db1"),
	// 				DefaultPrincipalsModificationKind: to.Ptr(armkusto.DefaultPrincipalsModificationKindUnion),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("kustoCluster2/KustoDatabase9"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2/AttachedDatabaseConfigurations/KustoDatabase9"),
	// 			Location: to.Ptr("westus"),
	// 			Properties: &armkusto.AttachedDatabaseConfigurationProperties{
	// 				ClusterResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader"),
	// 				DatabaseName: to.Ptr("db1"),
	// 				DefaultPrincipalsModificationKind: to.Ptr(armkusto.DefaultPrincipalsModificationKindUnion),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				TableLevelSharingProperties: &armkusto.TableLevelSharingProperties{
	// 					ExternalTablesToExclude: []*string{
	// 						to.Ptr("ExternalTable2")},
	// 						ExternalTablesToInclude: []*string{
	// 							to.Ptr("ExternalTable1")},
	// 							FunctionsToExclude: []*string{
	// 								to.Ptr("functionsToExclude2")},
	// 								FunctionsToInclude: []*string{
	// 									to.Ptr("functionsToInclude1")},
	// 									MaterializedViewsToExclude: []*string{
	// 										to.Ptr("MaterializedViewTable2")},
	// 										MaterializedViewsToInclude: []*string{
	// 											to.Ptr("MaterializedViewTable1")},
	// 											TablesToExclude: []*string{
	// 												to.Ptr("Table2")},
	// 												TablesToInclude: []*string{
	// 													to.Ptr("Table1")},
	// 												},
	// 											},
	// 									}},
	// 								}
}

Output:

type AttachedDatabaseConfigurationsClientBeginCreateOrUpdateOptions 

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

AttachedDatabaseConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the AttachedDatabaseConfigurationsClient.BeginCreateOrUpdate method.

type AttachedDatabaseConfigurationsClientBeginDeleteOptions 

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

AttachedDatabaseConfigurationsClientBeginDeleteOptions contains the optional parameters for the AttachedDatabaseConfigurationsClient.BeginDelete method.

type AttachedDatabaseConfigurationsClientCheckNameAvailabilityOptions 

type AttachedDatabaseConfigurationsClientCheckNameAvailabilityOptions struct {
}

AttachedDatabaseConfigurationsClientCheckNameAvailabilityOptions contains the optional parameters for the AttachedDatabaseConfigurationsClient.CheckNameAvailability method.

type AttachedDatabaseConfigurationsClientCheckNameAvailabilityResponse 

type AttachedDatabaseConfigurationsClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

AttachedDatabaseConfigurationsClientCheckNameAvailabilityResponse contains the response from method AttachedDatabaseConfigurationsClient.CheckNameAvailability.

type AttachedDatabaseConfigurationsClientCreateOrUpdateResponse 

type AttachedDatabaseConfigurationsClientCreateOrUpdateResponse struct {
	// Class representing an attached database configuration.
	AttachedDatabaseConfiguration
}

AttachedDatabaseConfigurationsClientCreateOrUpdateResponse contains the response from method AttachedDatabaseConfigurationsClient.BeginCreateOrUpdate.

type AttachedDatabaseConfigurationsClientDeleteResponse 

type AttachedDatabaseConfigurationsClientDeleteResponse struct {
}

AttachedDatabaseConfigurationsClientDeleteResponse contains the response from method AttachedDatabaseConfigurationsClient.BeginDelete.

type AttachedDatabaseConfigurationsClientGetOptions 

type AttachedDatabaseConfigurationsClientGetOptions struct {
}

AttachedDatabaseConfigurationsClientGetOptions contains the optional parameters for the AttachedDatabaseConfigurationsClient.Get method.

type AttachedDatabaseConfigurationsClientGetResponse 

type AttachedDatabaseConfigurationsClientGetResponse struct {
	// Class representing an attached database configuration.
	AttachedDatabaseConfiguration
}

AttachedDatabaseConfigurationsClientGetResponse contains the response from method AttachedDatabaseConfigurationsClient.Get.

type AttachedDatabaseConfigurationsClientListByClusterOptions 

type AttachedDatabaseConfigurationsClientListByClusterOptions struct {
}

AttachedDatabaseConfigurationsClientListByClusterOptions contains the optional parameters for the AttachedDatabaseConfigurationsClient.NewListByClusterPager method.

type AttachedDatabaseConfigurationsClientListByClusterResponse 

type AttachedDatabaseConfigurationsClientListByClusterResponse struct {
	// The list attached database configurations operation response.
	AttachedDatabaseConfigurationListResult
}

AttachedDatabaseConfigurationsClientListByClusterResponse contains the response from method AttachedDatabaseConfigurationsClient.NewListByClusterPager.

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 

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

MarshalJSON implements the json.Marshaller interface for type AzureCapacity.

func (*AzureCapacity) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCapacity.

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 

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

MarshalJSON implements the json.Marshaller interface for type AzureResourceSKU.

func (*AzureResourceSKU) UnmarshalJSON 

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 *AzureSKUName

	// REQUIRED; SKU tier.
	Tier *AzureSKUTier

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

AzureSKU - Azure SKU definition.

func (AzureSKU) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureSKU.

func (*AzureSKU) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureSKU.

type AzureSKUName 

type AzureSKUName string

AzureSKUName - SKU name. 

const (
	AzureSKUNameDevNoSLAStandardD11V2 AzureSKUName = "Dev(No SLA)_Standard_D11_v2"
	AzureSKUNameDevNoSLAStandardE2AV4 AzureSKUName = "Dev(No SLA)_Standard_E2a_v4"
	AzureSKUNameStandardD11V2         AzureSKUName = "Standard_D11_v2"
	AzureSKUNameStandardD12V2         AzureSKUName = "Standard_D12_v2"
	AzureSKUNameStandardD13V2         AzureSKUName = "Standard_D13_v2"
	AzureSKUNameStandardD14V2         AzureSKUName = "Standard_D14_v2"
	AzureSKUNameStandardD16DV5        AzureSKUName = "Standard_D16d_v5"
	AzureSKUNameStandardD32DV4        AzureSKUName = "Standard_D32d_v4"
	AzureSKUNameStandardD32DV5        AzureSKUName = "Standard_D32d_v5"
	AzureSKUNameStandardDS13V21TBPS   AzureSKUName = "Standard_DS13_v2+1TB_PS"
	AzureSKUNameStandardDS13V22TBPS   AzureSKUName = "Standard_DS13_v2+2TB_PS"
	AzureSKUNameStandardDS14V23TBPS   AzureSKUName = "Standard_DS14_v2+3TB_PS"
	AzureSKUNameStandardDS14V24TBPS   AzureSKUName = "Standard_DS14_v2+4TB_PS"
	AzureSKUNameStandardE16AV4        AzureSKUName = "Standard_E16a_v4"
	AzureSKUNameStandardE16AdsV5      AzureSKUName = "Standard_E16ads_v5"
	AzureSKUNameStandardE16AsV43TBPS  AzureSKUName = "Standard_E16as_v4+3TB_PS"
	AzureSKUNameStandardE16AsV44TBPS  AzureSKUName = "Standard_E16as_v4+4TB_PS"
	AzureSKUNameStandardE16AsV53TBPS  AzureSKUName = "Standard_E16as_v5+3TB_PS"
	AzureSKUNameStandardE16AsV54TBPS  AzureSKUName = "Standard_E16as_v5+4TB_PS"
	AzureSKUNameStandardE16DV4        AzureSKUName = "Standard_E16d_v4"
	AzureSKUNameStandardE16DV5        AzureSKUName = "Standard_E16d_v5"
	AzureSKUNameStandardE16SV43TBPS   AzureSKUName = "Standard_E16s_v4+3TB_PS"
	AzureSKUNameStandardE16SV44TBPS   AzureSKUName = "Standard_E16s_v4+4TB_PS"
	AzureSKUNameStandardE16SV53TBPS   AzureSKUName = "Standard_E16s_v5+3TB_PS"
	AzureSKUNameStandardE16SV54TBPS   AzureSKUName = "Standard_E16s_v5+4TB_PS"
	AzureSKUNameStandardE2AV4         AzureSKUName = "Standard_E2a_v4"
	AzureSKUNameStandardE2AdsV5       AzureSKUName = "Standard_E2ads_v5"
	AzureSKUNameStandardE2DV4         AzureSKUName = "Standard_E2d_v4"
	AzureSKUNameStandardE2DV5         AzureSKUName = "Standard_E2d_v5"
	AzureSKUNameStandardE4AV4         AzureSKUName = "Standard_E4a_v4"
	AzureSKUNameStandardE4AdsV5       AzureSKUName = "Standard_E4ads_v5"
	AzureSKUNameStandardE4DV4         AzureSKUName = "Standard_E4d_v4"
	AzureSKUNameStandardE4DV5         AzureSKUName = "Standard_E4d_v5"
	AzureSKUNameStandardE64IV3        AzureSKUName = "Standard_E64i_v3"
	AzureSKUNameStandardE80IDsV4      AzureSKUName = "Standard_E80ids_v4"
	AzureSKUNameStandardE8AV4         AzureSKUName = "Standard_E8a_v4"
	AzureSKUNameStandardE8AdsV5       AzureSKUName = "Standard_E8ads_v5"
	AzureSKUNameStandardE8AsV41TBPS   AzureSKUName = "Standard_E8as_v4+1TB_PS"
	AzureSKUNameStandardE8AsV42TBPS   AzureSKUName = "Standard_E8as_v4+2TB_PS"
	AzureSKUNameStandardE8AsV51TBPS   AzureSKUName = "Standard_E8as_v5+1TB_PS"
	AzureSKUNameStandardE8AsV52TBPS   AzureSKUName = "Standard_E8as_v5+2TB_PS"
	AzureSKUNameStandardE8DV4         AzureSKUName = "Standard_E8d_v4"
	AzureSKUNameStandardE8DV5         AzureSKUName = "Standard_E8d_v5"
	AzureSKUNameStandardE8SV41TBPS    AzureSKUName = "Standard_E8s_v4+1TB_PS"
	AzureSKUNameStandardE8SV42TBPS    AzureSKUName = "Standard_E8s_v4+2TB_PS"
	AzureSKUNameStandardE8SV51TBPS    AzureSKUName = "Standard_E8s_v5+1TB_PS"
	AzureSKUNameStandardE8SV52TBPS    AzureSKUName = "Standard_E8s_v5+2TB_PS"
	AzureSKUNameStandardEC16AdsV5     AzureSKUName = "Standard_EC16ads_v5"
	AzureSKUNameStandardEC16AsV53TBPS AzureSKUName = "Standard_EC16as_v5+3TB_PS"
	AzureSKUNameStandardEC16AsV54TBPS AzureSKUName = "Standard_EC16as_v5+4TB_PS"
	AzureSKUNameStandardEC8AdsV5      AzureSKUName = "Standard_EC8ads_v5"
	AzureSKUNameStandardEC8AsV51TBPS  AzureSKUName = "Standard_EC8as_v5+1TB_PS"
	AzureSKUNameStandardEC8AsV52TBPS  AzureSKUName = "Standard_EC8as_v5+2TB_PS"
	AzureSKUNameStandardL16AsV3       AzureSKUName = "Standard_L16as_v3"
	AzureSKUNameStandardL16S          AzureSKUName = "Standard_L16s"
	AzureSKUNameStandardL16SV2        AzureSKUName = "Standard_L16s_v2"
	AzureSKUNameStandardL16SV3        AzureSKUName = "Standard_L16s_v3"
	AzureSKUNameStandardL32AsV3       AzureSKUName = "Standard_L32as_v3"
	AzureSKUNameStandardL32SV3        AzureSKUName = "Standard_L32s_v3"
	AzureSKUNameStandardL4S           AzureSKUName = "Standard_L4s"
	AzureSKUNameStandardL8AsV3        AzureSKUName = "Standard_L8as_v3"
	AzureSKUNameStandardL8S           AzureSKUName = "Standard_L8s"
	AzureSKUNameStandardL8SV2         AzureSKUName = "Standard_L8s_v2"
	AzureSKUNameStandardL8SV3         AzureSKUName = "Standard_L8s_v3"
)

func PossibleAzureSKUNameValues 

func PossibleAzureSKUNameValues() []AzureSKUName

PossibleAzureSKUNameValues returns the possible values for the AzureSKUName const type.

type AzureSKUTier 

type AzureSKUTier string

AzureSKUTier - SKU tier. 

const (
	AzureSKUTierBasic    AzureSKUTier = "Basic"
	AzureSKUTierStandard AzureSKUTier = "Standard"
)

func PossibleAzureSKUTierValues 

func PossibleAzureSKUTierValues() []AzureSKUTier

PossibleAzureSKUTierValues returns the possible values for the AzureSKUTier const type.

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 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 CallerRole 

type CallerRole string
const (
	CallerRoleAdmin CallerRole = "Admin"
	CallerRoleNone  CallerRole = "None"
)

func PossibleCallerRoleValues 

func PossibleCallerRoleValues() []CallerRole

PossibleCallerRoleValues returns the possible values for the CallerRole const type.

type CheckNameRequest 

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

	// REQUIRED; The type of resource, for instance Microsoft.Kusto/clusters/databases.
	Type *Type
}

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

func (CheckNameRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CheckNameRequest.

func (*CheckNameRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameRequest.

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 

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

MarshalJSON implements the json.Marshaller interface for type CheckNameResult.

func (*CheckNameResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameResult.

type ClientFactory 

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 

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) NewAttachedDatabaseConfigurationsClient 

func (c *ClientFactory) NewAttachedDatabaseConfigurationsClient() *AttachedDatabaseConfigurationsClient

NewAttachedDatabaseConfigurationsClient creates a new instance of AttachedDatabaseConfigurationsClient.

func (*ClientFactory) NewClusterPrincipalAssignmentsClient 

func (c *ClientFactory) NewClusterPrincipalAssignmentsClient() *ClusterPrincipalAssignmentsClient

NewClusterPrincipalAssignmentsClient creates a new instance of ClusterPrincipalAssignmentsClient.

func (*ClientFactory) NewClustersClient 

func (c *ClientFactory) NewClustersClient() *ClustersClient

NewClustersClient creates a new instance of ClustersClient.

func (*ClientFactory) NewDataConnectionsClient 

func (c *ClientFactory) NewDataConnectionsClient() *DataConnectionsClient

NewDataConnectionsClient creates a new instance of DataConnectionsClient.

func (*ClientFactory) NewDatabaseClient 

func (c *ClientFactory) NewDatabaseClient() *DatabaseClient

NewDatabaseClient creates a new instance of DatabaseClient.

func (*ClientFactory) NewDatabasePrincipalAssignmentsClient 

func (c *ClientFactory) NewDatabasePrincipalAssignmentsClient() *DatabasePrincipalAssignmentsClient

NewDatabasePrincipalAssignmentsClient creates a new instance of DatabasePrincipalAssignmentsClient.

func (*ClientFactory) NewDatabasesClient 

func (c *ClientFactory) NewDatabasesClient() *DatabasesClient

NewDatabasesClient creates a new instance of DatabasesClient.

func (*ClientFactory) NewManagedPrivateEndpointsClient 

func (c *ClientFactory) NewManagedPrivateEndpointsClient() *ManagedPrivateEndpointsClient

NewManagedPrivateEndpointsClient creates a new instance of ManagedPrivateEndpointsClient.

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewOperationsResultsClient 

func (c *ClientFactory) NewOperationsResultsClient() *OperationsResultsClient

NewOperationsResultsClient creates a new instance of OperationsResultsClient.

func (*ClientFactory) NewOperationsResultsLocationClient 

func (c *ClientFactory) NewOperationsResultsLocationClient() *OperationsResultsLocationClient

NewOperationsResultsLocationClient creates a new instance of OperationsResultsLocationClient.

func (*ClientFactory) NewPrivateEndpointConnectionsClient 

func (c *ClientFactory) NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient.

func (*ClientFactory) NewPrivateLinkResourcesClient 

func (c *ClientFactory) NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient.

func (*ClientFactory) NewSKUsClient 

func (c *ClientFactory) NewSKUsClient() *SKUsClient

NewSKUsClient creates a new instance of SKUsClient.

func (*ClientFactory) NewSandboxCustomImagesClient added in v2.1.0 

func (c *ClientFactory) NewSandboxCustomImagesClient() *SandboxCustomImagesClient

NewSandboxCustomImagesClient creates a new instance of SandboxCustomImagesClient.

func (*ClientFactory) NewScriptsClient 

func (c *ClientFactory) NewScriptsClient() *ScriptsClient

NewScriptsClient creates a new instance of ScriptsClient.

type Cluster 

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

	// REQUIRED; The SKU of the cluster.
	SKU *AzureSKU

	// The identity of the cluster, if configured.
	Identity *Identity

	// The cluster properties.
	Properties *ClusterProperties

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

	// The availability zones of the cluster.
	Zones []*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; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

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

Cluster - Class representing a Kusto cluster.

func (Cluster) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Cluster.

func (*Cluster) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Cluster.

type ClusterCheckNameRequest 

type ClusterCheckNameRequest struct {
	// REQUIRED; Cluster name.
	Name *string

	// CONSTANT; The type of resource, Microsoft.Kusto/clusters.
	// Field has constant value "Microsoft.Kusto/clusters", any specified value is ignored.
	Type *string
}

ClusterCheckNameRequest - The result returned from a cluster check name availability request.

func (ClusterCheckNameRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterCheckNameRequest.

func (*ClusterCheckNameRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterCheckNameRequest.

type ClusterListResult 

type ClusterListResult struct {
	// The list of Kusto clusters.
	Value []*Cluster
}

ClusterListResult - The list Kusto clusters operation response.

func (ClusterListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterListResult.

func (*ClusterListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterListResult.

type ClusterMigrateRequest 

type ClusterMigrateRequest struct {
	// REQUIRED; Resource ID of the destination cluster or kusto pool.
	ClusterResourceID *string
}

ClusterMigrateRequest - A cluster migrate request.

func (ClusterMigrateRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterMigrateRequest.

func (*ClusterMigrateRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterMigrateRequest.

type ClusterNetworkAccessFlag 

type ClusterNetworkAccessFlag string

ClusterNetworkAccessFlag - Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled' 

const (
	ClusterNetworkAccessFlagDisabled ClusterNetworkAccessFlag = "Disabled"
	ClusterNetworkAccessFlagEnabled  ClusterNetworkAccessFlag = "Enabled"
)

func PossibleClusterNetworkAccessFlagValues 

func PossibleClusterNetworkAccessFlagValues() []ClusterNetworkAccessFlag

PossibleClusterNetworkAccessFlagValues returns the possible values for the ClusterNetworkAccessFlag const type.

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; 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.Kusto/clusters/principalAssignments.
	// Field has constant value "Microsoft.Kusto/clusters/principalAssignments", any specified value is ignored.
	Type *string
}

ClusterPrincipalAssignmentCheckNameRequest - A principal assignment check name availability request.

func (ClusterPrincipalAssignmentCheckNameRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterPrincipalAssignmentCheckNameRequest.

func (*ClusterPrincipalAssignmentCheckNameRequest) UnmarshalJSON 

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterPrincipalAssignmentListResult.

type ClusterPrincipalAssignmentsClient 

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

ClusterPrincipalAssignmentsClient contains the methods for the ClusterPrincipalAssignments group. Don't use this type directly, use NewClusterPrincipalAssignmentsClient() instead.

func NewClusterPrincipalAssignmentsClient 

func NewClusterPrincipalAssignmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClusterPrincipalAssignmentsClient, error)

NewClusterPrincipalAssignmentsClient creates a new instance of ClusterPrincipalAssignmentsClient 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 (*ClusterPrincipalAssignmentsClient) BeginCreateOrUpdate 

func (client *ClusterPrincipalAssignmentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, principalAssignmentName string, parameters ClusterPrincipalAssignment, options *ClusterPrincipalAssignmentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ClusterPrincipalAssignmentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a Kusto cluster principalAssignment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • parameters - The Kusto cluster principalAssignment's parameters supplied for the operation.
  • options - ClusterPrincipalAssignmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the ClusterPrincipalAssignmentsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClusterPrincipalAssignmentsClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "kustoprincipal1", armkusto.ClusterPrincipalAssignment{
	Properties: &armkusto.ClusterPrincipalProperties{
		PrincipalID:   to.Ptr("87654321-1234-1234-1234-123456789123"),
		PrincipalType: to.Ptr(armkusto.PrincipalTypeApp),
		Role:          to.Ptr(armkusto.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 = armkusto.ClusterPrincipalAssignment{
// 	Name: to.Ptr("kustoCluster/kustoprincipal1"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/PrincipalAssignments"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/PrincipalAssignments/kustoprincipal1"),
// 	Properties: &armkusto.ClusterPrincipalProperties{
// 		AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
// 		PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
// 		PrincipalName: to.Ptr("TestApp"),
// 		PrincipalType: to.Ptr(armkusto.PrincipalTypeApp),
// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 		Role: to.Ptr(armkusto.ClusterPrincipalRoleAllDatabasesAdmin),
// 		TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
// 		TenantName: to.Ptr("tenantName"),
// 	},
// }

Output:

func (*ClusterPrincipalAssignmentsClient) BeginDelete 

func (client *ClusterPrincipalAssignmentsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, principalAssignmentName string, options *ClusterPrincipalAssignmentsClientBeginDeleteOptions) (*runtime.Poller[ClusterPrincipalAssignmentsClientDeleteResponse], error)

BeginDelete - Deletes a Kusto cluster principalAssignment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • options - ClusterPrincipalAssignmentsClientBeginDeleteOptions contains the optional parameters for the ClusterPrincipalAssignmentsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClusterPrincipalAssignmentsDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClusterPrincipalAssignmentsClient().BeginDelete(ctx, "kustorptest", "kustoCluster", "kustoprincipal1", 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 (*ClusterPrincipalAssignmentsClient) CheckNameAvailability 

func (client *ClusterPrincipalAssignmentsClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, clusterName string, principalAssignmentName ClusterPrincipalAssignmentCheckNameRequest, options *ClusterPrincipalAssignmentsClientCheckNameAvailabilityOptions) (ClusterPrincipalAssignmentsClientCheckNameAvailabilityResponse, 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 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • principalAssignmentName - The name of the principal assignment.
  • options - ClusterPrincipalAssignmentsClientCheckNameAvailabilityOptions contains the optional parameters for the ClusterPrincipalAssignmentsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewClusterPrincipalAssignmentsClient().CheckNameAvailability(ctx, "kustorptest", "kustoCluster", armkusto.ClusterPrincipalAssignmentCheckNameRequest{
	Name: to.Ptr("kustoprincipal1"),
	Type: to.Ptr("Microsoft.Kusto/clusters/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 = armkusto.CheckNameResult{
// 	Name: to.Ptr("kustoprincipal1"),
// 	Message: to.Ptr("Name 'kustoprincipal1' is already taken. Please specify a different name"),
// 	NameAvailable: to.Ptr(false),
// }

Output:

func (*ClusterPrincipalAssignmentsClient) Get 

func (client *ClusterPrincipalAssignmentsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, principalAssignmentName string, options *ClusterPrincipalAssignmentsClientGetOptions) (ClusterPrincipalAssignmentsClientGetResponse, error)

Get - Gets a Kusto cluster principalAssignment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • options - ClusterPrincipalAssignmentsClientGetOptions contains the optional parameters for the ClusterPrincipalAssignmentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClusterPrincipalAssignmentsGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewClusterPrincipalAssignmentsClient().Get(ctx, "kustorptest", "kustoCluster", "kustoprincipal1", 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 = armkusto.ClusterPrincipalAssignment{
// 	Name: to.Ptr("kustoCluster/kustoprincipal1"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/PrincipalAssignments"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/PrincipalAssignments/kustoprincipal1"),
// 	Properties: &armkusto.ClusterPrincipalProperties{
// 		AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
// 		PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
// 		PrincipalName: to.Ptr("TestApp"),
// 		PrincipalType: to.Ptr(armkusto.PrincipalTypeApp),
// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 		Role: to.Ptr(armkusto.ClusterPrincipalRoleAllDatabasesAdmin),
// 		TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
// 		TenantName: to.Ptr("tenantName"),
// 	},
// }

Output:

func (*ClusterPrincipalAssignmentsClient) NewListPager 

func (client *ClusterPrincipalAssignmentsClient) NewListPager(resourceGroupName string, clusterName string, options *ClusterPrincipalAssignmentsClientListOptions) *runtime.Pager[ClusterPrincipalAssignmentsClientListResponse]

NewListPager - Lists all Kusto cluster principalAssignments.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - ClusterPrincipalAssignmentsClientListOptions contains the optional parameters for the ClusterPrincipalAssignmentsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClusterPrincipalAssignmentsList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewClusterPrincipalAssignmentsClient().NewListPager("kustorptest", "kustoCluster", 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 = armkusto.ClusterPrincipalAssignmentListResult{
	// 	Value: []*armkusto.ClusterPrincipalAssignment{
	// 		{
	// 			Name: to.Ptr("kustoCluster/Kustodatabase8/kustoprincipal1"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/PrincipalAssignments"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1"),
	// 			Properties: &armkusto.ClusterPrincipalProperties{
	// 				AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
	// 				PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
	// 				PrincipalName: to.Ptr("TestApp"),
	// 				PrincipalType: to.Ptr(armkusto.PrincipalTypeApp),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				Role: to.Ptr(armkusto.ClusterPrincipalRoleAllDatabasesAdmin),
	// 				TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
	// 				TenantName: to.Ptr("tenantName"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("kustoCluster/Kustodatabase8/kustoprincipal2"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/PrincipalAssignments"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1"),
	// 			Properties: &armkusto.ClusterPrincipalProperties{
	// 				AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
	// 				PrincipalID: to.Ptr("11112222-1234-1234-1234-123456789123"),
	// 				PrincipalName: to.Ptr("TestApp"),
	// 				PrincipalType: to.Ptr(armkusto.PrincipalTypeApp),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				Role: to.Ptr(armkusto.ClusterPrincipalRoleAllDatabasesViewer),
	// 				TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
	// 				TenantName: to.Ptr("tenantName"),
	// 			},
	// 	}},
	// }
}

Output:

type ClusterPrincipalAssignmentsClientBeginCreateOrUpdateOptions 

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

ClusterPrincipalAssignmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the ClusterPrincipalAssignmentsClient.BeginCreateOrUpdate method.

type ClusterPrincipalAssignmentsClientBeginDeleteOptions 

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

ClusterPrincipalAssignmentsClientBeginDeleteOptions contains the optional parameters for the ClusterPrincipalAssignmentsClient.BeginDelete method.

type ClusterPrincipalAssignmentsClientCheckNameAvailabilityOptions 

type ClusterPrincipalAssignmentsClientCheckNameAvailabilityOptions struct {
}

ClusterPrincipalAssignmentsClientCheckNameAvailabilityOptions contains the optional parameters for the ClusterPrincipalAssignmentsClient.CheckNameAvailability method.

type ClusterPrincipalAssignmentsClientCheckNameAvailabilityResponse 

type ClusterPrincipalAssignmentsClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

ClusterPrincipalAssignmentsClientCheckNameAvailabilityResponse contains the response from method ClusterPrincipalAssignmentsClient.CheckNameAvailability.

type ClusterPrincipalAssignmentsClientCreateOrUpdateResponse 

type ClusterPrincipalAssignmentsClientCreateOrUpdateResponse struct {
	// Class representing a cluster principal assignment.
	ClusterPrincipalAssignment
}

ClusterPrincipalAssignmentsClientCreateOrUpdateResponse contains the response from method ClusterPrincipalAssignmentsClient.BeginCreateOrUpdate.

type ClusterPrincipalAssignmentsClientDeleteResponse 

type ClusterPrincipalAssignmentsClientDeleteResponse struct {
}

ClusterPrincipalAssignmentsClientDeleteResponse contains the response from method ClusterPrincipalAssignmentsClient.BeginDelete.

type ClusterPrincipalAssignmentsClientGetOptions 

type ClusterPrincipalAssignmentsClientGetOptions struct {
}

ClusterPrincipalAssignmentsClientGetOptions contains the optional parameters for the ClusterPrincipalAssignmentsClient.Get method.

type ClusterPrincipalAssignmentsClientGetResponse 

type ClusterPrincipalAssignmentsClientGetResponse struct {
	// Class representing a cluster principal assignment.
	ClusterPrincipalAssignment
}

ClusterPrincipalAssignmentsClientGetResponse contains the response from method ClusterPrincipalAssignmentsClient.Get.

type ClusterPrincipalAssignmentsClientListOptions 

type ClusterPrincipalAssignmentsClientListOptions struct {
}

ClusterPrincipalAssignmentsClientListOptions contains the optional parameters for the ClusterPrincipalAssignmentsClient.NewListPager method.

type ClusterPrincipalAssignmentsClientListResponse 

type ClusterPrincipalAssignmentsClientListResponse struct {
	// The list Kusto cluster principal assignments operation response.
	ClusterPrincipalAssignmentListResult
}

ClusterPrincipalAssignmentsClientListResponse contains the response from method ClusterPrincipalAssignmentsClient.NewListPager.

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 *ProvisioningState

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

ClusterPrincipalProperties - A class representing cluster principal property.

func (ClusterPrincipalProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterPrincipalProperties.

func (*ClusterPrincipalProperties) UnmarshalJSON 

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 ClusterProperties 

type ClusterProperties struct {
	// The cluster's accepted audiences.
	AcceptedAudiences []*AcceptedAudiences

	// List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster.
	AllowedFqdnList []*string

	// The list of ips in the format of CIDR allowed to connect to the cluster.
	AllowedIPRangeList []*string

	// A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many
	// days).
	EnableAutoStop *bool

	// A boolean value that indicates if the cluster's disks are encrypted.
	EnableDiskEncryption *bool

	// A boolean value that indicates if double encryption is enabled.
	EnableDoubleEncryption *bool

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

	// The engine type
	EngineType *EngineType

	// KeyVault properties for the cluster encryption.
	KeyVaultProperties *KeyVaultProperties

	// List of the cluster's language extensions.
	LanguageExtensions *LanguageExtensionsList

	// Optimized auto scale definition.
	OptimizedAutoscale *OptimizedAutoscale

	// Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6)
	PublicIPType *PublicIPType

	// Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster
	// is allowed
	PublicNetworkAccess *PublicNetworkAccess

	// Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
	RestrictOutboundNetworkAccess *ClusterNetworkAccessFlag

	// The cluster's external tenants.
	TrustedExternalTenants []*TrustedExternalTenant

	// Virtual Cluster graduation properties
	VirtualClusterGraduationProperties *string

	// Virtual network definition.
	VirtualNetworkConfiguration *VirtualNetworkConfiguration

	// READ-ONLY; The cluster data ingestion URI.
	DataIngestionURI *string

	// READ-ONLY; Properties of the peer cluster involved in a migration to/from this cluster.
	MigrationCluster *MigrationClusterProperties

	// READ-ONLY; A list of private endpoint connections.
	PrivateEndpointConnections []*PrivateEndpointConnection

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

	// READ-ONLY; The state of the resource.
	State *State

	// READ-ONLY; The reason for the cluster's current state.
	StateReason *string

	// READ-ONLY; The cluster URI.
	URI *string
}

ClusterProperties - Class representing the Kusto cluster properties.

func (ClusterProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterProperties.

func (*ClusterProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterProperties.

type ClusterUpdate 

type ClusterUpdate struct {
	// The identity of the cluster, if configured.
	Identity *Identity

	// Resource location.
	Location *string

	// The cluster properties.
	Properties *ClusterProperties

	// The SKU of the cluster.
	SKU *AzureSKU

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

	// The availability zones of the cluster.
	Zones []*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
}

ClusterUpdate - Class representing an update to a Kusto cluster.

func (ClusterUpdate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ClusterUpdate.

func (*ClusterUpdate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterUpdate.

type ClustersClient 

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

ClustersClient contains the methods for the Clusters group. Don't use this type directly, use NewClustersClient() instead.

func NewClustersClient 

func NewClustersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClustersClient, error)

NewClustersClient creates a new instance of ClustersClient 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 (*ClustersClient) BeginAddLanguageExtensions 

func (client *ClustersClient) BeginAddLanguageExtensions(ctx context.Context, resourceGroupName string, clusterName string, languageExtensionsToAdd LanguageExtensionsList, options *ClustersClientBeginAddLanguageExtensionsOptions) (*runtime.Poller[ClustersClientAddLanguageExtensionsResponse], 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 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • languageExtensionsToAdd - The language extensions to add.
  • options - ClustersClientBeginAddLanguageExtensionsOptions contains the optional parameters for the ClustersClient.BeginAddLanguageExtensions method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClusterAddLanguageExtensions.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginAddLanguageExtensions(ctx, "kustorptest", "kustoCluster", armkusto.LanguageExtensionsList{
	Value: []*armkusto.LanguageExtension{
		{
			LanguageExtensionName: to.Ptr(armkusto.LanguageExtensionNamePYTHON),
		},
		{
			LanguageExtensionName: to.Ptr(armkusto.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 (*ClustersClient) BeginCreateOrUpdate 

func (client *ClustersClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, parameters Cluster, options *ClustersClientBeginCreateOrUpdateOptions) (*runtime.Poller[ClustersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a Kusto cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • parameters - The Kusto cluster parameters supplied to the CreateOrUpdate operation.
  • options - ClustersClientBeginCreateOrUpdateOptions contains the optional parameters for the ClustersClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", armkusto.Cluster{
	Location: to.Ptr("westus"),
	Identity: &armkusto.Identity{
		Type: to.Ptr(armkusto.IdentityTypeSystemAssigned),
	},
	Properties: &armkusto.ClusterProperties{
		AllowedIPRangeList: []*string{
			to.Ptr("0.0.0.0/0")},
		EnableAutoStop:         to.Ptr(true),
		EnableDoubleEncryption: to.Ptr(false),
		EnablePurge:            to.Ptr(true),
		EnableStreamingIngest:  to.Ptr(true),
		LanguageExtensions: &armkusto.LanguageExtensionsList{
			Value: []*armkusto.LanguageExtension{
				{
					LanguageExtensionCustomImageName: to.Ptr("customImage8"),
					LanguageExtensionImageName:       to.Ptr(armkusto.LanguageExtensionImageName("Python_Custom_Image")),
					LanguageExtensionName:            to.Ptr(armkusto.LanguageExtensionNamePYTHON),
				},
				{
					LanguageExtensionImageName: to.Ptr(armkusto.LanguageExtensionImageNameR),
					LanguageExtensionName:      to.Ptr(armkusto.LanguageExtensionNameR),
				}},
		},
		PublicIPType:        to.Ptr(armkusto.PublicIPTypeDualStack),
		PublicNetworkAccess: to.Ptr(armkusto.PublicNetworkAccessEnabled),
	},
	SKU: &armkusto.AzureSKU{
		Name:     to.Ptr(armkusto.AzureSKUNameStandardL16AsV3),
		Capacity: to.Ptr[int32](2),
		Tier:     to.Ptr(armkusto.AzureSKUTierStandard),
	},
}, &armkusto.ClustersClientBeginCreateOrUpdateOptions{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.Cluster = armkusto.Cluster{
// 	Name: to.Ptr("kustoCluster"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster"),
// 	Location: to.Ptr("westus"),
// 	Etag: to.Ptr("abcd"),
// 	Identity: &armkusto.Identity{
// 		Type: to.Ptr(armkusto.IdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("faabad1f-4876-463c-af9d-6ba2d2d2394c"),
// 		TenantID: to.Ptr("b932977f-6277-4ab7-a2cd-5bd21f07aaf4"),
// 		UserAssignedIdentities: map[string]*armkusto.ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties{
// 		},
// 	},
// 	Properties: &armkusto.ClusterProperties{
// 		AllowedIPRangeList: []*string{
// 			to.Ptr("0.0.0.0/0")},
// 			EnableAutoStop: to.Ptr(true),
// 			EnableDiskEncryption: to.Ptr(false),
// 			EnableDoubleEncryption: to.Ptr(false),
// 			EnablePurge: to.Ptr(true),
// 			EnableStreamingIngest: to.Ptr(true),
// 			EngineType: to.Ptr(armkusto.EngineTypeV3),
// 			KeyVaultProperties: &armkusto.KeyVaultProperties{
// 				KeyName: to.Ptr("keyName"),
// 				KeyVaultURI: to.Ptr("https://dummy.keyvault.com"),
// 				KeyVersion: to.Ptr("keyVersion"),
// 			},
// 			LanguageExtensions: &armkusto.LanguageExtensionsList{
// 				Value: []*armkusto.LanguageExtension{
// 					{
// 						LanguageExtensionCustomImageName: to.Ptr("customImage8"),
// 						LanguageExtensionImageName: to.Ptr(armkusto.LanguageExtensionImageName("Python_Custom_Image")),
// 						LanguageExtensionName: to.Ptr(armkusto.LanguageExtensionNamePYTHON),
// 					},
// 					{
// 						LanguageExtensionImageName: to.Ptr(armkusto.LanguageExtensionImageNameR),
// 						LanguageExtensionName: to.Ptr(armkusto.LanguageExtensionNameR),
// 				}},
// 			},
// 			ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 			PublicIPType: to.Ptr(armkusto.PublicIPTypeDualStack),
// 			PublicNetworkAccess: to.Ptr(armkusto.PublicNetworkAccessEnabled),
// 			RestrictOutboundNetworkAccess: to.Ptr(armkusto.ClusterNetworkAccessFlagDisabled),
// 		},
// 		SKU: &armkusto.AzureSKU{
// 			Name: to.Ptr(armkusto.AzureSKUNameStandardL16AsV3),
// 			Capacity: to.Ptr[int32](2),
// 			Tier: to.Ptr(armkusto.AzureSKUTierStandard),
// 		},
// 	}

Output:

func (*ClustersClient) BeginDelete 

func (client *ClustersClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, options *ClustersClientBeginDeleteOptions) (*runtime.Poller[ClustersClientDeleteResponse], error)

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

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - ClustersClientBeginDeleteOptions contains the optional parameters for the ClustersClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginDelete(ctx, "kustorptest", "kustoCluster2", 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 (*ClustersClient) BeginDetachFollowerDatabases 

func (client *ClustersClient) BeginDetachFollowerDatabases(ctx context.Context, resourceGroupName string, clusterName string, followerDatabaseToRemove FollowerDatabaseDefinition, options *ClustersClientBeginDetachFollowerDatabasesOptions) (*runtime.Poller[ClustersClientDetachFollowerDatabasesResponse], error)

BeginDetachFollowerDatabases - Detaches all followers of a database owned by this cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • followerDatabaseToRemove - The follower databases properties to remove.
  • options - ClustersClientBeginDetachFollowerDatabasesOptions contains the optional parameters for the ClustersClient.BeginDetachFollowerDatabases method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClusterDetachFollowerDatabases.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginDetachFollowerDatabases(ctx, "kustorptest", "kustoCluster", armkusto.FollowerDatabaseDefinition{
	AttachedDatabaseConfigurationName: to.Ptr("attachedDatabaseConfigurationsTest"),
	ClusterResourceID:                 to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster2"),
}, 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 (*ClustersClient) BeginDiagnoseVirtualNetwork 

func (client *ClustersClient) BeginDiagnoseVirtualNetwork(ctx context.Context, resourceGroupName string, clusterName string, options *ClustersClientBeginDiagnoseVirtualNetworkOptions) (*runtime.Poller[ClustersClientDiagnoseVirtualNetworkResponse], error)

BeginDiagnoseVirtualNetwork - Diagnoses network connectivity status for external resources on which the service is dependent on. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - ClustersClientBeginDiagnoseVirtualNetworkOptions contains the optional parameters for the ClustersClient.BeginDiagnoseVirtualNetwork method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersDiagnoseVirtualNetwork.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginDiagnoseVirtualNetwork(ctx, "kustorptest", "kustoCluster", 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.DiagnoseVirtualNetworkResult = armkusto.DiagnoseVirtualNetworkResult{
// 	Findings: []*string{
// 		to.Ptr("Outbound dependency 'Storage:443' might not be satisfied (Outbound)")},
// 	}

Output:

func (*ClustersClient) BeginMigrate 

func (client *ClustersClient) BeginMigrate(ctx context.Context, resourceGroupName string, clusterName string, clusterMigrateRequest ClusterMigrateRequest, options *ClustersClientBeginMigrateOptions) (*runtime.Poller[ClustersClientMigrateResponse], error)

BeginMigrate - Migrate data from a Kusto cluster to another cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • clusterMigrateRequest - The cluster migrate request parameters.
  • options - ClustersClientBeginMigrateOptions contains the optional parameters for the ClustersClient.BeginMigrate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClusterMigrate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginMigrate(ctx, "kustorptest", "kustoCluster1", armkusto.ClusterMigrateRequest{
	ClusterResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster2"),
}, 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 (*ClustersClient) BeginRemoveLanguageExtensions 

func (client *ClustersClient) BeginRemoveLanguageExtensions(ctx context.Context, resourceGroupName string, clusterName string, languageExtensionsToRemove LanguageExtensionsList, options *ClustersClientBeginRemoveLanguageExtensionsOptions) (*runtime.Poller[ClustersClientRemoveLanguageExtensionsResponse], 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 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • languageExtensionsToRemove - The language extensions to remove.
  • options - ClustersClientBeginRemoveLanguageExtensionsOptions contains the optional parameters for the ClustersClient.BeginRemoveLanguageExtensions method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClusterRemoveLanguageExtensions.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginRemoveLanguageExtensions(ctx, "kustorptest", "kustoCluster", armkusto.LanguageExtensionsList{
	Value: []*armkusto.LanguageExtension{
		{
			LanguageExtensionName: to.Ptr(armkusto.LanguageExtensionNamePYTHON),
		},
		{
			LanguageExtensionName: to.Ptr(armkusto.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 (*ClustersClient) BeginStart 

func (client *ClustersClient) BeginStart(ctx context.Context, resourceGroupName string, clusterName string, options *ClustersClientBeginStartOptions) (*runtime.Poller[ClustersClientStartResponse], error)

BeginStart - Starts a Kusto cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - ClustersClientBeginStartOptions contains the optional parameters for the ClustersClient.BeginStart method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersStart.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginStart(ctx, "kustorptest", "kustoCluster2", 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 (*ClustersClient) BeginStop 

func (client *ClustersClient) BeginStop(ctx context.Context, resourceGroupName string, clusterName string, options *ClustersClientBeginStopOptions) (*runtime.Poller[ClustersClientStopResponse], error)

BeginStop - Stops a Kusto cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - ClustersClientBeginStopOptions contains the optional parameters for the ClustersClient.BeginStop method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersStop.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginStop(ctx, "kustorptest", "kustoCluster2", 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 (*ClustersClient) BeginUpdate 

func (client *ClustersClient) BeginUpdate(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterUpdate, options *ClustersClientBeginUpdateOptions) (*runtime.Poller[ClustersClientUpdateResponse], error)

BeginUpdate - Update a Kusto cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • parameters - The Kusto cluster parameters supplied to the Update operation.
  • options - ClustersClientBeginUpdateOptions contains the optional parameters for the ClustersClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewClustersClient().BeginUpdate(ctx, "kustorptest", "kustoCluster2", armkusto.ClusterUpdate{
	Location: to.Ptr("westus"),
}, &armkusto.ClustersClientBeginUpdateOptions{IfMatch: to.Ptr("*")})
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.Cluster = armkusto.Cluster{
// 	Name: to.Ptr("kustoCluster2"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2"),
// 	Location: to.Ptr("westus"),
// 	Etag: to.Ptr("abcd123"),
// 	Identity: &armkusto.Identity{
// 		Type: to.Ptr(armkusto.IdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("faabad1f-4876-463c-af9d-6ba2d2d2394c"),
// 		TenantID: to.Ptr("b932977f-6277-4ab7-a2cd-5bd21f07aaf4"),
// 		UserAssignedIdentities: map[string]*armkusto.ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties{
// 		},
// 	},
// 	Properties: &armkusto.ClusterProperties{
// 		EnableAutoStop: to.Ptr(true),
// 		EnableDiskEncryption: to.Ptr(false),
// 		EnablePurge: to.Ptr(true),
// 		EnableStreamingIngest: to.Ptr(true),
// 		EngineType: to.Ptr(armkusto.EngineTypeV3),
// 		KeyVaultProperties: &armkusto.KeyVaultProperties{
// 			KeyName: to.Ptr("keyName"),
// 			KeyVaultURI: to.Ptr("https://dummy.keyvault.com"),
// 			KeyVersion: to.Ptr("keyVersion"),
// 		},
// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 		PublicIPType: to.Ptr(armkusto.PublicIPTypeIPv4),
// 		RestrictOutboundNetworkAccess: to.Ptr(armkusto.ClusterNetworkAccessFlagDisabled),
// 	},
// 	SKU: &armkusto.AzureSKU{
// 		Name: to.Ptr(armkusto.AzureSKUNameStandardL16AsV3),
// 		Capacity: to.Ptr[int32](2),
// 		Tier: to.Ptr(armkusto.AzureSKUTierStandard),
// 	},
// }

Output:

func (*ClustersClient) CheckNameAvailability 

func (client *ClustersClient) CheckNameAvailability(ctx context.Context, location string, clusterName ClusterCheckNameRequest, options *ClustersClientCheckNameAvailabilityOptions) (ClustersClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the cluster name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • location - The name of Azure region.
  • clusterName - The name of the cluster.
  • options - ClustersClientCheckNameAvailabilityOptions contains the optional parameters for the ClustersClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersCheckNameAvailability.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewClustersClient().CheckNameAvailability(ctx, "westus", armkusto.ClusterCheckNameRequest{
	Name: to.Ptr("kustoCluster"),
	Type: to.Ptr("Microsoft.Kusto/clusters"),
}, 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 = armkusto.CheckNameResult{
// 	Name: to.Ptr("kuskusprod"),
// 	Message: to.Ptr("Name 'kuskusprod' is already taken. Please specify a different name"),
// 	NameAvailable: to.Ptr(false),
// }

Output:

func (*ClustersClient) Get 

func (client *ClustersClient) Get(ctx context.Context, resourceGroupName string, clusterName string, options *ClustersClientGetOptions) (ClustersClientGetResponse, error)

Get - Gets a Kusto cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - ClustersClientGetOptions contains the optional parameters for the ClustersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewClustersClient().Get(ctx, "kustorptest", "kustoCluster", 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.Cluster = armkusto.Cluster{
// 	Name: to.Ptr("kustoCluster"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster"),
// 	Location: to.Ptr("westus"),
// 	Etag: to.Ptr("abcd123"),
// 	Identity: &armkusto.Identity{
// 		Type: to.Ptr(armkusto.IdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("faabad1f-4876-463c-af9d-6ba2d2d2394c"),
// 		TenantID: to.Ptr("b932977f-6277-4ab7-a2cd-5bd21f07aaf4"),
// 		UserAssignedIdentities: map[string]*armkusto.ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties{
// 		},
// 	},
// 	Properties: &armkusto.ClusterProperties{
// 		AllowedFqdnList: []*string{
// 			to.Ptr("my-stroage.blob.core.windows.net")},
// 			AllowedIPRangeList: []*string{
// 			},
// 			EnableAutoStop: to.Ptr(true),
// 			EnableDiskEncryption: to.Ptr(false),
// 			EnablePurge: to.Ptr(false),
// 			EnableStreamingIngest: to.Ptr(true),
// 			EngineType: to.Ptr(armkusto.EngineTypeV3),
// 			KeyVaultProperties: &armkusto.KeyVaultProperties{
// 				KeyName: to.Ptr("keyName"),
// 				KeyVaultURI: to.Ptr("https://dummy.keyvault.com"),
// 				KeyVersion: to.Ptr("keyVersion"),
// 			},
// 			MigrationCluster: &armkusto.MigrationClusterProperties{
// 				DataIngestionURI: to.Ptr("https://ingest-kustocluster2.westus.kusto.windows.net"),
// 				ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2"),
// 				Role: to.Ptr(armkusto.MigrationClusterRoleDestination),
// 				URI: to.Ptr("https://kustocluster2.westus.kusto.windows.net"),
// 			},
// 			PrivateEndpointConnections: []*armkusto.PrivateEndpointConnection{
// 				{
// 					Name: to.Ptr("privateEndpointTest"),
// 					Type: to.Ptr("Microsoft.Kusto/Clusters/PrivateEndpointConnections"),
// 					ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/privateEndpointConnections/privateEndpointTest"),
// 					Properties: &armkusto.PrivateEndpointConnectionProperties{
// 						GroupID: to.Ptr("cluster"),
// 						PrivateEndpoint: &armkusto.PrivateEndpointProperty{
// 							ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName"),
// 						},
// 						PrivateLinkServiceConnectionState: &armkusto.PrivateLinkServiceConnectionStateProperty{
// 							Description: to.Ptr("Auto-approved"),
// 							ActionsRequired: to.Ptr("None"),
// 							Status: to.Ptr("Approved"),
// 						},
// 						ProvisioningState: to.Ptr("Succeeded"),
// 					},
// 			}},
// 			ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 			PublicIPType: to.Ptr(armkusto.PublicIPTypeIPv4),
// 			PublicNetworkAccess: to.Ptr(armkusto.PublicNetworkAccessEnabled),
// 			RestrictOutboundNetworkAccess: to.Ptr(armkusto.ClusterNetworkAccessFlagEnabled),
// 		},
// 		SKU: &armkusto.AzureSKU{
// 			Name: to.Ptr(armkusto.AzureSKUNameStandardL16AsV3),
// 			Capacity: to.Ptr[int32](2),
// 			Tier: to.Ptr(armkusto.AzureSKUTierStandard),
// 		},
// 		SystemData: &armkusto.SystemData{
// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-29T15:06:54.275Z"); return t}()),
// 			CreatedBy: to.Ptr("user@microsoft.com"),
// 			CreatedByType: to.Ptr(armkusto.CreatedByTypeUser),
// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-29T15:06:54.275Z"); return t}()),
// 			LastModifiedBy: to.Ptr("user@microsoft.com"),
// 			LastModifiedByType: to.Ptr(armkusto.CreatedByTypeUser),
// 		},
// 	}

Output:

func (*ClustersClient) NewListByResourceGroupPager 

func (client *ClustersClient) NewListByResourceGroupPager(resourceGroupName string, options *ClustersClientListByResourceGroupOptions) *runtime.Pager[ClustersClientListByResourceGroupResponse]

NewListByResourceGroupPager - Lists all Kusto clusters within a resource group.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ClustersClientListByResourceGroupOptions contains the optional parameters for the ClustersClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersListByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewClustersClient().NewListByResourceGroupPager("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.ClusterListResult = armkusto.ClusterListResult{
	// 	Value: []*armkusto.Cluster{
	// 		{
	// 			Name: to.Ptr("KustoClusterRPTest4"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4"),
	// 			Location: to.Ptr("westus"),
	// 			Etag: to.Ptr("abcd123"),
	// 			Properties: &armkusto.ClusterProperties{
	// 				AllowedFqdnList: []*string{
	// 					to.Ptr("my-stroage.blob.core.windows.net")},
	// 					AllowedIPRangeList: []*string{
	// 					},
	// 					EnableDiskEncryption: to.Ptr(false),
	// 					EnableStreamingIngest: to.Ptr(true),
	// 					EngineType: to.Ptr(armkusto.EngineTypeV2),
	// 					KeyVaultProperties: &armkusto.KeyVaultProperties{
	// 						KeyName: to.Ptr("keyName"),
	// 						KeyVaultURI: to.Ptr("https://dummy.keyvault.com"),
	// 						KeyVersion: to.Ptr("keyVersion"),
	// 					},
	// 					MigrationCluster: &armkusto.MigrationClusterProperties{
	// 						DataIngestionURI: to.Ptr("https://ingest-kustocluster2.westus.kusto.windows.net"),
	// 						ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2"),
	// 						Role: to.Ptr(armkusto.MigrationClusterRoleDestination),
	// 						URI: to.Ptr("https://kustocluster2.westus.kusto.windows.net"),
	// 					},
	// 					ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 					PublicNetworkAccess: to.Ptr(armkusto.PublicNetworkAccessEnabled),
	// 					RestrictOutboundNetworkAccess: to.Ptr(armkusto.ClusterNetworkAccessFlagDisabled),
	// 				},
	// 				SKU: &armkusto.AzureSKU{
	// 					Name: to.Ptr(armkusto.AzureSKUNameStandardL16AsV3),
	// 					Capacity: to.Ptr[int32](2),
	// 					Tier: to.Ptr(armkusto.AzureSKUTierStandard),
	// 				},
	// 			},
	// 			{
	// 				Name: to.Ptr("KustoClusterRPTest3"),
	// 				Type: to.Ptr("Microsoft.Kusto/Clusters"),
	// 				ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3"),
	// 				Location: to.Ptr("westus"),
	// 				Etag: to.Ptr("abcd123"),
	// 				Properties: &armkusto.ClusterProperties{
	// 					AllowedIPRangeList: []*string{
	// 						to.Ptr("0.0.0.0/0")},
	// 						EnableDiskEncryption: to.Ptr(true),
	// 						EnableStreamingIngest: to.Ptr(true),
	// 						EngineType: to.Ptr(armkusto.EngineTypeV3),
	// 						ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 						PublicNetworkAccess: to.Ptr(armkusto.PublicNetworkAccessEnabled),
	// 						RestrictOutboundNetworkAccess: to.Ptr(armkusto.ClusterNetworkAccessFlagDisabled),
	// 					},
	// 					SKU: &armkusto.AzureSKU{
	// 						Name: to.Ptr(armkusto.AzureSKUNameStandardL16AsV3),
	// 						Capacity: to.Ptr[int32](2),
	// 						Tier: to.Ptr(armkusto.AzureSKUTierStandard),
	// 					},
	// 			}},
	// 		}
}

Output:

func (*ClustersClient) NewListFollowerDatabasesPager 

func (client *ClustersClient) NewListFollowerDatabasesPager(resourceGroupName string, clusterName string, options *ClustersClientListFollowerDatabasesOptions) *runtime.Pager[ClustersClientListFollowerDatabasesResponse]

NewListFollowerDatabasesPager - Returns a list of databases that are owned by this cluster and were followed by another cluster.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - ClustersClientListFollowerDatabasesOptions contains the optional parameters for the ClustersClient.NewListFollowerDatabasesPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClusterListFollowerDatabases.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewClustersClient().NewListFollowerDatabasesPager("kustorptest", "kustoCluster", 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 = armkusto.FollowerDatabaseListResult{
	// 	Value: []*armkusto.FollowerDatabaseDefinition{
	// 		{
	// 			AttachedDatabaseConfigurationName: to.Ptr("attachedDbConfiguration"),
	// 			ClusterResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower1"),
	// 			DatabaseName: to.Ptr("*"),
	// 			DatabaseShareOrigin: to.Ptr(armkusto.DatabaseShareOriginDataShare),
	// 		},
	// 		{
	// 			AttachedDatabaseConfigurationName: to.Ptr("attachedDbConfiguration2"),
	// 			ClusterResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower4"),
	// 			DatabaseName: to.Ptr("db1"),
	// 			DatabaseShareOrigin: to.Ptr(armkusto.DatabaseShareOriginDirect),
	// 			TableLevelSharingProperties: &armkusto.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 (*ClustersClient) NewListLanguageExtensionsPager 

func (client *ClustersClient) NewListLanguageExtensionsPager(resourceGroupName string, clusterName string, options *ClustersClientListLanguageExtensionsOptions) *runtime.Pager[ClustersClientListLanguageExtensionsResponse]

NewListLanguageExtensionsPager - Returns a list of language extensions that can run within KQL queries.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - ClustersClientListLanguageExtensionsOptions contains the optional parameters for the ClustersClient.NewListLanguageExtensionsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClusterListLanguageExtensions.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewClustersClient().NewListLanguageExtensionsPager("kustorptest", "kustoCluster", 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 = armkusto.LanguageExtensionsList{
	// 	Value: []*armkusto.LanguageExtension{
	// 		{
	// 			LanguageExtensionName: to.Ptr(armkusto.LanguageExtensionNamePYTHON),
	// 		},
	// 		{
	// 			LanguageExtensionName: to.Ptr(armkusto.LanguageExtensionNameR),
	// 	}},
	// }
}

Output:

func (*ClustersClient) NewListOutboundNetworkDependenciesEndpointsPager 

func (client *ClustersClient) NewListOutboundNetworkDependenciesEndpointsPager(resourceGroupName string, clusterName string, options *ClustersClientListOutboundNetworkDependenciesEndpointsOptions) *runtime.Pager[ClustersClientListOutboundNetworkDependenciesEndpointsResponse]

NewListOutboundNetworkDependenciesEndpointsPager - Gets the network endpoints of all outbound dependencies of a Kusto cluster

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - ClustersClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the ClustersClient.NewListOutboundNetworkDependenciesEndpointsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoOutboundNetworkDependenciesList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewClustersClient().NewListOutboundNetworkDependenciesEndpointsPager("kustorptest", "kustoCluster", 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.OutboundNetworkDependenciesEndpointListResult = armkusto.OutboundNetworkDependenciesEndpointListResult{
	// 	Value: []*armkusto.OutboundNetworkDependenciesEndpoint{
	// 		{
	// 			Name: to.Ptr("kustoCluster/AzureActiveDirectory"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/OutboundNetworkDependenciesEndpoints"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/OutboundNetworkDependenciesEndpoints/AzureActiveDirectory"),
	// 			Properties: &armkusto.OutboundNetworkDependenciesEndpointProperties{
	// 				Category: to.Ptr("Azure Active Directory"),
	// 				Endpoints: []*armkusto.EndpointDependency{
	// 					{
	// 						DomainName: to.Ptr("login.microsoftonline.com"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](443),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("graph.windows.net"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](443),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("graph.microsoft.com"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](443),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("graph.microsoft-ppe.com"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](443),
	// 						}},
	// 				}},
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("kustoCluster/AzureMonitor"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/OutboundNetworkDependenciesEndpoints"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/OutboundNetworkDependenciesEndpoints/AzureMonitor"),
	// 			Properties: &armkusto.OutboundNetworkDependenciesEndpointProperties{
	// 				Category: to.Ptr("Azure Monitor"),
	// 				Endpoints: []*armkusto.EndpointDependency{
	// 					{
	// 						DomainName: to.Ptr("prod.warmpath.msftcloudes.com"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](443),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("gcs.prod.monitoring.core.windows.net"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](443),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("production.diagnostics.monitoring.core.windows.net"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](443),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("shoebox2.metrics.nsatc.net:443"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](443),
	// 						}},
	// 				}},
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("kustoCluster/CertificateAuthority"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/OutboundNetworkDependenciesEndpoints"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/OutboundNetworkDependenciesEndpoints/CertificateAuthority"),
	// 			Properties: &armkusto.OutboundNetworkDependenciesEndpointProperties{
	// 				Category: to.Ptr("Certificate Authority"),
	// 				Endpoints: []*armkusto.EndpointDependency{
	// 					{
	// 						DomainName: to.Ptr("ocsp.msocsp.com"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](80),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("ocsp.digicert.com"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](80),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("crl3.digicert.com"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](80),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("crl.microsoft.com"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](80),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("www.microsoft.com"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](80),
	// 						}},
	// 				}},
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("kustoCluster/AzureStorage"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/OutboundNetworkDependenciesEndpoints"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/OutboundNetworkDependenciesEndpoints/AzureStorage"),
	// 			Properties: &armkusto.OutboundNetworkDependenciesEndpointProperties{
	// 				Category: to.Ptr("Azure Storage"),
	// 				Endpoints: []*armkusto.EndpointDependency{
	// 					{
	// 						DomainName: to.Ptr("clusterinternalsa.blob.core.windows.net"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](443),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("clusterinternalsa.queue.core.windows.net"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](443),
	// 						}},
	// 					},
	// 					{
	// 						DomainName: to.Ptr("clusterinternalsa.table.core.windows.net"),
	// 						EndpointDetails: []*armkusto.EndpointDetail{
	// 							{
	// 								IPAddress: to.Ptr("1.2.3.4"),
	// 								Port: to.Ptr[int32](443),
	// 						}},
	// 				}},
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

func (*ClustersClient) NewListPager 

func (client *ClustersClient) NewListPager(options *ClustersClientListOptions) *runtime.Pager[ClustersClientListResponse]

NewListPager - Lists all Kusto clusters within a subscription.

Generated from API version 2023-08-15

  • options - ClustersClientListOptions contains the optional parameters for the ClustersClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewClustersClient().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.ClusterListResult = armkusto.ClusterListResult{
	// 	Value: []*armkusto.Cluster{
	// 		{
	// 			Name: to.Ptr("kustoCluster"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster"),
	// 			Location: to.Ptr("westus"),
	// 			Etag: to.Ptr("abcd123"),
	// 			Properties: &armkusto.ClusterProperties{
	// 				AllowedFqdnList: []*string{
	// 					to.Ptr("my-stroage.blob.core.windows.net")},
	// 					AllowedIPRangeList: []*string{
	// 					},
	// 					EnableAutoStop: to.Ptr(true),
	// 					EnableDiskEncryption: to.Ptr(false),
	// 					EnableStreamingIngest: to.Ptr(true),
	// 					EngineType: to.Ptr(armkusto.EngineTypeV3),
	// 					KeyVaultProperties: &armkusto.KeyVaultProperties{
	// 						KeyName: to.Ptr("keyName"),
	// 						KeyVaultURI: to.Ptr("https://dummy.keyvault.com"),
	// 						KeyVersion: to.Ptr("keyVersion"),
	// 					},
	// 					MigrationCluster: &armkusto.MigrationClusterProperties{
	// 						DataIngestionURI: to.Ptr("https://ingest-kustocluster2.westus.kusto.windows.net"),
	// 						ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2"),
	// 						Role: to.Ptr(armkusto.MigrationClusterRoleDestination),
	// 						URI: to.Ptr("https://kustocluster2.westus.kusto.windows.net"),
	// 					},
	// 					PrivateEndpointConnections: []*armkusto.PrivateEndpointConnection{
	// 						{
	// 							Name: to.Ptr("privateEndpointTest"),
	// 							Type: to.Ptr("Microsoft.Kusto/Clusters/PrivateEndpointConnections"),
	// 							ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/privateEndpointConnections/privateEndpointTest"),
	// 							Properties: &armkusto.PrivateEndpointConnectionProperties{
	// 								GroupID: to.Ptr("cluster"),
	// 								PrivateEndpoint: &armkusto.PrivateEndpointProperty{
	// 									ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName"),
	// 								},
	// 								PrivateLinkServiceConnectionState: &armkusto.PrivateLinkServiceConnectionStateProperty{
	// 									Description: to.Ptr("Auto-approved"),
	// 									ActionsRequired: to.Ptr("None"),
	// 									Status: to.Ptr("Approved"),
	// 								},
	// 								ProvisioningState: to.Ptr("Succeeded"),
	// 							},
	// 					}},
	// 					ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 					PublicIPType: to.Ptr(armkusto.PublicIPTypeDualStack),
	// 					PublicNetworkAccess: to.Ptr(armkusto.PublicNetworkAccessEnabled),
	// 					RestrictOutboundNetworkAccess: to.Ptr(armkusto.ClusterNetworkAccessFlagEnabled),
	// 				},
	// 				SKU: &armkusto.AzureSKU{
	// 					Name: to.Ptr(armkusto.AzureSKUNameStandardL16AsV3),
	// 					Capacity: to.Ptr[int32](2),
	// 					Tier: to.Ptr(armkusto.AzureSKUTierStandard),
	// 				},
	// 			},
	// 			{
	// 				Name: to.Ptr("KustoClusterRPTest3"),
	// 				Type: to.Ptr("Microsoft.Kusto/Clusters"),
	// 				ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3"),
	// 				Location: to.Ptr("westus"),
	// 				Etag: to.Ptr("abcd123"),
	// 				Properties: &armkusto.ClusterProperties{
	// 					AllowedIPRangeList: []*string{
	// 						to.Ptr("0.0.0.0/0")},
	// 						EnableDiskEncryption: to.Ptr(true),
	// 						EnableStreamingIngest: to.Ptr(true),
	// 						EngineType: to.Ptr(armkusto.EngineTypeV2),
	// 						PrivateEndpointConnections: []*armkusto.PrivateEndpointConnection{
	// 						},
	// 						ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 						PublicIPType: to.Ptr(armkusto.PublicIPTypeIPv4),
	// 						PublicNetworkAccess: to.Ptr(armkusto.PublicNetworkAccessEnabled),
	// 						RestrictOutboundNetworkAccess: to.Ptr(armkusto.ClusterNetworkAccessFlagDisabled),
	// 					},
	// 					SKU: &armkusto.AzureSKU{
	// 						Name: to.Ptr(armkusto.AzureSKUNameStandardL16AsV3),
	// 						Capacity: to.Ptr[int32](2),
	// 						Tier: to.Ptr(armkusto.AzureSKUTierStandard),
	// 					},
	// 			}},
	// 		}
}

Output:

func (*ClustersClient) NewListSKUsByResourcePager 

func (client *ClustersClient) NewListSKUsByResourcePager(resourceGroupName string, clusterName string, options *ClustersClientListSKUsByResourceOptions) *runtime.Pager[ClustersClientListSKUsByResourceResponse]

NewListSKUsByResourcePager - Returns the SKUs available for the provided resource.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - ClustersClientListSKUsByResourceOptions contains the optional parameters for the ClustersClient.NewListSKUsByResourcePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersListResourceSkus.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewClustersClient().NewListSKUsByResourcePager("kustorptest", "kustoCluster", 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 = armkusto.ListResourceSKUsResult{
	// 	Value: []*armkusto.AzureResourceSKU{
	// 		{
	// 			Capacity: &armkusto.AzureCapacity{
	// 				Default: to.Ptr[int32](2),
	// 				Maximum: to.Ptr[int32](100),
	// 				Minimum: to.Ptr[int32](2),
	// 				ScaleType: to.Ptr(armkusto.AzureScaleTypeAutomatic),
	// 			},
	// 			ResourceType: to.Ptr("clusters"),
	// 			SKU: &armkusto.AzureSKU{
	// 				Name: to.Ptr(armkusto.AzureSKUNameStandardL8SV3),
	// 				Tier: to.Ptr(armkusto.AzureSKUTierStandard),
	// 			},
	// 		},
	// 		{
	// 			Capacity: &armkusto.AzureCapacity{
	// 				Default: to.Ptr[int32](2),
	// 				Maximum: to.Ptr[int32](100),
	// 				Minimum: to.Ptr[int32](2),
	// 				ScaleType: to.Ptr(armkusto.AzureScaleTypeAutomatic),
	// 			},
	// 			ResourceType: to.Ptr("clusters"),
	// 			SKU: &armkusto.AzureSKU{
	// 				Name: to.Ptr(armkusto.AzureSKUNameStandardL8AsV3),
	// 				Tier: to.Ptr(armkusto.AzureSKUTierStandard),
	// 			},
	// 		},
	// 		{
	// 			Capacity: &armkusto.AzureCapacity{
	// 				Default: to.Ptr[int32](2),
	// 				Maximum: to.Ptr[int32](100),
	// 				Minimum: to.Ptr[int32](2),
	// 				ScaleType: to.Ptr(armkusto.AzureScaleTypeAutomatic),
	// 			},
	// 			ResourceType: to.Ptr("clusters"),
	// 			SKU: &armkusto.AzureSKU{
	// 				Name: to.Ptr(armkusto.AzureSKUNameStandardL16AsV3),
	// 				Tier: to.Ptr(armkusto.AzureSKUTierStandard),
	// 			},
	// 		},
	// 		{
	// 			Capacity: &armkusto.AzureCapacity{
	// 				Default: to.Ptr[int32](2),
	// 				Maximum: to.Ptr[int32](100),
	// 				Minimum: to.Ptr[int32](2),
	// 				ScaleType: to.Ptr(armkusto.AzureScaleTypeAutomatic),
	// 			},
	// 			ResourceType: to.Ptr("clusters"),
	// 			SKU: &armkusto.AzureSKU{
	// 				Name: to.Ptr(armkusto.AzureSKUNameStandardL16SV3),
	// 				Tier: to.Ptr(armkusto.AzureSKUTierStandard),
	// 			},
	// 	}},
	// }
}

Output:

func (*ClustersClient) NewListSKUsPager 

func (client *ClustersClient) NewListSKUsPager(options *ClustersClientListSKUsOptions) *runtime.Pager[ClustersClientListSKUsResponse]

NewListSKUsPager - Lists eligible SKUs for Kusto resource provider.

Generated from API version 2023-08-15

  • options - ClustersClientListSKUsOptions contains the optional parameters for the ClustersClient.NewListSKUsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoClustersListSkus.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewClustersClient().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 = armkusto.SKUDescriptionList{
	// 	Value: []*armkusto.SKUDescription{
	// 		{
	// 			Name: to.Ptr("Standard_L8s_v3"),
	// 			LocationInfo: []*armkusto.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")},
	// 					Tier: to.Ptr("Standard"),
	// 				},
	// 				{
	// 					Name: to.Ptr("Standard_L16s_v3"),
	// 					LocationInfo: []*armkusto.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")},
	// 							Tier: to.Ptr("Standard"),
	// 						},
	// 						{
	// 							Name: to.Ptr("Standard_L8as_v3"),
	// 							LocationInfo: []*armkusto.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")},
	// 									Tier: to.Ptr("Standard"),
	// 								},
	// 								{
	// 									Name: to.Ptr("Standard_L16as_v3"),
	// 									LocationInfo: []*armkusto.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")},
	// 											Tier: to.Ptr("Standard"),
	// 									}},
	// 								}
}

Output:

type ClustersClientAddLanguageExtensionsResponse 

type ClustersClientAddLanguageExtensionsResponse struct {
}

ClustersClientAddLanguageExtensionsResponse contains the response from method ClustersClient.BeginAddLanguageExtensions.

type ClustersClientBeginAddLanguageExtensionsOptions 

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

ClustersClientBeginAddLanguageExtensionsOptions contains the optional parameters for the ClustersClient.BeginAddLanguageExtensions method.

type ClustersClientBeginCreateOrUpdateOptions 

type ClustersClientBeginCreateOrUpdateOptions struct {
	// The ETag of the cluster. Omit this value to always overwrite the current cluster. Specify the last-seen ETag value to prevent
	// accidentally overwriting concurrent changes.
	IfMatch *string

	// Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. Other values will result
	// in a 412 Pre-condition Failed response.
	IfNoneMatch *string

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

ClustersClientBeginCreateOrUpdateOptions contains the optional parameters for the ClustersClient.BeginCreateOrUpdate method.

type ClustersClientBeginDeleteOptions 

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

ClustersClientBeginDeleteOptions contains the optional parameters for the ClustersClient.BeginDelete method.

type ClustersClientBeginDetachFollowerDatabasesOptions 

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

ClustersClientBeginDetachFollowerDatabasesOptions contains the optional parameters for the ClustersClient.BeginDetachFollowerDatabases method.

type ClustersClientBeginDiagnoseVirtualNetworkOptions 

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

ClustersClientBeginDiagnoseVirtualNetworkOptions contains the optional parameters for the ClustersClient.BeginDiagnoseVirtualNetwork method.

type ClustersClientBeginMigrateOptions 

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

ClustersClientBeginMigrateOptions contains the optional parameters for the ClustersClient.BeginMigrate method.

type ClustersClientBeginRemoveLanguageExtensionsOptions 

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

ClustersClientBeginRemoveLanguageExtensionsOptions contains the optional parameters for the ClustersClient.BeginRemoveLanguageExtensions method.

type ClustersClientBeginStartOptions 

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

ClustersClientBeginStartOptions contains the optional parameters for the ClustersClient.BeginStart method.

type ClustersClientBeginStopOptions 

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

ClustersClientBeginStopOptions contains the optional parameters for the ClustersClient.BeginStop method.

type ClustersClientBeginUpdateOptions 

type ClustersClientBeginUpdateOptions struct {
	// The ETag of the cluster. Omit this value to always overwrite the current cluster. Specify the last-seen ETag value to prevent
	// accidentally overwriting concurrent changes.
	IfMatch *string

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

ClustersClientBeginUpdateOptions contains the optional parameters for the ClustersClient.BeginUpdate method.

type ClustersClientCheckNameAvailabilityOptions 

type ClustersClientCheckNameAvailabilityOptions struct {
}

ClustersClientCheckNameAvailabilityOptions contains the optional parameters for the ClustersClient.CheckNameAvailability method.

type ClustersClientCheckNameAvailabilityResponse 

type ClustersClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

ClustersClientCheckNameAvailabilityResponse contains the response from method ClustersClient.CheckNameAvailability.

type ClustersClientCreateOrUpdateResponse 

type ClustersClientCreateOrUpdateResponse struct {
	// Class representing a Kusto cluster.
	Cluster
}

ClustersClientCreateOrUpdateResponse contains the response from method ClustersClient.BeginCreateOrUpdate.

type ClustersClientDeleteResponse 

type ClustersClientDeleteResponse struct {
}

ClustersClientDeleteResponse contains the response from method ClustersClient.BeginDelete.

type ClustersClientDetachFollowerDatabasesResponse 

type ClustersClientDetachFollowerDatabasesResponse struct {
}

ClustersClientDetachFollowerDatabasesResponse contains the response from method ClustersClient.BeginDetachFollowerDatabases.

type ClustersClientDiagnoseVirtualNetworkResponse 

type ClustersClientDiagnoseVirtualNetworkResponse struct {
	DiagnoseVirtualNetworkResult
}

ClustersClientDiagnoseVirtualNetworkResponse contains the response from method ClustersClient.BeginDiagnoseVirtualNetwork.

type ClustersClientGetOptions 

type ClustersClientGetOptions struct {
}

ClustersClientGetOptions contains the optional parameters for the ClustersClient.Get method.

type ClustersClientGetResponse 

type ClustersClientGetResponse struct {
	// Class representing a Kusto cluster.
	Cluster
}

ClustersClientGetResponse contains the response from method ClustersClient.Get.

type ClustersClientListByResourceGroupOptions 

type ClustersClientListByResourceGroupOptions struct {
}

ClustersClientListByResourceGroupOptions contains the optional parameters for the ClustersClient.NewListByResourceGroupPager method.

type ClustersClientListByResourceGroupResponse 

type ClustersClientListByResourceGroupResponse struct {
	// The list Kusto clusters operation response.
	ClusterListResult
}

ClustersClientListByResourceGroupResponse contains the response from method ClustersClient.NewListByResourceGroupPager.

type ClustersClientListFollowerDatabasesOptions 

type ClustersClientListFollowerDatabasesOptions struct {
}

ClustersClientListFollowerDatabasesOptions contains the optional parameters for the ClustersClient.NewListFollowerDatabasesPager method.

type ClustersClientListFollowerDatabasesResponse 

type ClustersClientListFollowerDatabasesResponse struct {
	// The list Kusto database principals operation response.
	FollowerDatabaseListResult
}

ClustersClientListFollowerDatabasesResponse contains the response from method ClustersClient.NewListFollowerDatabasesPager.

type ClustersClientListLanguageExtensionsOptions 

type ClustersClientListLanguageExtensionsOptions struct {
}

ClustersClientListLanguageExtensionsOptions contains the optional parameters for the ClustersClient.NewListLanguageExtensionsPager method.

type ClustersClientListLanguageExtensionsResponse 

type ClustersClientListLanguageExtensionsResponse struct {
	// The list of language extension objects.
	LanguageExtensionsList
}

ClustersClientListLanguageExtensionsResponse contains the response from method ClustersClient.NewListLanguageExtensionsPager.

type ClustersClientListOptions 

type ClustersClientListOptions struct {
}

ClustersClientListOptions contains the optional parameters for the ClustersClient.NewListPager method.

type ClustersClientListOutboundNetworkDependenciesEndpointsOptions 

type ClustersClientListOutboundNetworkDependenciesEndpointsOptions struct {
}

ClustersClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the ClustersClient.NewListOutboundNetworkDependenciesEndpointsPager method.

type ClustersClientListOutboundNetworkDependenciesEndpointsResponse 

type ClustersClientListOutboundNetworkDependenciesEndpointsResponse struct {
	// Collection of Outbound Environment Endpoints
	OutboundNetworkDependenciesEndpointListResult
}

ClustersClientListOutboundNetworkDependenciesEndpointsResponse contains the response from method ClustersClient.NewListOutboundNetworkDependenciesEndpointsPager.

type ClustersClientListResponse 

type ClustersClientListResponse struct {
	// The list Kusto clusters operation response.
	ClusterListResult
}

ClustersClientListResponse contains the response from method ClustersClient.NewListPager.

type ClustersClientListSKUsByResourceOptions 

type ClustersClientListSKUsByResourceOptions struct {
}

ClustersClientListSKUsByResourceOptions contains the optional parameters for the ClustersClient.NewListSKUsByResourcePager method.

type ClustersClientListSKUsByResourceResponse 

type ClustersClientListSKUsByResourceResponse struct {
	// List of available SKUs for a Kusto Cluster.
	ListResourceSKUsResult
}

ClustersClientListSKUsByResourceResponse contains the response from method ClustersClient.NewListSKUsByResourcePager.

type ClustersClientListSKUsOptions 

type ClustersClientListSKUsOptions struct {
}

ClustersClientListSKUsOptions contains the optional parameters for the ClustersClient.NewListSKUsPager method.

type ClustersClientListSKUsResponse 

type ClustersClientListSKUsResponse struct {
	// The list of the EngagementFabric SKU descriptions
	SKUDescriptionList
}

ClustersClientListSKUsResponse contains the response from method ClustersClient.NewListSKUsPager.

type ClustersClientMigrateResponse 

type ClustersClientMigrateResponse struct {
}

ClustersClientMigrateResponse contains the response from method ClustersClient.BeginMigrate.

type ClustersClientRemoveLanguageExtensionsResponse 

type ClustersClientRemoveLanguageExtensionsResponse struct {
}

ClustersClientRemoveLanguageExtensionsResponse contains the response from method ClustersClient.BeginRemoveLanguageExtensions.

type ClustersClientStartResponse 

type ClustersClientStartResponse struct {
}

ClustersClientStartResponse contains the response from method ClustersClient.BeginStart.

type ClustersClientStopResponse 

type ClustersClientStopResponse struct {
}

ClustersClientStopResponse contains the response from method ClustersClient.BeginStop.

type ClustersClientUpdateResponse 

type ClustersClientUpdateResponse struct {
	// Class representing a Kusto cluster.
	Cluster
}

ClustersClientUpdateResponse contains the response from method ClustersClient.BeginUpdate.

type ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties 

type ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties struct {
	// READ-ONLY; The client id of user assigned identity.
	ClientID *string

	// READ-ONLY; The principal id of user assigned identity.
	PrincipalID *string
}

func (ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties.

func (*ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties.

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 CosmosDbDataConnection 

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

	// Resource location.
	Location *string

	// The properties of the CosmosDb data connection.
	Properties *CosmosDbDataConnectionProperties

	// 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
}

CosmosDbDataConnection - Class representing a CosmosDb data connection.

func (*CosmosDbDataConnection) GetDataConnection 

func (c *CosmosDbDataConnection) GetDataConnection() *DataConnection

GetDataConnection implements the DataConnectionClassification interface for type CosmosDbDataConnection.

func (CosmosDbDataConnection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CosmosDbDataConnection.

func (*CosmosDbDataConnection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CosmosDbDataConnection.

type CosmosDbDataConnectionProperties 

type CosmosDbDataConnectionProperties struct {
	// REQUIRED; The resource ID of the Cosmos DB account used to create the data connection.
	CosmosDbAccountResourceID *string

	// REQUIRED; The name of an existing container in the Cosmos DB database.
	CosmosDbContainer *string

	// REQUIRED; The name of an existing database in the Cosmos DB account.
	CosmosDbDatabase *string

	// REQUIRED; The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos
	// DB.
	ManagedIdentityResourceID *string

	// REQUIRED; The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
	TableName *string

	// The name of an existing mapping rule to use when ingesting the retrieved data.
	MappingRuleName *string

	// Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval
	// start date.
	RetrievalStartDate *time.Time

	// READ-ONLY; The object ID of the managed identity resource.
	ManagedIdentityObjectID *string

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

CosmosDbDataConnectionProperties - Class representing the Kusto CosmosDb data connection properties.

func (CosmosDbDataConnectionProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CosmosDbDataConnectionProperties.

func (*CosmosDbDataConnectionProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CosmosDbDataConnectionProperties.

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 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; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DataConnection - Class representing an data connection.

func (*DataConnection) GetDataConnection 

func (d *DataConnection) GetDataConnection() *DataConnection

GetDataConnection implements the DataConnectionClassification interface for type DataConnection.

func (DataConnection) MarshalJSON 

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.Kusto/clusters/databases/dataConnections.
	// Field has constant value "Microsoft.Kusto/clusters/databases/dataConnections", any specified value is ignored.
	Type *string
}

DataConnectionCheckNameRequest - A data connection check name availability request.

func (DataConnectionCheckNameRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DataConnectionCheckNameRequest.

func (*DataConnectionCheckNameRequest) UnmarshalJSON 

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: - *CosmosDbDataConnection, *DataConnection, *EventGridDataConnection, *EventHubDataConnection, *IotHubDataConnection

type DataConnectionKind 

type DataConnectionKind string

DataConnectionKind - Kind of the endpoint for the data connection 

const (
	DataConnectionKindCosmosDb  DataConnectionKind = "CosmosDb"
	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 

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 

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

MarshalJSON implements the json.Marshaller interface for type DataConnectionValidationResult.

func (*DataConnectionValidationResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataConnectionValidationResult.

type DataConnectionsClient 

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

DataConnectionsClient contains the methods for the DataConnections group. Don't use this type directly, use NewDataConnectionsClient() instead.

func NewDataConnectionsClient 

func NewDataConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DataConnectionsClient, error)

NewDataConnectionsClient creates a new instance of DataConnectionsClient 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 (*DataConnectionsClient) BeginCreateOrUpdate 

func (client *DataConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, dataConnectionName string, parameters DataConnectionClassification, options *DataConnectionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DataConnectionsClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • dataConnectionName - The name of the data connection.
  • parameters - The data connection parameters supplied to the CreateOrUpdate operation.
  • options - DataConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the DataConnectionsClient.BeginCreateOrUpdate method.
Example (KustoDataConnectionsCosmosDbCreateOrUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsCosmosDbCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDataConnectionsClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "KustoDatabase1", "dataConnectionTest", &armkusto.CosmosDbDataConnection{
	Kind:     to.Ptr(armkusto.DataConnectionKindCosmosDb),
	Location: to.Ptr("westus"),
	Properties: &armkusto.CosmosDbDataConnectionProperties{
		CosmosDbAccountResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1"),
		CosmosDbContainer:         to.Ptr("cosmosDbContainerTest"),
		CosmosDbDatabase:          to.Ptr("cosmosDbDatabaseTest"),
		ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
		MappingRuleName:           to.Ptr("TestMapping"),
		RetrievalStartDate:        to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-07-29T12:00:00.655Z"); return t }()),
		TableName:                 to.Ptr("TestTable"),
	},
}, 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 = armkusto.DataConnectionsClientCreateOrUpdateResponse{
// 	                            DataConnectionClassification: &armkusto.CosmosDbDataConnection{
// 		Name: to.Ptr("kustoCluster/KustoDatabase1/dataConnectionTest"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase1/DataConnections/dataConnectionTest"),
// 		Kind: to.Ptr(armkusto.DataConnectionKindCosmosDb),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.CosmosDbDataConnectionProperties{
// 			CosmosDbAccountResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1"),
// 			CosmosDbContainer: to.Ptr("cosmosDbContainerTest"),
// 			CosmosDbDatabase: to.Ptr("cosmosDbDatabaseTest"),
// 			ManagedIdentityObjectID: to.Ptr("87654321-1234-1234-1234-123456789123"),
// 			ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
// 			MappingRuleName: to.Ptr("TestMapping"),
// 			RetrievalStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-07-29T12:00:00.655Z"); return t}()),
// 			TableName: to.Ptr("TestTable"),
// 		},
// 	},
// 	                        }

Output:
Example (KustoDataConnectionsCreateOrUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDataConnectionsClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", "dataConnectionTest", &armkusto.EventHubDataConnection{
	Kind:     to.Ptr(armkusto.DataConnectionKindEventHub),
	Location: to.Ptr("westus"),
	Properties: &armkusto.EventHubConnectionProperties{
		ConsumerGroup:             to.Ptr("testConsumerGroup1"),
		EventHubResourceID:        to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
		ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
	},
}, 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 = armkusto.DataConnectionsClientCreateOrUpdateResponse{
// 	                            DataConnectionClassification: &armkusto.EventHubDataConnection{
// 		Name: to.Ptr("kustoCluster/KustoDatabase8/dataConnectionTest"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/dataConnectionTest"),
// 		Kind: to.Ptr(armkusto.DataConnectionKindEventHub),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.EventHubConnectionProperties{
// 			Compression: to.Ptr(armkusto.CompressionNone),
// 			ConsumerGroup: to.Ptr("testConsumerGroup1"),
// 			EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
// 			ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
// 		},
// 	},
// 	                        }

Output:
Example (KustoDataConnectionsEventGridCreateOrUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsEventGridCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDataConnectionsClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", "dataConnectionTest", &armkusto.EventGridDataConnection{
	Kind:     to.Ptr(armkusto.DataConnectionKindEventGrid),
	Location: to.Ptr("westus"),
	Properties: &armkusto.EventGridConnectionProperties{
		BlobStorageEventType:      to.Ptr(armkusto.BlobStorageEventTypeMicrosoftStorageBlobCreated),
		ConsumerGroup:             to.Ptr("$Default"),
		DataFormat:                to.Ptr(armkusto.EventGridDataFormatJSON),
		DatabaseRouting:           to.Ptr(armkusto.DatabaseRoutingSingle),
		EventGridResourceID:       to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscriptionTest"),
		EventHubResourceID:        to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest2"),
		IgnoreFirstRecord:         to.Ptr(false),
		ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
		MappingRuleName:           to.Ptr("TestMapping"),
		StorageAccountResourceID:  to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount"),
		TableName:                 to.Ptr("TestTable"),
	},
}, 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 = armkusto.DataConnectionsClientCreateOrUpdateResponse{
// 	                            DataConnectionClassification: &armkusto.EventGridDataConnection{
// 		Name: to.Ptr("kustoCluster/KustoDatabase8/dataConnectionTest"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/KustoDataConnection9"),
// 		Kind: to.Ptr(armkusto.DataConnectionKindEventGrid),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.EventGridConnectionProperties{
// 			BlobStorageEventType: to.Ptr(armkusto.BlobStorageEventTypeMicrosoftStorageBlobCreated),
// 			ConsumerGroup: to.Ptr("$Default"),
// 			DataFormat: to.Ptr(armkusto.EventGridDataFormatJSON),
// 			DatabaseRouting: to.Ptr(armkusto.DatabaseRoutingSingle),
// 			EventGridResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscriptionTest"),
// 			EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest2"),
// 			IgnoreFirstRecord: to.Ptr(false),
// 			ManagedIdentityObjectID: to.Ptr("87654321-1234-1234-1234-123456789123"),
// 			ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
// 			MappingRuleName: to.Ptr("TestMapping"),
// 			StorageAccountResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount"),
// 			TableName: to.Ptr("TestTable"),
// 		},
// 	},
// 	                        }

Output:

func (*DataConnectionsClient) BeginDataConnectionValidation 

func (client *DataConnectionsClient) BeginDataConnectionValidation(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters DataConnectionValidation, options *DataConnectionsClientBeginDataConnectionValidationOptions) (*runtime.Poller[DataConnectionsClientDataConnectionValidationResponse], error)

BeginDataConnectionValidation - Checks that the data connection parameters are valid. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • parameters - The data connection parameters supplied to the CreateOrUpdate operation.
  • options - DataConnectionsClientBeginDataConnectionValidationOptions contains the optional parameters for the DataConnectionsClient.BeginDataConnectionValidation method.
Example (KustoDataConnectionEventGridValidation)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionEventGridValidationAsync.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDataConnectionsClient().BeginDataConnectionValidation(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", armkusto.DataConnectionValidation{
	DataConnectionName: to.Ptr("dataConnectionTest"),
	Properties: &armkusto.EventGridDataConnection{
		Kind: to.Ptr(armkusto.DataConnectionKindEventGrid),
		Properties: &armkusto.EventGridConnectionProperties{
			BlobStorageEventType:      to.Ptr(armkusto.BlobStorageEventTypeMicrosoftStorageBlobCreated),
			ConsumerGroup:             to.Ptr("$Default"),
			DataFormat:                to.Ptr(armkusto.EventGridDataFormatJSON),
			DatabaseRouting:           to.Ptr(armkusto.DatabaseRoutingSingle),
			EventGridResourceID:       to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscriptionTest"),
			EventHubResourceID:        to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
			IgnoreFirstRecord:         to.Ptr(false),
			ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
			MappingRuleName:           to.Ptr("TestMapping"),
			StorageAccountResourceID:  to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount"),
			TableName:                 to.Ptr("TestTable"),
		},
	},
}, 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 = armkusto.DataConnectionValidationListResult{
// }

Output:
Example (KustoDataConnectionValidation)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionValidationAsync.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDataConnectionsClient().BeginDataConnectionValidation(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", armkusto.DataConnectionValidation{
	DataConnectionName: to.Ptr("dataConnectionTest"),
	Properties: &armkusto.EventHubDataConnection{
		Kind: to.Ptr(armkusto.DataConnectionKindEventHub),
		Properties: &armkusto.EventHubConnectionProperties{
			Compression:               to.Ptr(armkusto.CompressionNone),
			ConsumerGroup:             to.Ptr("testConsumerGroup1"),
			DataFormat:                to.Ptr(armkusto.EventHubDataFormatJSON),
			EventHubResourceID:        to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
			ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
			MappingRuleName:           to.Ptr("TestMapping"),
			TableName:                 to.Ptr("TestTable"),
		},
	},
}, 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 = armkusto.DataConnectionValidationListResult{
// }

Output:

func (*DataConnectionsClient) BeginDelete 

func (client *DataConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, dataConnectionName string, options *DataConnectionsClientBeginDeleteOptions) (*runtime.Poller[DataConnectionsClientDeleteResponse], error)

BeginDelete - Deletes the data connection with the given name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • dataConnectionName - The name of the data connection.
  • options - DataConnectionsClientBeginDeleteOptions contains the optional parameters for the DataConnectionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDataConnectionsClient().BeginDelete(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", "dataConnectionTest", 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 (*DataConnectionsClient) BeginUpdate 

func (client *DataConnectionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, dataConnectionName string, parameters DataConnectionClassification, options *DataConnectionsClientBeginUpdateOptions) (*runtime.Poller[DataConnectionsClientUpdateResponse], error)

BeginUpdate - Updates a data connection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • dataConnectionName - The name of the data connection.
  • parameters - The data connection parameters supplied to the Update operation.
  • options - DataConnectionsClientBeginUpdateOptions contains the optional parameters for the DataConnectionsClient.BeginUpdate method.
Example (KustoDataConnectionsCosmosDbUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsCosmosDbUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDataConnectionsClient().BeginUpdate(ctx, "kustorptest", "kustoCluster", "KustoDatabase1", "dataConnectionTest", &armkusto.CosmosDbDataConnection{
	Kind:     to.Ptr(armkusto.DataConnectionKindCosmosDb),
	Location: to.Ptr("westus"),
	Properties: &armkusto.CosmosDbDataConnectionProperties{
		CosmosDbAccountResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1"),
		CosmosDbContainer:         to.Ptr("cosmosDbContainerTest"),
		CosmosDbDatabase:          to.Ptr("cosmosDbDatabaseTest"),
		ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
		MappingRuleName:           to.Ptr("TestMapping"),
		RetrievalStartDate:        to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-07-29T12:00:00.655Z"); return t }()),
		TableName:                 to.Ptr("TestTable"),
	},
}, 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 = armkusto.DataConnectionsClientUpdateResponse{
// 	                            DataConnectionClassification: &armkusto.CosmosDbDataConnection{
// 		Name: to.Ptr("kustoCluster/KustoDatabase1/dataConnectionTest"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase1/DataConnections/dataConnectionTest"),
// 		Kind: to.Ptr(armkusto.DataConnectionKindCosmosDb),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.CosmosDbDataConnectionProperties{
// 			CosmosDbAccountResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1"),
// 			CosmosDbContainer: to.Ptr("cosmosDbContainerTest"),
// 			CosmosDbDatabase: to.Ptr("cosmosDbDatabaseTest"),
// 			ManagedIdentityObjectID: to.Ptr("87654321-1234-1234-1234-123456789123"),
// 			ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
// 			MappingRuleName: to.Ptr("TestMapping"),
// 			RetrievalStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-07-29T12:00:00.655Z"); return t}()),
// 			TableName: to.Ptr("TestTable"),
// 		},
// 	},
// 	                        }

Output:
Example (KustoDataConnectionsEventGridUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsEventGridUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDataConnectionsClient().BeginUpdate(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", "dataConnectionTest", &armkusto.EventGridDataConnection{
	Kind:     to.Ptr(armkusto.DataConnectionKindEventGrid),
	Location: to.Ptr("westus"),
	Properties: &armkusto.EventGridConnectionProperties{
		BlobStorageEventType:      to.Ptr(armkusto.BlobStorageEventTypeMicrosoftStorageBlobCreated),
		ConsumerGroup:             to.Ptr("$Default"),
		DataFormat:                to.Ptr(armkusto.EventGridDataFormatJSON),
		DatabaseRouting:           to.Ptr(armkusto.DatabaseRoutingSingle),
		EventGridResourceID:       to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscriptionTest"),
		EventHubResourceID:        to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest2"),
		IgnoreFirstRecord:         to.Ptr(false),
		ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
		MappingRuleName:           to.Ptr("TestMapping"),
		StorageAccountResourceID:  to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount"),
		TableName:                 to.Ptr("TestTable"),
	},
}, 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 = armkusto.DataConnectionsClientUpdateResponse{
// 	                            DataConnectionClassification: &armkusto.EventGridDataConnection{
// 		Name: to.Ptr("kustoCluster/KustoDatabase8/dataConnectionTest"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/KustoDataConnection9"),
// 		Kind: to.Ptr(armkusto.DataConnectionKindEventGrid),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.EventGridConnectionProperties{
// 			BlobStorageEventType: to.Ptr(armkusto.BlobStorageEventTypeMicrosoftStorageBlobCreated),
// 			ConsumerGroup: to.Ptr("$Default"),
// 			DataFormat: to.Ptr(armkusto.EventGridDataFormatJSON),
// 			DatabaseRouting: to.Ptr(armkusto.DatabaseRoutingSingle),
// 			EventGridResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscriptionTest"),
// 			EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest2"),
// 			IgnoreFirstRecord: to.Ptr(false),
// 			ManagedIdentityObjectID: to.Ptr("87654321-1234-1234-1234-123456789123"),
// 			ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
// 			MappingRuleName: to.Ptr("TestMapping"),
// 			StorageAccountResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount"),
// 			TableName: to.Ptr("TestTable"),
// 		},
// 	},
// 	                        }

Output:
Example (KustoDataConnectionsUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDataConnectionsClient().BeginUpdate(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", "dataConnectionTest", &armkusto.EventHubDataConnection{
	Kind:     to.Ptr(armkusto.DataConnectionKindEventHub),
	Location: to.Ptr("westus"),
	Properties: &armkusto.EventHubConnectionProperties{
		ConsumerGroup:             to.Ptr("testConsumerGroup1"),
		EventHubResourceID:        to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
		ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
	},
}, 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 = armkusto.DataConnectionsClientUpdateResponse{
// 	                            DataConnectionClassification: &armkusto.EventHubDataConnection{
// 		Name: to.Ptr("kustoCluster/KustoDatabase8/dataConnectionTest"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/dataConnectionTest"),
// 		Kind: to.Ptr(armkusto.DataConnectionKindEventHub),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.EventHubConnectionProperties{
// 			Compression: to.Ptr(armkusto.CompressionNone),
// 			ConsumerGroup: to.Ptr("testConsumerGroup1"),
// 			EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
// 			ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
// 		},
// 	},
// 	                        }

Output:

func (*DataConnectionsClient) CheckNameAvailability 

func (client *DataConnectionsClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, dataConnectionName DataConnectionCheckNameRequest, options *DataConnectionsClientCheckNameAvailabilityOptions) (DataConnectionsClientCheckNameAvailabilityResponse, 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 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • dataConnectionName - The name of the data connection.
  • options - DataConnectionsClientCheckNameAvailabilityOptions contains the optional parameters for the DataConnectionsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsCheckNameAvailability.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDataConnectionsClient().CheckNameAvailability(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", armkusto.DataConnectionCheckNameRequest{
	Name: to.Ptr("DataConnections8"),
	Type: to.Ptr("Microsoft.Kusto/clusters/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 = armkusto.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(armkusto.ReasonAlreadyExists),
// }

Output:

func (*DataConnectionsClient) Get 

func (client *DataConnectionsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, dataConnectionName string, options *DataConnectionsClientGetOptions) (DataConnectionsClientGetResponse, error)

Get - Returns a data connection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • dataConnectionName - The name of the data connection.
  • options - DataConnectionsClientGetOptions contains the optional parameters for the DataConnectionsClient.Get method.
Example (KustoDataConnectionsCosmosDbGet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsCosmosDbGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDataConnectionsClient().Get(ctx, "kustorptest", "kustoCluster", "KustoDatabase1", "dataConnectionTest", 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 = armkusto.DataConnectionsClientGetResponse{
// 	                            DataConnectionClassification: &armkusto.CosmosDbDataConnection{
// 		Name: to.Ptr("kustoCluster/KustoDatabase1/KustoDataConnection1"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase1/DataConnections/KustoDataConnection1"),
// 		Kind: to.Ptr(armkusto.DataConnectionKindCosmosDb),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.CosmosDbDataConnectionProperties{
// 			CosmosDbAccountResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1"),
// 			CosmosDbContainer: to.Ptr("cosmosDbContainerTest"),
// 			CosmosDbDatabase: to.Ptr("cosmosDbDatabaseTest"),
// 			ManagedIdentityObjectID: to.Ptr("87654321-1234-1234-1234-123456789123"),
// 			ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
// 			MappingRuleName: to.Ptr("TestMapping"),
// 			ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 			RetrievalStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-07-29T12:00:00.655Z"); return t}()),
// 			TableName: to.Ptr("TestTable"),
// 		},
// 	},
// 	                        }

Output:
Example (KustoDataConnectionsEventGridGet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsEventGridGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDataConnectionsClient().Get(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", "dataConnectionTest", 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 = armkusto.DataConnectionsClientGetResponse{
// 	                            DataConnectionClassification: &armkusto.EventGridDataConnection{
// 		Name: to.Ptr("kustoCluster/KustoDatabase8/dataConnectionTest"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/KustoDataConnection9"),
// 		Kind: to.Ptr(armkusto.DataConnectionKindEventGrid),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.EventGridConnectionProperties{
// 			BlobStorageEventType: to.Ptr(armkusto.BlobStorageEventTypeMicrosoftStorageBlobCreated),
// 			ConsumerGroup: to.Ptr("$Default"),
// 			DataFormat: to.Ptr(armkusto.EventGridDataFormatJSON),
// 			DatabaseRouting: to.Ptr(armkusto.DatabaseRoutingSingle),
// 			EventGridResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscriptionTest"),
// 			EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest2"),
// 			IgnoreFirstRecord: to.Ptr(false),
// 			ManagedIdentityObjectID: to.Ptr("87654321-1234-1234-1234-123456789123"),
// 			ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
// 			MappingRuleName: to.Ptr("TestMapping"),
// 			ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 			StorageAccountResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount"),
// 			TableName: to.Ptr("TestTable"),
// 		},
// 	},
// 	                        }

Output:
Example (KustoDataConnectionsGet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDataConnectionsClient().Get(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", "dataConnectionTest", 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 = armkusto.DataConnectionsClientGetResponse{
// 	                            DataConnectionClassification: &armkusto.EventHubDataConnection{
// 		Name: to.Ptr("kustoCluster/KustoDatabase8/dataConnectionTest"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/dataConnectionTest"),
// 		Kind: to.Ptr(armkusto.DataConnectionKindEventHub),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.EventHubConnectionProperties{
// 			Compression: to.Ptr(armkusto.CompressionNone),
// 			ConsumerGroup: to.Ptr("$Default"),
// 			DataFormat: to.Ptr(armkusto.EventHubDataFormatJSON),
// 			DatabaseRouting: to.Ptr(armkusto.DatabaseRoutingSingle),
// 			EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
// 			EventSystemProperties: []*string{
// 			},
// 			ManagedIdentityObjectID: to.Ptr("87654321-1234-1234-1234-123456789123"),
// 			ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
// 			MappingRuleName: to.Ptr("TestMapping"),
// 			ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 			RetrievalStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-07-29T12:00:00.655Z"); return t}()),
// 			TableName: to.Ptr("TestTable"),
// 		},
// 	},
// 	                        }

Output:

func (*DataConnectionsClient) NewListByDatabasePager 

func (client *DataConnectionsClient) NewListByDatabasePager(resourceGroupName string, clusterName string, databaseName string, options *DataConnectionsClientListByDatabaseOptions) *runtime.Pager[DataConnectionsClientListByDatabaseResponse]

NewListByDatabasePager - Returns the list of data connections of the given Kusto database.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • options - DataConnectionsClientListByDatabaseOptions contains the optional parameters for the DataConnectionsClient.NewListByDatabasePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDataConnectionsListByDatabase.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDataConnectionsClient().NewListByDatabasePager("kustorptest", "kustoCluster", "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 = armkusto.DataConnectionListResult{
	// 	Value: []armkusto.DataConnectionClassification{
	// 		&armkusto.EventHubDataConnection{
	// 			Name: to.Ptr("kustoCluster/KustoDatabase8/KustoDataConnection1"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/KustoDataConnection1"),
	// 			Kind: to.Ptr(armkusto.DataConnectionKindEventHub),
	// 			Location: to.Ptr("westus"),
	// 			Properties: &armkusto.EventHubConnectionProperties{
	// 				Compression: to.Ptr(armkusto.CompressionNone),
	// 				ConsumerGroup: to.Ptr("$Default"),
	// 				DataFormat: to.Ptr(armkusto.EventHubDataFormatJSON),
	// 				DatabaseRouting: to.Ptr(armkusto.DatabaseRoutingSingle),
	// 				EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1"),
	// 				EventSystemProperties: []*string{
	// 				},
	// 				ManagedIdentityObjectID: to.Ptr("87654321-1234-1234-1234-123456789123"),
	// 				ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
	// 				MappingRuleName: to.Ptr("TestMapping"),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				RetrievalStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-07-29T12:00:00.655Z"); return t}()),
	// 				TableName: to.Ptr("TestTable"),
	// 			},
	// 		},
	// 		&armkusto.EventGridDataConnection{
	// 			Name: to.Ptr("kustoCluster/KustoDatabase8/KustoDataConnection2"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/KustoDataConnection2"),
	// 			Kind: to.Ptr(armkusto.DataConnectionKindEventGrid),
	// 			Location: to.Ptr("westus"),
	// 			Properties: &armkusto.EventGridConnectionProperties{
	// 				BlobStorageEventType: to.Ptr(armkusto.BlobStorageEventTypeMicrosoftStorageBlobCreated),
	// 				ConsumerGroup: to.Ptr("$Default"),
	// 				DataFormat: to.Ptr(armkusto.EventGridDataFormatJSON),
	// 				DatabaseRouting: to.Ptr(armkusto.DatabaseRoutingSingle),
	// 				EventGridResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount/providers/Microsoft.EventGrid/eventSubscriptions/eventSubscriptionTest"),
	// 				EventHubResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest2"),
	// 				IgnoreFirstRecord: to.Ptr(false),
	// 				ManagedIdentityObjectID: to.Ptr("87654321-1234-1234-1234-123456789123"),
	// 				ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
	// 				MappingRuleName: to.Ptr("TestMapping"),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				StorageAccountResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/teststorageaccount"),
	// 				TableName: to.Ptr("TestTable"),
	// 			},
	// 		},
	// 		&armkusto.CosmosDbDataConnection{
	// 			Name: to.Ptr("kustoCluster/KustoDatabase8/KustoDataConnection3"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/DataConnections"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/DataConnections/KustoDataConnection3"),
	// 			Kind: to.Ptr(armkusto.DataConnectionKindCosmosDb),
	// 			Location: to.Ptr("westus"),
	// 			Properties: &armkusto.CosmosDbDataConnectionProperties{
	// 				CosmosDbAccountResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.DocumentDb/databaseAccounts/cosmosDbAccountTest1"),
	// 				CosmosDbContainer: to.Ptr("cosmosDbContainerTest"),
	// 				CosmosDbDatabase: to.Ptr("cosmosDbDatabaseTest"),
	// 				ManagedIdentityObjectID: to.Ptr("87654321-1234-1234-1234-123456789123"),
	// 				ManagedIdentityResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1"),
	// 				MappingRuleName: to.Ptr("TestMapping"),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				RetrievalStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-07-29T12:00:00.655Z"); return t}()),
	// 				TableName: to.Ptr("TestTable"),
	// 			},
	// 	}},
	// }
}

Output:

type DataConnectionsClientBeginCreateOrUpdateOptions 

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

DataConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the DataConnectionsClient.BeginCreateOrUpdate method.

type DataConnectionsClientBeginDataConnectionValidationOptions 

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

DataConnectionsClientBeginDataConnectionValidationOptions contains the optional parameters for the DataConnectionsClient.BeginDataConnectionValidation method.

type DataConnectionsClientBeginDeleteOptions 

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

DataConnectionsClientBeginDeleteOptions contains the optional parameters for the DataConnectionsClient.BeginDelete method.

type DataConnectionsClientBeginUpdateOptions 

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

DataConnectionsClientBeginUpdateOptions contains the optional parameters for the DataConnectionsClient.BeginUpdate method.

type DataConnectionsClientCheckNameAvailabilityOptions 

type DataConnectionsClientCheckNameAvailabilityOptions struct {
}

DataConnectionsClientCheckNameAvailabilityOptions contains the optional parameters for the DataConnectionsClient.CheckNameAvailability method.

type DataConnectionsClientCheckNameAvailabilityResponse 

type DataConnectionsClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

DataConnectionsClientCheckNameAvailabilityResponse contains the response from method DataConnectionsClient.CheckNameAvailability.

type DataConnectionsClientCreateOrUpdateResponse 

type DataConnectionsClientCreateOrUpdateResponse struct {
	// Class representing an data connection.
	DataConnectionClassification
}

DataConnectionsClientCreateOrUpdateResponse contains the response from method DataConnectionsClient.BeginCreateOrUpdate.

func (DataConnectionsClientCreateOrUpdateResponse) MarshalJSON added in v2.2.0 

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

MarshalJSON implements the json.Marshaller interface for type DataConnectionsClientCreateOrUpdateResponse.

func (*DataConnectionsClientCreateOrUpdateResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataConnectionsClientCreateOrUpdateResponse.

type DataConnectionsClientDataConnectionValidationResponse 

type DataConnectionsClientDataConnectionValidationResponse struct {
	// The list Kusto data connection validation result.
	DataConnectionValidationListResult
}

DataConnectionsClientDataConnectionValidationResponse contains the response from method DataConnectionsClient.BeginDataConnectionValidation.

type DataConnectionsClientDeleteResponse 

type DataConnectionsClientDeleteResponse struct {
}

DataConnectionsClientDeleteResponse contains the response from method DataConnectionsClient.BeginDelete.

type DataConnectionsClientGetOptions 

type DataConnectionsClientGetOptions struct {
}

DataConnectionsClientGetOptions contains the optional parameters for the DataConnectionsClient.Get method.

type DataConnectionsClientGetResponse 

type DataConnectionsClientGetResponse struct {
	// Class representing an data connection.
	DataConnectionClassification
}

DataConnectionsClientGetResponse contains the response from method DataConnectionsClient.Get.

func (*DataConnectionsClientGetResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataConnectionsClientGetResponse.

type DataConnectionsClientListByDatabaseOptions 

type DataConnectionsClientListByDatabaseOptions struct {
}

DataConnectionsClientListByDatabaseOptions contains the optional parameters for the DataConnectionsClient.NewListByDatabasePager method.

type DataConnectionsClientListByDatabaseResponse 

type DataConnectionsClientListByDatabaseResponse struct {
	// The list Kusto data connections operation response.
	DataConnectionListResult
}

DataConnectionsClientListByDatabaseResponse contains the response from method DataConnectionsClient.NewListByDatabasePager.

type DataConnectionsClientUpdateResponse 

type DataConnectionsClientUpdateResponse struct {
	// Class representing an data connection.
	DataConnectionClassification
}

DataConnectionsClientUpdateResponse contains the response from method DataConnectionsClient.BeginUpdate.

func (DataConnectionsClientUpdateResponse) MarshalJSON added in v2.2.0 

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

MarshalJSON implements the json.Marshaller interface for type DataConnectionsClientUpdateResponse.

func (*DataConnectionsClientUpdateResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataConnectionsClientUpdateResponse.

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; 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 

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 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 DatabaseClient 

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

DatabaseClient contains the methods for the Database group. Don't use this type directly, use NewDatabaseClient() instead.

func NewDatabaseClient 

func NewDatabaseClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DatabaseClient, error)

NewDatabaseClient creates a new instance of DatabaseClient 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 (*DatabaseClient) InviteFollower 

func (client *DatabaseClient) InviteFollower(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters DatabaseInviteFollowerRequest, options *DatabaseClientInviteFollowerOptions) (DatabaseClientInviteFollowerResponse, error)

InviteFollower - Generates an invitation token that allows attaching a follower database to this database. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • parameters - The follower invitation request parameters.
  • options - DatabaseClientInviteFollowerOptions contains the optional parameters for the DatabaseClient.InviteFollower method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabaseInviteFollower.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatabaseClient().InviteFollower(ctx, "kustorptest", "kustoCluster", "database", armkusto.DatabaseInviteFollowerRequest{
	InviteeEmail: to.Ptr("invitee@contoso.com"),
	TableLevelSharingProperties: &armkusto.TableLevelSharingProperties{
		ExternalTablesToExclude: []*string{},
		ExternalTablesToInclude: []*string{
			to.Ptr("ExternalTable*")},
		FunctionsToExclude: []*string{
			to.Ptr("functionsToExclude2")},
		FunctionsToInclude: []*string{
			to.Ptr("functionsToInclude1")},
		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)
}
// 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.DatabaseInviteFollowerResult = armkusto.DatabaseInviteFollowerResult{
// 	GeneratedInvitation: to.Ptr("eyJ0eXAiOiJKVInvitationToken"),
// }

Output:

type DatabaseClientInviteFollowerOptions 

type DatabaseClientInviteFollowerOptions struct {
}

DatabaseClientInviteFollowerOptions contains the optional parameters for the DatabaseClient.InviteFollower method.

type DatabaseClientInviteFollowerResponse 

type DatabaseClientInviteFollowerResponse struct {
	// The result returned from a follower invitation generation request.
	DatabaseInviteFollowerResult
}

DatabaseClientInviteFollowerResponse contains the response from method DatabaseClient.InviteFollower.

type DatabaseInviteFollowerRequest 

type DatabaseInviteFollowerRequest struct {
	// REQUIRED; The email of the invited user for which the follower invitation is generated.
	InviteeEmail *string

	// Table level sharing specifications
	TableLevelSharingProperties *TableLevelSharingProperties
}

DatabaseInviteFollowerRequest - The request to invite a follower to a database.

func (DatabaseInviteFollowerRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DatabaseInviteFollowerRequest.

func (*DatabaseInviteFollowerRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabaseInviteFollowerRequest.

type DatabaseInviteFollowerResult 

type DatabaseInviteFollowerResult struct {
	// The generated invitation token.
	GeneratedInvitation *string
}

DatabaseInviteFollowerResult - The result returned from a follower invitation generation request.

func (DatabaseInviteFollowerResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DatabaseInviteFollowerResult.

func (*DatabaseInviteFollowerResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabaseInviteFollowerResult.

type DatabaseListResult 

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

	// 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 DatabasePrincipal 

type DatabasePrincipal struct {
	// REQUIRED; Database principal name.
	Name *string

	// REQUIRED; Database principal role.
	Role *DatabasePrincipalRole

	// REQUIRED; Database principal type.
	Type *DatabasePrincipalType

	// Application id - relevant only for application principal type.
	AppID *string

	// Database principal email if exists.
	Email *string

	// Database principal fully qualified name.
	Fqn *string

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

DatabasePrincipal - A class representing database principal entity.

func (DatabasePrincipal) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DatabasePrincipal.

func (*DatabasePrincipal) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabasePrincipal.

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; 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.Kusto/clusters/databases/principalAssignments.
	// Field has constant value "Microsoft.Kusto/clusters/databases/principalAssignments", any specified value is ignored.
	Type *string
}

DatabasePrincipalAssignmentCheckNameRequest - A principal assignment check name availability request.

func (DatabasePrincipalAssignmentCheckNameRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DatabasePrincipalAssignmentCheckNameRequest.

func (*DatabasePrincipalAssignmentCheckNameRequest) UnmarshalJSON 

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabasePrincipalAssignmentListResult.

type DatabasePrincipalAssignmentsClient 

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

DatabasePrincipalAssignmentsClient contains the methods for the DatabasePrincipalAssignments group. Don't use this type directly, use NewDatabasePrincipalAssignmentsClient() instead.

func NewDatabasePrincipalAssignmentsClient 

func NewDatabasePrincipalAssignmentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DatabasePrincipalAssignmentsClient, error)

NewDatabasePrincipalAssignmentsClient creates a new instance of DatabasePrincipalAssignmentsClient 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 (*DatabasePrincipalAssignmentsClient) BeginCreateOrUpdate 

func (client *DatabasePrincipalAssignmentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, principalAssignmentName string, parameters DatabasePrincipalAssignment, options *DatabasePrincipalAssignmentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[DatabasePrincipalAssignmentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a Kusto cluster database principalAssignment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • parameters - The Kusto principalAssignments parameters supplied for the operation.
  • options - DatabasePrincipalAssignmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the DatabasePrincipalAssignmentsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDatabasePrincipalAssignmentsClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "Kustodatabase8", "kustoprincipal1", armkusto.DatabasePrincipalAssignment{
	Properties: &armkusto.DatabasePrincipalProperties{
		PrincipalID:   to.Ptr("87654321-1234-1234-1234-123456789123"),
		PrincipalType: to.Ptr(armkusto.PrincipalTypeApp),
		Role:          to.Ptr(armkusto.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 = armkusto.DatabasePrincipalAssignment{
// 	Name: to.Ptr("kustoCluster/Kustodatabase8/kustoprincipal1"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/PrincipalAssignments"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1"),
// 	Properties: &armkusto.DatabasePrincipalProperties{
// 		AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
// 		PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
// 		PrincipalName: to.Ptr("TestApp"),
// 		PrincipalType: to.Ptr(armkusto.PrincipalTypeApp),
// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 		Role: to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
// 		TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
// 		TenantName: to.Ptr("tenantName"),
// 	},
// }

Output:

func (*DatabasePrincipalAssignmentsClient) BeginDelete 

func (client *DatabasePrincipalAssignmentsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, principalAssignmentName string, options *DatabasePrincipalAssignmentsClientBeginDeleteOptions) (*runtime.Poller[DatabasePrincipalAssignmentsClientDeleteResponse], error)

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

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • options - DatabasePrincipalAssignmentsClientBeginDeleteOptions contains the optional parameters for the DatabasePrincipalAssignmentsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabasePrincipalAssignmentsDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDatabasePrincipalAssignmentsClient().BeginDelete(ctx, "kustorptest", "kustoCluster", "Kustodatabase8", "kustoprincipal1", 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 (*DatabasePrincipalAssignmentsClient) CheckNameAvailability 

func (client *DatabasePrincipalAssignmentsClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, principalAssignmentName DatabasePrincipalAssignmentCheckNameRequest, options *DatabasePrincipalAssignmentsClientCheckNameAvailabilityOptions) (DatabasePrincipalAssignmentsClientCheckNameAvailabilityResponse, 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 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • principalAssignmentName - The name of the resource.
  • options - DatabasePrincipalAssignmentsClientCheckNameAvailabilityOptions contains the optional parameters for the DatabasePrincipalAssignmentsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatabasePrincipalAssignmentsClient().CheckNameAvailability(ctx, "kustorptest", "kustoCluster", "Kustodatabase8", armkusto.DatabasePrincipalAssignmentCheckNameRequest{
	Name: to.Ptr("kustoprincipal1"),
	Type: to.Ptr("Microsoft.Kusto/clusters/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 = armkusto.CheckNameResult{
// 	Name: to.Ptr("kustoprincipal1"),
// 	Message: to.Ptr("Name 'kustoprincipal1' is already taken. Please specify a different name"),
// 	NameAvailable: to.Ptr(false),
// }

Output:

func (*DatabasePrincipalAssignmentsClient) Get 

func (client *DatabasePrincipalAssignmentsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, principalAssignmentName string, options *DatabasePrincipalAssignmentsClientGetOptions) (DatabasePrincipalAssignmentsClientGetResponse, error)

Get - Gets a Kusto cluster database principalAssignment. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • principalAssignmentName - The name of the Kusto principalAssignment.
  • options - DatabasePrincipalAssignmentsClientGetOptions contains the optional parameters for the DatabasePrincipalAssignmentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabasePrincipalAssignmentsGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatabasePrincipalAssignmentsClient().Get(ctx, "kustorptest", "kustoCluster", "Kustodatabase8", "kustoprincipal1", 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 = armkusto.DatabasePrincipalAssignment{
// 	Name: to.Ptr("kustoCluster/Kustodatabase8/kustoprincipal1"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/PrincipalAssignments"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1"),
// 	Properties: &armkusto.DatabasePrincipalProperties{
// 		AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
// 		PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
// 		PrincipalName: to.Ptr("TestApp"),
// 		PrincipalType: to.Ptr(armkusto.PrincipalTypeApp),
// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 		Role: to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
// 		TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
// 		TenantName: to.Ptr("tenantName"),
// 	},
// }

Output:

func (*DatabasePrincipalAssignmentsClient) NewListPager 

func (client *DatabasePrincipalAssignmentsClient) NewListPager(resourceGroupName string, clusterName string, databaseName string, options *DatabasePrincipalAssignmentsClientListOptions) *runtime.Pager[DatabasePrincipalAssignmentsClientListResponse]

NewListPager - Lists all Kusto cluster database principalAssignments.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • options - DatabasePrincipalAssignmentsClientListOptions contains the optional parameters for the DatabasePrincipalAssignmentsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabasePrincipalAssignmentsList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDatabasePrincipalAssignmentsClient().NewListPager("kustorptest", "kustoCluster", "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.DatabasePrincipalAssignmentListResult = armkusto.DatabasePrincipalAssignmentListResult{
	// 	Value: []*armkusto.DatabasePrincipalAssignment{
	// 		{
	// 			Name: to.Ptr("kustoCluster/Kustodatabase8/kustoprincipal1"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/PrincipalAssignments"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1"),
	// 			Properties: &armkusto.DatabasePrincipalProperties{
	// 				AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
	// 				PrincipalID: to.Ptr("11223344-1234-1234-1234-123456789999"),
	// 				PrincipalName: to.Ptr("TestApp"),
	// 				PrincipalType: to.Ptr(armkusto.PrincipalTypeApp),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				Role: to.Ptr(armkusto.DatabasePrincipalRoleViewer),
	// 				TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
	// 				TenantName: to.Ptr("tenantName"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("kustoCluster/Kustodatabase8/kustoprincipal2"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/PrincipalAssignments"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1"),
	// 			Properties: &armkusto.DatabasePrincipalProperties{
	// 				AADObjectID: to.Ptr("98765432-1234-1234-1234-123456789123"),
	// 				PrincipalID: to.Ptr("87654321-1234-1234-1234-123456789123"),
	// 				PrincipalName: to.Ptr("TestApp"),
	// 				PrincipalType: to.Ptr(armkusto.PrincipalTypeApp),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				Role: to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
	// 				TenantID: to.Ptr("12345678-1234-1234-1234-123456789123"),
	// 				TenantName: to.Ptr("tenantName"),
	// 			},
	// 	}},
	// }
}

Output:

type DatabasePrincipalAssignmentsClientBeginCreateOrUpdateOptions 

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

DatabasePrincipalAssignmentsClientBeginCreateOrUpdateOptions contains the optional parameters for the DatabasePrincipalAssignmentsClient.BeginCreateOrUpdate method.

type DatabasePrincipalAssignmentsClientBeginDeleteOptions 

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

DatabasePrincipalAssignmentsClientBeginDeleteOptions contains the optional parameters for the DatabasePrincipalAssignmentsClient.BeginDelete method.

type DatabasePrincipalAssignmentsClientCheckNameAvailabilityOptions 

type DatabasePrincipalAssignmentsClientCheckNameAvailabilityOptions struct {
}

DatabasePrincipalAssignmentsClientCheckNameAvailabilityOptions contains the optional parameters for the DatabasePrincipalAssignmentsClient.CheckNameAvailability method.

type DatabasePrincipalAssignmentsClientCheckNameAvailabilityResponse 

type DatabasePrincipalAssignmentsClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

DatabasePrincipalAssignmentsClientCheckNameAvailabilityResponse contains the response from method DatabasePrincipalAssignmentsClient.CheckNameAvailability.

type DatabasePrincipalAssignmentsClientCreateOrUpdateResponse 

type DatabasePrincipalAssignmentsClientCreateOrUpdateResponse struct {
	// Class representing a database principal assignment.
	DatabasePrincipalAssignment
}

DatabasePrincipalAssignmentsClientCreateOrUpdateResponse contains the response from method DatabasePrincipalAssignmentsClient.BeginCreateOrUpdate.

type DatabasePrincipalAssignmentsClientDeleteResponse 

type DatabasePrincipalAssignmentsClientDeleteResponse struct {
}

DatabasePrincipalAssignmentsClientDeleteResponse contains the response from method DatabasePrincipalAssignmentsClient.BeginDelete.

type DatabasePrincipalAssignmentsClientGetOptions 

type DatabasePrincipalAssignmentsClientGetOptions struct {
}

DatabasePrincipalAssignmentsClientGetOptions contains the optional parameters for the DatabasePrincipalAssignmentsClient.Get method.

type DatabasePrincipalAssignmentsClientGetResponse 

type DatabasePrincipalAssignmentsClientGetResponse struct {
	// Class representing a database principal assignment.
	DatabasePrincipalAssignment
}

DatabasePrincipalAssignmentsClientGetResponse contains the response from method DatabasePrincipalAssignmentsClient.Get.

type DatabasePrincipalAssignmentsClientListOptions 

type DatabasePrincipalAssignmentsClientListOptions struct {
}

DatabasePrincipalAssignmentsClientListOptions contains the optional parameters for the DatabasePrincipalAssignmentsClient.NewListPager method.

type DatabasePrincipalAssignmentsClientListResponse 

type DatabasePrincipalAssignmentsClientListResponse struct {
	// The list Kusto database principal assignments operation response.
	DatabasePrincipalAssignmentListResult
}

DatabasePrincipalAssignmentsClientListResponse contains the response from method DatabasePrincipalAssignmentsClient.NewListPager.

type DatabasePrincipalListRequest 

type DatabasePrincipalListRequest struct {
	// The list of Kusto database principals.
	Value []*DatabasePrincipal
}

DatabasePrincipalListRequest - The list Kusto database principals operation request.

func (DatabasePrincipalListRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DatabasePrincipalListRequest.

func (*DatabasePrincipalListRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabasePrincipalListRequest.

type DatabasePrincipalListResult 

type DatabasePrincipalListResult struct {
	// The list of Kusto database principals.
	Value []*DatabasePrincipal
}

DatabasePrincipalListResult - The list Kusto database principals operation response.

func (DatabasePrincipalListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DatabasePrincipalListResult.

func (*DatabasePrincipalListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabasePrincipalListResult.

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 *ProvisioningState

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

DatabasePrincipalProperties - A class representing database principal property.

func (DatabasePrincipalProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DatabasePrincipalProperties.

func (*DatabasePrincipalProperties) UnmarshalJSON 

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 DatabasePrincipalType 

type DatabasePrincipalType string

DatabasePrincipalType - Database principal type. 

const (
	DatabasePrincipalTypeApp   DatabasePrincipalType = "App"
	DatabasePrincipalTypeGroup DatabasePrincipalType = "Group"
	DatabasePrincipalTypeUser  DatabasePrincipalType = "User"
)

func PossibleDatabasePrincipalTypeValues 

func PossibleDatabasePrincipalTypeValues() []DatabasePrincipalType

PossibleDatabasePrincipalTypeValues returns the possible values for the DatabasePrincipalType const type.

type DatabaseRouting 

type DatabaseRouting string

DatabaseRouting - Indication for database routing information from the data connection, by default only database routing information is allowed 

const (
	DatabaseRoutingMulti  DatabaseRouting = "Multi"
	DatabaseRoutingSingle DatabaseRouting = "Single"
)

func PossibleDatabaseRoutingValues 

func PossibleDatabaseRoutingValues() []DatabaseRouting

PossibleDatabaseRoutingValues returns the possible values for the DatabaseRouting const type.

type DatabaseShareOrigin 

type DatabaseShareOrigin string

DatabaseShareOrigin - The origin of the following setup. 

const (
	DatabaseShareOriginDataShare DatabaseShareOrigin = "DataShare"
	DatabaseShareOriginDirect    DatabaseShareOrigin = "Direct"
	DatabaseShareOriginOther     DatabaseShareOrigin = "Other"
)

func PossibleDatabaseShareOriginValues 

func PossibleDatabaseShareOriginValues() []DatabaseShareOrigin

PossibleDatabaseShareOriginValues returns the possible values for the DatabaseShareOrigin 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 

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

MarshalJSON implements the json.Marshaller interface for type DatabaseStatistics.

func (*DatabaseStatistics) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabaseStatistics.

type DatabasesClient 

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

DatabasesClient contains the methods for the Databases group. Don't use this type directly, use NewDatabasesClient() instead.

func NewDatabasesClient 

func NewDatabasesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DatabasesClient, error)

NewDatabasesClient creates a new instance of DatabasesClient 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 (*DatabasesClient) AddPrincipals 

func (client *DatabasesClient) AddPrincipals(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, databasePrincipalsToAdd DatabasePrincipalListRequest, options *DatabasesClientAddPrincipalsOptions) (DatabasesClientAddPrincipalsResponse, error)

AddPrincipals - Add Database principals permissions. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • databasePrincipalsToAdd - List of database principals to add.
  • options - DatabasesClientAddPrincipalsOptions contains the optional parameters for the DatabasesClient.AddPrincipals method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabaseAddPrincipals.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatabasesClient().AddPrincipals(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", armkusto.DatabasePrincipalListRequest{
	Value: []*armkusto.DatabasePrincipal{
		{
			Name:  to.Ptr("Some User"),
			Type:  to.Ptr(armkusto.DatabasePrincipalTypeUser),
			AppID: to.Ptr(""),
			Email: to.Ptr("user@microsoft.com"),
			Fqn:   to.Ptr("aaduser=some_guid"),
			Role:  to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
		},
		{
			Name:  to.Ptr("Kusto"),
			Type:  to.Ptr(armkusto.DatabasePrincipalTypeGroup),
			AppID: to.Ptr(""),
			Email: to.Ptr("kusto@microsoft.com"),
			Fqn:   to.Ptr("aadgroup=some_guid"),
			Role:  to.Ptr(armkusto.DatabasePrincipalRoleViewer),
		},
		{
			Name:  to.Ptr("SomeApp"),
			Type:  to.Ptr(armkusto.DatabasePrincipalTypeApp),
			AppID: to.Ptr("some_guid_app_id"),
			Email: to.Ptr(""),
			Fqn:   to.Ptr("aadapp=some_guid_app_id"),
			Role:  to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
		}},
}, 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.DatabasePrincipalListResult = armkusto.DatabasePrincipalListResult{
// 	Value: []*armkusto.DatabasePrincipal{
// 		{
// 			Name: to.Ptr("Some User"),
// 			Type: to.Ptr(armkusto.DatabasePrincipalTypeUser),
// 			AppID: to.Ptr(""),
// 			Email: to.Ptr("user@microsoft.com"),
// 			Fqn: to.Ptr("aaduser=some_guid"),
// 			Role: to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
// 		},
// 		{
// 			Name: to.Ptr("Kusto"),
// 			Type: to.Ptr(armkusto.DatabasePrincipalTypeGroup),
// 			AppID: to.Ptr(""),
// 			Email: to.Ptr("kusto@microsoft.com"),
// 			Fqn: to.Ptr("aadgroup=some_guid"),
// 			Role: to.Ptr(armkusto.DatabasePrincipalRoleViewer),
// 		},
// 		{
// 			Name: to.Ptr("SomeApp"),
// 			Type: to.Ptr(armkusto.DatabasePrincipalTypeApp),
// 			AppID: to.Ptr("some_guid_app_id"),
// 			Email: to.Ptr(""),
// 			Fqn: to.Ptr("aadapp=some_guid_app_id"),
// 			Role: to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
// 	}},
// }

Output:

func (*DatabasesClient) BeginCreateOrUpdate 

func (client *DatabasesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters DatabaseClassification, options *DatabasesClientBeginCreateOrUpdateOptions) (*runtime.Poller[DatabasesClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • parameters - The database parameters supplied to the CreateOrUpdate operation.
  • options - DatabasesClientBeginCreateOrUpdateOptions contains the optional parameters for the DatabasesClient.BeginCreateOrUpdate method.
Example (KustoReadOnlyDatabaseUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabaseReadonlyUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDatabasesClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "kustoReadOnlyDatabase", &armkusto.ReadOnlyFollowingDatabase{
	Kind:     to.Ptr(armkusto.KindReadOnlyFollowing),
	Location: to.Ptr("westus"),
	Properties: &armkusto.ReadOnlyFollowingDatabaseProperties{
		HotCachePeriod: to.Ptr("P1D"),
	},
}, &armkusto.DatabasesClientBeginCreateOrUpdateOptions{CallerRole: 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 = armkusto.DatabasesClientCreateOrUpdateResponse{
// 	                            DatabaseClassification: &armkusto.ReadOnlyFollowingDatabase{
// 		Name: to.Ptr("kustoCluster/kustoReadOnlyDatabase"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/kustoReadOnlyDatabase"),
// 		Kind: to.Ptr(armkusto.KindReadOnlyFollowing),
// 		Location: to.Ptr("westus"),
// 	},
// 	                        }

Output:
Example (KustoReadWriteDatabaseCreateOrUpdate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabasesCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDatabasesClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", &armkusto.ReadWriteDatabase{
	Kind:     to.Ptr(armkusto.KindReadWrite),
	Location: to.Ptr("westus"),
	Properties: &armkusto.ReadWriteDatabaseProperties{
		SoftDeletePeriod: to.Ptr("P1D"),
	},
}, &armkusto.DatabasesClientBeginCreateOrUpdateOptions{CallerRole: to.Ptr(armkusto.CallerRoleAdmin)})
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 = armkusto.DatabasesClientCreateOrUpdateResponse{
// 	                            DatabaseClassification: &armkusto.ReadWriteDatabase{
// 		Name: to.Ptr("kustoCluster/KustoDatabase8"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8"),
// 		Kind: to.Ptr(armkusto.KindReadWrite),
// 		Location: to.Ptr("westus"),
// 	},
// 	                        }

Output:

func (*DatabasesClient) BeginDelete 

func (client *DatabasesClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, options *DatabasesClientBeginDeleteOptions) (*runtime.Poller[DatabasesClientDeleteResponse], error)

BeginDelete - Deletes the database with the given name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • options - DatabasesClientBeginDeleteOptions contains the optional parameters for the DatabasesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabasesDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDatabasesClient().BeginDelete(ctx, "kustorptest", "kustoCluster", "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 (*DatabasesClient) BeginUpdate 

func (client *DatabasesClient) BeginUpdate(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters DatabaseClassification, options *DatabasesClientBeginUpdateOptions) (*runtime.Poller[DatabasesClientUpdateResponse], error)

BeginUpdate - Updates a database. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • parameters - The database parameters supplied to the Update operation.
  • options - DatabasesClientBeginUpdateOptions contains the optional parameters for the DatabasesClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabasesUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDatabasesClient().BeginUpdate(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", &armkusto.ReadWriteDatabase{
	Kind: to.Ptr(armkusto.KindReadWrite),
	Properties: &armkusto.ReadWriteDatabaseProperties{
		HotCachePeriod: to.Ptr("P1D"),
	},
}, &armkusto.DatabasesClientBeginUpdateOptions{CallerRole: 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 = armkusto.DatabasesClientUpdateResponse{
// 	                            DatabaseClassification: &armkusto.ReadWriteDatabase{
// 		Name: to.Ptr("kustoCluster/KustoDatabase8"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8"),
// 		Kind: to.Ptr(armkusto.KindReadWrite),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.ReadWriteDatabaseProperties{
// 			HotCachePeriod: to.Ptr("P1D"),
// 			ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 		},
// 	},
// 	                        }

Output:

func (*DatabasesClient) CheckNameAvailability 

func (client *DatabasesClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, clusterName string, resourceName CheckNameRequest, options *DatabasesClientCheckNameAvailabilityOptions) (DatabasesClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the databases resource name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • resourceName - The name of the resource.
  • options - DatabasesClientCheckNameAvailabilityOptions contains the optional parameters for the DatabasesClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabasesCheckNameAvailability.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatabasesClient().CheckNameAvailability(ctx, "kustorptest", "kustoCluster", armkusto.CheckNameRequest{
	Name: to.Ptr("database1"),
	Type: to.Ptr(armkusto.TypeMicrosoftKustoClustersDatabases),
}, 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 = armkusto.CheckNameResult{
// 	Name: to.Ptr("database1"),
// 	Message: to.Ptr("Name 'database1' is already taken. Please specify a different name"),
// 	NameAvailable: to.Ptr(false),
// }

Output:

func (*DatabasesClient) Get 

func (client *DatabasesClient) Get(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, options *DatabasesClientGetOptions) (DatabasesClientGetResponse, error)

Get - Returns a database. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • options - DatabasesClientGetOptions contains the optional parameters for the DatabasesClient.Get method.
Example (KustoDatabasesGet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabasesGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatabasesClient().Get(ctx, "kustorptest", "kustoCluster", "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 = armkusto.DatabasesClientGetResponse{
// 	                            DatabaseClassification: &armkusto.ReadWriteDatabase{
// 		Name: to.Ptr("kustoCluster/KustoDatabase8"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8"),
// 		Kind: to.Ptr(armkusto.KindReadWrite),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.ReadWriteDatabaseProperties{
// 			ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 			SoftDeletePeriod: to.Ptr("P1D"),
// 		},
// 	},
// 	                        }

Output:
Example (KustoSuspendedDatabasesGet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoSuspendedDatabasesGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatabasesClient().Get(ctx, "kustorptest", "kustoCluster", "KustoDatabase9", 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 = armkusto.DatabasesClientGetResponse{
// 	                            DatabaseClassification: &armkusto.ReadWriteDatabase{
// 		Name: to.Ptr("kustoCluster/KustoDatabase9"),
// 		Type: to.Ptr("Microsoft.Kusto/Clusters/Databases"),
// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase9"),
// 		Kind: to.Ptr(armkusto.KindReadWrite),
// 		Location: to.Ptr("westus"),
// 		Properties: &armkusto.ReadWriteDatabaseProperties{
// 			ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 			SoftDeletePeriod: to.Ptr("P1D"),
// 			SuspensionDetails: &armkusto.SuspensionDetails{
// 				SuspensionStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-04-16T15:06:54.275Z"); return t}()),
// 			},
// 		},
// 	},
// 	                        }

Output:

func (*DatabasesClient) NewListByClusterPager 

func (client *DatabasesClient) NewListByClusterPager(resourceGroupName string, clusterName string, options *DatabasesClientListByClusterOptions) *runtime.Pager[DatabasesClientListByClusterResponse]

NewListByClusterPager - Returns the list of databases of the given Kusto cluster.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - DatabasesClientListByClusterOptions contains the optional parameters for the DatabasesClient.NewListByClusterPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabasesListByCluster.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDatabasesClient().NewListByClusterPager("kustorptest", "kustoCluster", &armkusto.DatabasesClientListByClusterOptions{Top: nil,
	Skiptoken: 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 = armkusto.DatabaseListResult{
	// 	Value: []armkusto.DatabaseClassification{
	// 		&armkusto.ReadWriteDatabase{
	// 			Name: to.Ptr("kustoCluster/KustoDatabase8"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8"),
	// 			Kind: to.Ptr(armkusto.KindReadWrite),
	// 			Location: to.Ptr("westus"),
	// 			Properties: &armkusto.ReadWriteDatabaseProperties{
	// 				HotCachePeriod: to.Ptr("P1D"),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				SoftDeletePeriod: to.Ptr("P1D"),
	// 			},
	// 		},
	// 		&armkusto.ReadOnlyFollowingDatabase{
	// 			Name: to.Ptr("kustoCluster/KustoDatabase9"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase9"),
	// 			Kind: to.Ptr(armkusto.KindReadOnlyFollowing),
	// 			Location: to.Ptr("westus"),
	// 			Properties: &armkusto.ReadOnlyFollowingDatabaseProperties{
	// 				AttachedDatabaseConfigurationName: to.Ptr("attachedDatabaseConfigurationsTest"),
	// 				DatabaseShareOrigin: to.Ptr(armkusto.DatabaseShareOriginDirect),
	// 				HotCachePeriod: to.Ptr("P1D"),
	// 				LeaderClusterResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster2"),
	// 				OriginalDatabaseName: to.Ptr("KustoDatabase9"),
	// 				PrincipalsModificationKind: to.Ptr(armkusto.PrincipalsModificationKindUnion),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				SoftDeletePeriod: to.Ptr("P1D"),
	// 				Statistics: &armkusto.DatabaseStatistics{
	// 					Size: to.Ptr[float32](1024),
	// 				},
	// 				TableLevelSharingProperties: &armkusto.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")},
	// 										},
	// 									},
	// 								},
	// 								&armkusto.ReadWriteDatabase{
	// 									Name: to.Ptr("kustoCluster/KustoDatabase10"),
	// 									Type: to.Ptr("Microsoft.Kusto/Clusters/Databases"),
	// 									ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase10"),
	// 									Kind: to.Ptr(armkusto.KindReadWrite),
	// 									Location: to.Ptr("westus"),
	// 									Properties: &armkusto.ReadWriteDatabaseProperties{
	// 										HotCachePeriod: to.Ptr("P1D"),
	// 										ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 										SoftDeletePeriod: to.Ptr("P1D"),
	// 										SuspensionDetails: &armkusto.SuspensionDetails{
	// 											SuspensionStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-04-16T15:06:54.275Z"); return t}()),
	// 										},
	// 									},
	// 							}},
	// 						}
}

Output:

func (*DatabasesClient) NewListPrincipalsPager 

func (client *DatabasesClient) NewListPrincipalsPager(resourceGroupName string, clusterName string, databaseName string, options *DatabasesClientListPrincipalsOptions) *runtime.Pager[DatabasesClientListPrincipalsResponse]

NewListPrincipalsPager - Returns a list of database principals of the given Kusto cluster and database.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • options - DatabasesClientListPrincipalsOptions contains the optional parameters for the DatabasesClient.NewListPrincipalsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabaseListPrincipals.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDatabasesClient().NewListPrincipalsPager("kustorptest", "kustoCluster", "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.DatabasePrincipalListResult = armkusto.DatabasePrincipalListResult{
	// 	Value: []*armkusto.DatabasePrincipal{
	// 		{
	// 			Name: to.Ptr("Some User"),
	// 			Type: to.Ptr(armkusto.DatabasePrincipalTypeUser),
	// 			AppID: to.Ptr(""),
	// 			Email: to.Ptr("user@microsoft.com"),
	// 			Fqn: to.Ptr("aaduser=some_guid"),
	// 			Role: to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
	// 		},
	// 		{
	// 			Name: to.Ptr("Kusto"),
	// 			Type: to.Ptr(armkusto.DatabasePrincipalTypeGroup),
	// 			AppID: to.Ptr(""),
	// 			Email: to.Ptr("kusto@microsoft.com"),
	// 			Fqn: to.Ptr("aadgroup=some_guid"),
	// 			Role: to.Ptr(armkusto.DatabasePrincipalRoleViewer),
	// 		},
	// 		{
	// 			Name: to.Ptr("SomeApp"),
	// 			Type: to.Ptr(armkusto.DatabasePrincipalTypeApp),
	// 			AppID: to.Ptr("some_guid_app_id"),
	// 			Email: to.Ptr(""),
	// 			Fqn: to.Ptr("aadapp=some_guid_app_id"),
	// 			Role: to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
	// 	}},
	// }
}

Output:

func (*DatabasesClient) RemovePrincipals 

func (client *DatabasesClient) RemovePrincipals(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, databasePrincipalsToRemove DatabasePrincipalListRequest, options *DatabasesClientRemovePrincipalsOptions) (DatabasesClientRemovePrincipalsResponse, error)

RemovePrincipals - Remove Database principals permissions. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • databasePrincipalsToRemove - List of database principals to remove.
  • options - DatabasesClientRemovePrincipalsOptions contains the optional parameters for the DatabasesClient.RemovePrincipals method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoDatabaseRemovePrincipals.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatabasesClient().RemovePrincipals(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", armkusto.DatabasePrincipalListRequest{
	Value: []*armkusto.DatabasePrincipal{
		{
			Name:  to.Ptr("Some User"),
			Type:  to.Ptr(armkusto.DatabasePrincipalTypeUser),
			AppID: to.Ptr(""),
			Email: to.Ptr("user@microsoft.com"),
			Fqn:   to.Ptr("aaduser=some_guid"),
			Role:  to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
		},
		{
			Name:  to.Ptr("Kusto"),
			Type:  to.Ptr(armkusto.DatabasePrincipalTypeGroup),
			AppID: to.Ptr(""),
			Email: to.Ptr("kusto@microsoft.com"),
			Fqn:   to.Ptr("aadgroup=some_guid"),
			Role:  to.Ptr(armkusto.DatabasePrincipalRoleViewer),
		},
		{
			Name:  to.Ptr("SomeApp"),
			Type:  to.Ptr(armkusto.DatabasePrincipalTypeApp),
			AppID: to.Ptr("some_guid_app_id"),
			Email: to.Ptr(""),
			Fqn:   to.Ptr("aadapp=some_guid_app_id"),
			Role:  to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
		}},
}, 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.DatabasePrincipalListResult = armkusto.DatabasePrincipalListResult{
// 	Value: []*armkusto.DatabasePrincipal{
// 		{
// 			Name: to.Ptr("Some User"),
// 			Type: to.Ptr(armkusto.DatabasePrincipalTypeUser),
// 			AppID: to.Ptr(""),
// 			Email: to.Ptr("user@microsoft.com"),
// 			Fqn: to.Ptr("aaduser=some_guid"),
// 			Role: to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
// 		},
// 		{
// 			Name: to.Ptr("Kusto"),
// 			Type: to.Ptr(armkusto.DatabasePrincipalTypeGroup),
// 			AppID: to.Ptr(""),
// 			Email: to.Ptr("kusto@microsoft.com"),
// 			Fqn: to.Ptr("aadgroup=some_guid"),
// 			Role: to.Ptr(armkusto.DatabasePrincipalRoleViewer),
// 		},
// 		{
// 			Name: to.Ptr("SomeApp"),
// 			Type: to.Ptr(armkusto.DatabasePrincipalTypeApp),
// 			AppID: to.Ptr("some_guid_app_id"),
// 			Email: to.Ptr(""),
// 			Fqn: to.Ptr("aadapp=some_guid_app_id"),
// 			Role: to.Ptr(armkusto.DatabasePrincipalRoleAdmin),
// 	}},
// }

Output:

type DatabasesClientAddPrincipalsOptions 

type DatabasesClientAddPrincipalsOptions struct {
}

DatabasesClientAddPrincipalsOptions contains the optional parameters for the DatabasesClient.AddPrincipals method.

type DatabasesClientAddPrincipalsResponse 

type DatabasesClientAddPrincipalsResponse struct {
	// The list Kusto database principals operation response.
	DatabasePrincipalListResult
}

DatabasesClientAddPrincipalsResponse contains the response from method DatabasesClient.AddPrincipals.

type DatabasesClientBeginCreateOrUpdateOptions 

type DatabasesClientBeginCreateOrUpdateOptions struct {
	// By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude
	// the caller from Admins list.
	CallerRole *CallerRole

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

DatabasesClientBeginCreateOrUpdateOptions contains the optional parameters for the DatabasesClient.BeginCreateOrUpdate method.

type DatabasesClientBeginDeleteOptions 

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

DatabasesClientBeginDeleteOptions contains the optional parameters for the DatabasesClient.BeginDelete method.

type DatabasesClientBeginUpdateOptions 

type DatabasesClientBeginUpdateOptions struct {
	// By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude
	// the caller from Admins list.
	CallerRole *CallerRole

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

DatabasesClientBeginUpdateOptions contains the optional parameters for the DatabasesClient.BeginUpdate method.

type DatabasesClientCheckNameAvailabilityOptions 

type DatabasesClientCheckNameAvailabilityOptions struct {
}

DatabasesClientCheckNameAvailabilityOptions contains the optional parameters for the DatabasesClient.CheckNameAvailability method.

type DatabasesClientCheckNameAvailabilityResponse 

type DatabasesClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

DatabasesClientCheckNameAvailabilityResponse contains the response from method DatabasesClient.CheckNameAvailability.

type DatabasesClientCreateOrUpdateResponse 

type DatabasesClientCreateOrUpdateResponse struct {
	// Class representing a Kusto database.
	DatabaseClassification
}

DatabasesClientCreateOrUpdateResponse contains the response from method DatabasesClient.BeginCreateOrUpdate.

func (DatabasesClientCreateOrUpdateResponse) MarshalJSON added in v2.2.0 

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

MarshalJSON implements the json.Marshaller interface for type DatabasesClientCreateOrUpdateResponse.

func (*DatabasesClientCreateOrUpdateResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabasesClientCreateOrUpdateResponse.

type DatabasesClientDeleteResponse 

type DatabasesClientDeleteResponse struct {
}

DatabasesClientDeleteResponse contains the response from method DatabasesClient.BeginDelete.

type DatabasesClientGetOptions 

type DatabasesClientGetOptions struct {
}

DatabasesClientGetOptions contains the optional parameters for the DatabasesClient.Get method.

type DatabasesClientGetResponse 

type DatabasesClientGetResponse struct {
	// Class representing a Kusto database.
	DatabaseClassification
}

DatabasesClientGetResponse contains the response from method DatabasesClient.Get.

func (*DatabasesClientGetResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabasesClientGetResponse.

type DatabasesClientListByClusterOptions 

type DatabasesClientListByClusterOptions struct {
	// Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skiptoken parameter that
	// specifies a starting point to use for subsequent calls.
	Skiptoken *string

	// limit the number of results
	Top *int32
}

DatabasesClientListByClusterOptions contains the optional parameters for the DatabasesClient.NewListByClusterPager method.

type DatabasesClientListByClusterResponse 

type DatabasesClientListByClusterResponse struct {
	// The list Kusto databases operation response.
	DatabaseListResult
}

DatabasesClientListByClusterResponse contains the response from method DatabasesClient.NewListByClusterPager.

type DatabasesClientListPrincipalsOptions 

type DatabasesClientListPrincipalsOptions struct {
}

DatabasesClientListPrincipalsOptions contains the optional parameters for the DatabasesClient.NewListPrincipalsPager method.

type DatabasesClientListPrincipalsResponse 

type DatabasesClientListPrincipalsResponse struct {
	// The list Kusto database principals operation response.
	DatabasePrincipalListResult
}

DatabasesClientListPrincipalsResponse contains the response from method DatabasesClient.NewListPrincipalsPager.

type DatabasesClientRemovePrincipalsOptions 

type DatabasesClientRemovePrincipalsOptions struct {
}

DatabasesClientRemovePrincipalsOptions contains the optional parameters for the DatabasesClient.RemovePrincipals method.

type DatabasesClientRemovePrincipalsResponse 

type DatabasesClientRemovePrincipalsResponse struct {
	// The list Kusto database principals operation response.
	DatabasePrincipalListResult
}

DatabasesClientRemovePrincipalsResponse contains the response from method DatabasesClient.RemovePrincipals.

type DatabasesClientUpdateResponse 

type DatabasesClientUpdateResponse struct {
	// Class representing a Kusto database.
	DatabaseClassification
}

DatabasesClientUpdateResponse contains the response from method DatabasesClient.BeginUpdate.

func (DatabasesClientUpdateResponse) MarshalJSON added in v2.2.0 

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

MarshalJSON implements the json.Marshaller interface for type DatabasesClientUpdateResponse.

func (*DatabasesClientUpdateResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabasesClientUpdateResponse.

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 DiagnoseVirtualNetworkResult 

type DiagnoseVirtualNetworkResult struct {
	// The list of network connectivity diagnostic finding
	Findings []*string
}

func (DiagnoseVirtualNetworkResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DiagnoseVirtualNetworkResult.

func (*DiagnoseVirtualNetworkResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnoseVirtualNetworkResult.

type EndpointDependency 

type EndpointDependency struct {
	// The domain name of the dependency.
	DomainName *string

	// The ports used when connecting to DomainName.
	EndpointDetails []*EndpointDetail
}

EndpointDependency - A domain name that a service is reached at, including details of the current connection status.

func (EndpointDependency) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EndpointDependency.

func (*EndpointDependency) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointDependency.

type EndpointDetail 

type EndpointDetail struct {
	// The ip address of the endpoint.
	IPAddress *string

	// The port an endpoint is connected to.
	Port *int32
}

EndpointDetail - Current TCP connectivity information from the Kusto cluster to a single endpoint.

func (EndpointDetail) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EndpointDetail.

func (*EndpointDetail) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointDetail.

type EngineType 

type EngineType string

EngineType - The engine type 

const (
	EngineTypeV2 EngineType = "V2"
	EngineTypeV3 EngineType = "V3"
)

func PossibleEngineTypeValues 

func PossibleEngineTypeValues() []EngineType

PossibleEngineTypeValues returns the possible values for the EngineType const type.

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

	// Indication for database routing information from the data connection, by default only database routing information is allowed
	DatabaseRouting *DatabaseRouting

	// The resource ID of the event grid that is subscribed to the storage account events.
	EventGridResourceID *string

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

	// The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub and storage account.
	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 object ID of managedIdentityResourceId
	ManagedIdentityObjectID *string

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

EventGridConnectionProperties - Class representing the Kusto event grid connection properties.

func (EventGridConnectionProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EventGridConnectionProperties.

func (*EventGridConnectionProperties) UnmarshalJSON 

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; 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 

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

	// Indication for database routing information from the data connection, by default only database routing information is allowed
	DatabaseRouting *DatabaseRouting

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

	// When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only
	// retrieve events retained by the Event hub, based on its retention period.
	RetrievalStartDate *time.Time

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

	// READ-ONLY; The object ID of the managedIdentityResourceId
	ManagedIdentityObjectID *string

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

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 

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; 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 

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 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.
	ClusterResourceID *string

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

	// READ-ONLY; The origin of the following setup.
	DatabaseShareOrigin *DatabaseShareOrigin

	// READ-ONLY; Table level sharing specifications
	TableLevelSharingProperties *TableLevelSharingProperties
}

FollowerDatabaseDefinition - A class representing follower database request.

func (FollowerDatabaseDefinition) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type FollowerDatabaseDefinition.

func (*FollowerDatabaseDefinition) UnmarshalJSON 

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type FollowerDatabaseListResult.

type Identity 

type Identity struct {
	// REQUIRED; The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created
	// identity and a set of user-assigned identities. The type 'None' will remove all
	// identities.
	Type *IdentityType

	// The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM
	// resource ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	UserAssignedIdentities map[string]*ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties

	// READ-ONLY; The principal ID of resource identity.
	PrincipalID *string

	// READ-ONLY; The tenant ID of resource.
	TenantID *string
}

Identity for the resource.

func (Identity) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Identity.

func (*Identity) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Identity.

type IdentityType 

type IdentityType string

IdentityType - The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove all identities. 

const (
	IdentityTypeNone                       IdentityType = "None"
	IdentityTypeSystemAssigned             IdentityType = "SystemAssigned"
	IdentityTypeSystemAssignedUserAssigned IdentityType = "SystemAssigned, UserAssigned"
	IdentityTypeUserAssigned               IdentityType = "UserAssigned"
)

func PossibleIdentityTypeValues 

func PossibleIdentityTypeValues() []IdentityType

PossibleIdentityTypeValues returns the possible values for the IdentityType const type.

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

	// Indication for database routing information from the data connection, by default only database routing information is allowed
	DatabaseRouting *DatabaseRouting

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

	// When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only
	// retrieve events retained by the Event hub, based on its retention period.
	RetrievalStartDate *time.Time

	// 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 *ProvisioningState
}

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 

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; 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 

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 KeyVaultProperties 

type KeyVaultProperties struct {
	// The name of the key vault key.
	KeyName *string

	// The Uri of the key vault.
	KeyVaultURI *string

	// The version of the key vault key.
	KeyVersion *string

	// The user assigned identity (ARM resource id) that has access to the key.
	UserIdentity *string
}

KeyVaultProperties - Properties of the key vault.

func (KeyVaultProperties) MarshalJSON 

func (k KeyVaultProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyVaultProperties.

func (*KeyVaultProperties) UnmarshalJSON 

func (k *KeyVaultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyVaultProperties.

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 Language added in v2.1.0 

type Language string

Language - The language name, for example Python. 

const (
	LanguagePython Language = "Python"
)

func PossibleLanguageValues added in v2.1.0 

func PossibleLanguageValues() []Language

PossibleLanguageValues returns the possible values for the Language const type.

type LanguageExtension 

type LanguageExtension struct {
	// The language extension custom image name.
	LanguageExtensionCustomImageName *string

	// The language extension image name.
	LanguageExtensionImageName *LanguageExtensionImageName

	// The language extension name.
	LanguageExtensionName *LanguageExtensionName
}

LanguageExtension - The language extension object.

func (LanguageExtension) MarshalJSON 

func (l LanguageExtension) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LanguageExtension.

func (*LanguageExtension) UnmarshalJSON 

func (l *LanguageExtension) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LanguageExtension.

type LanguageExtensionImageName 

type LanguageExtensionImageName string

LanguageExtensionImageName - Language extension image name. 

const (
	LanguageExtensionImageNamePython3108        LanguageExtensionImageName = "Python3_10_8"
	LanguageExtensionImageNamePython3108DL      LanguageExtensionImageName = "Python3_10_8_DL"
	LanguageExtensionImageNamePython365         LanguageExtensionImageName = "Python3_6_5"
	LanguageExtensionImageNamePythonCustomImage LanguageExtensionImageName = "PythonCustomImage"
	LanguageExtensionImageNameR                 LanguageExtensionImageName = "R"
)

func PossibleLanguageExtensionImageNameValues 

func PossibleLanguageExtensionImageNameValues() []LanguageExtensionImageName

PossibleLanguageExtensionImageNameValues returns the possible values for the LanguageExtensionImageName const type.

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 

func (l *LanguageExtensionsList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LanguageExtensionsList.

type ListResourceSKUsResult 

type ListResourceSKUsResult struct {
	// The collection of available SKUs for an existing resource.
	Value []*AzureResourceSKU
}

ListResourceSKUsResult - List of available SKUs for a Kusto Cluster.

func (ListResourceSKUsResult) MarshalJSON 

func (l ListResourceSKUsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListResourceSKUsResult.

func (*ListResourceSKUsResult) UnmarshalJSON 

func (l *ListResourceSKUsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListResourceSKUsResult.

type ManagedPrivateEndpoint 

type ManagedPrivateEndpoint struct {
	// A managed private endpoint.
	Properties *ManagedPrivateEndpointProperties

	// 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; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

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

ManagedPrivateEndpoint - Class representing a managed private endpoint.

func (ManagedPrivateEndpoint) MarshalJSON 

func (m ManagedPrivateEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedPrivateEndpoint.

func (*ManagedPrivateEndpoint) UnmarshalJSON 

func (m *ManagedPrivateEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedPrivateEndpoint.

type ManagedPrivateEndpointListResult 

type ManagedPrivateEndpointListResult struct {
	// The list of managed private endpoints.
	Value []*ManagedPrivateEndpoint
}

ManagedPrivateEndpointListResult - The list managed private endpoints operation response.

func (ManagedPrivateEndpointListResult) MarshalJSON 

func (m ManagedPrivateEndpointListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedPrivateEndpointListResult.

func (*ManagedPrivateEndpointListResult) UnmarshalJSON 

func (m *ManagedPrivateEndpointListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedPrivateEndpointListResult.

type ManagedPrivateEndpointProperties 

type ManagedPrivateEndpointProperties struct {
	// REQUIRED; The groupId in which the managed private endpoint is created.
	GroupID *string

	// REQUIRED; The ARM resource ID of the resource for which the managed private endpoint is created.
	PrivateLinkResourceID *string

	// The region of the resource to which the managed private endpoint is created.
	PrivateLinkResourceRegion *string

	// The user request message.
	RequestMessage *string

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

ManagedPrivateEndpointProperties - A class representing the properties of a managed private endpoint object.

func (ManagedPrivateEndpointProperties) MarshalJSON 

func (m ManagedPrivateEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedPrivateEndpointProperties.

func (*ManagedPrivateEndpointProperties) UnmarshalJSON 

func (m *ManagedPrivateEndpointProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedPrivateEndpointProperties.

type ManagedPrivateEndpointsCheckNameRequest 

type ManagedPrivateEndpointsCheckNameRequest struct {
	// REQUIRED; Managed private endpoint resource name.
	Name *string

	// CONSTANT; The type of resource, for instance Microsoft.Kusto/clusters/managedPrivateEndpoints.
	// Field has constant value "Microsoft.Kusto/clusters/managedPrivateEndpoints", any specified value is ignored.
	Type *string
}

ManagedPrivateEndpointsCheckNameRequest - The result returned from a managedPrivateEndpoints check name availability request.

func (ManagedPrivateEndpointsCheckNameRequest) MarshalJSON 

func (m ManagedPrivateEndpointsCheckNameRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedPrivateEndpointsCheckNameRequest.

func (*ManagedPrivateEndpointsCheckNameRequest) UnmarshalJSON 

func (m *ManagedPrivateEndpointsCheckNameRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedPrivateEndpointsCheckNameRequest.

type ManagedPrivateEndpointsClient 

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

ManagedPrivateEndpointsClient contains the methods for the ManagedPrivateEndpoints group. Don't use this type directly, use NewManagedPrivateEndpointsClient() instead.

func NewManagedPrivateEndpointsClient 

func NewManagedPrivateEndpointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagedPrivateEndpointsClient, error)

NewManagedPrivateEndpointsClient creates a new instance of ManagedPrivateEndpointsClient 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 (*ManagedPrivateEndpointsClient) BeginCreateOrUpdate 

func (client *ManagedPrivateEndpointsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, managedPrivateEndpointName string, parameters ManagedPrivateEndpoint, options *ManagedPrivateEndpointsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ManagedPrivateEndpointsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a managed private endpoint. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • managedPrivateEndpointName - The name of the managed private endpoint.
  • parameters - The managed private endpoint parameters.
  • options - ManagedPrivateEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the ManagedPrivateEndpointsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoManagedPrivateEndpointsCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewManagedPrivateEndpointsClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "managedPrivateEndpointTest", armkusto.ManagedPrivateEndpoint{
	Properties: &armkusto.ManagedPrivateEndpointProperties{
		GroupID:               to.Ptr("blob"),
		PrivateLinkResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/storageAccountTest"),
		RequestMessage:        to.Ptr("Please Approve."),
	},
}, 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.ManagedPrivateEndpoint = armkusto.ManagedPrivateEndpoint{
// 	Name: to.Ptr("kustoCluster/KustoDatabase8/managedPrivateEndpointTest"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/ManagedPrivateEndpoints"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/ManagedPrivateEndpoints/managedPrivateEndpointTest"),
// 	Properties: &armkusto.ManagedPrivateEndpointProperties{
// 		GroupID: to.Ptr("blob"),
// 		PrivateLinkResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/storageAccountTest"),
// 		RequestMessage: to.Ptr("Please Approve."),
// 	},
// }

Output:

func (*ManagedPrivateEndpointsClient) BeginDelete 

func (client *ManagedPrivateEndpointsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, managedPrivateEndpointName string, options *ManagedPrivateEndpointsClientBeginDeleteOptions) (*runtime.Poller[ManagedPrivateEndpointsClientDeleteResponse], error)

BeginDelete - Deletes a managed private endpoint. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • managedPrivateEndpointName - The name of the managed private endpoint.
  • options - ManagedPrivateEndpointsClientBeginDeleteOptions contains the optional parameters for the ManagedPrivateEndpointsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoManagedPrivateEndpointsDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewManagedPrivateEndpointsClient().BeginDelete(ctx, "kustorptest", "kustoCluster", "managedPrivateEndpointTest", 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 (*ManagedPrivateEndpointsClient) BeginUpdate 

func (client *ManagedPrivateEndpointsClient) BeginUpdate(ctx context.Context, resourceGroupName string, clusterName string, managedPrivateEndpointName string, parameters ManagedPrivateEndpoint, options *ManagedPrivateEndpointsClientBeginUpdateOptions) (*runtime.Poller[ManagedPrivateEndpointsClientUpdateResponse], error)

BeginUpdate - Updates a managed private endpoint. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • managedPrivateEndpointName - The name of the managed private endpoint.
  • parameters - The managed private endpoint parameters.
  • options - ManagedPrivateEndpointsClientBeginUpdateOptions contains the optional parameters for the ManagedPrivateEndpointsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoManagedPrivateEndpointsUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewManagedPrivateEndpointsClient().BeginUpdate(ctx, "kustorptest", "kustoCluster", "managedPrivateEndpointTest", armkusto.ManagedPrivateEndpoint{
	Properties: &armkusto.ManagedPrivateEndpointProperties{
		GroupID:               to.Ptr("blob"),
		PrivateLinkResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/storageAccountTest"),
		RequestMessage:        to.Ptr("Please Approve Managed Private Endpoint Request."),
	},
}, 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.ManagedPrivateEndpoint = armkusto.ManagedPrivateEndpoint{
// 	Name: to.Ptr("kustoCluster/KustoDatabase8/managedPrivateEndpointTest"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/ManagedPrivateEndpoints"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/ManagedPrivateEndpoints/managedPrivateEndpointTest"),
// 	Properties: &armkusto.ManagedPrivateEndpointProperties{
// 		GroupID: to.Ptr("blob"),
// 		PrivateLinkResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/storageAccountTest"),
// 		RequestMessage: to.Ptr("Please Approve Managed Private Endpoint Request."),
// 	},
// }

Output:

func (*ManagedPrivateEndpointsClient) CheckNameAvailability 

func (client *ManagedPrivateEndpointsClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, clusterName string, resourceName ManagedPrivateEndpointsCheckNameRequest, options *ManagedPrivateEndpointsClientCheckNameAvailabilityOptions) (ManagedPrivateEndpointsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the managed private endpoints resource name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • resourceName - The name of the resource.
  • options - ManagedPrivateEndpointsClientCheckNameAvailabilityOptions contains the optional parameters for the ManagedPrivateEndpointsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoManagedPrivateEndpointsCheckNameAvailability.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewManagedPrivateEndpointsClient().CheckNameAvailability(ctx, "kustorptest", "kustoCluster", armkusto.ManagedPrivateEndpointsCheckNameRequest{
	Name: to.Ptr("pme1"),
	Type: to.Ptr("Microsoft.Kusto/clusters/managedPrivateEndpoints"),
}, 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 = armkusto.CheckNameResult{
// 	Name: to.Ptr("pme1"),
// 	Message: to.Ptr("Name 'pme1' is already taken. Please specify a different name"),
// 	NameAvailable: to.Ptr(false),
// }

Output:

func (*ManagedPrivateEndpointsClient) Get 

func (client *ManagedPrivateEndpointsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, managedPrivateEndpointName string, options *ManagedPrivateEndpointsClientGetOptions) (ManagedPrivateEndpointsClientGetResponse, error)

Get - Gets a managed private endpoint. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • managedPrivateEndpointName - The name of the managed private endpoint.
  • options - ManagedPrivateEndpointsClientGetOptions contains the optional parameters for the ManagedPrivateEndpointsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoManagedPrivateEndpointsGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewManagedPrivateEndpointsClient().Get(ctx, "kustorptest", "kustoCluster", "managedPrivateEndpointTest", 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.ManagedPrivateEndpoint = armkusto.ManagedPrivateEndpoint{
// 	Name: to.Ptr("kustoCluster/KustoDatabase8/managedPrivateEndpointTest"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/ManagedPrivateEndpoints"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/ManagedPrivateEndpoints/managedPrivateEndpointTest"),
// 	Properties: &armkusto.ManagedPrivateEndpointProperties{
// 		GroupID: to.Ptr("blob"),
// 		PrivateLinkResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/storageAccountTest"),
// 		RequestMessage: to.Ptr("Please Approve."),
// 	},
// }

Output:

func (*ManagedPrivateEndpointsClient) NewListPager 

func (client *ManagedPrivateEndpointsClient) NewListPager(resourceGroupName string, clusterName string, options *ManagedPrivateEndpointsClientListOptions) *runtime.Pager[ManagedPrivateEndpointsClientListResponse]

NewListPager - Returns the list of managed private endpoints.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - ManagedPrivateEndpointsClientListOptions contains the optional parameters for the ManagedPrivateEndpointsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoManagedPrivateEndpointsList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewManagedPrivateEndpointsClient().NewListPager("kustorptest", "kustoCluster", 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.ManagedPrivateEndpointListResult = armkusto.ManagedPrivateEndpointListResult{
	// 	Value: []*armkusto.ManagedPrivateEndpoint{
	// 		{
	// 			Name: to.Ptr("kustoCluster/KustoDatabase8/kustomanagedPrivateEndpoint1"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/ManagedPrivateEndpoints"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/ManagedPrivateEndpoints/kustoManagedPrivateEndpoint1"),
	// 			Properties: &armkusto.ManagedPrivateEndpointProperties{
	// 				GroupID: to.Ptr("blob"),
	// 				PrivateLinkResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Storage/storageAccounts/storageAccountTest"),
	// 				RequestMessage: to.Ptr("Please Approve."),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("kustoCluster/KustoDatabase8/kustomanagedPrivateEndpoint2"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/ManagedPrivateEndpoints"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/ManagedPrivateEndpoints/kustoManagedPrivateEndpoint2"),
	// 			Properties: &armkusto.ManagedPrivateEndpointProperties{
	// 				GroupID: to.Ptr("namespace"),
	// 				PrivateLinkResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHubs/storageAccounts/eventHubTest"),
	// 				RequestMessage: to.Ptr("Please Approve."),
	// 			},
	// 	}},
	// }
}

Output:

type ManagedPrivateEndpointsClientBeginCreateOrUpdateOptions 

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

ManagedPrivateEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the ManagedPrivateEndpointsClient.BeginCreateOrUpdate method.

type ManagedPrivateEndpointsClientBeginDeleteOptions 

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

ManagedPrivateEndpointsClientBeginDeleteOptions contains the optional parameters for the ManagedPrivateEndpointsClient.BeginDelete method.

type ManagedPrivateEndpointsClientBeginUpdateOptions 

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

ManagedPrivateEndpointsClientBeginUpdateOptions contains the optional parameters for the ManagedPrivateEndpointsClient.BeginUpdate method.

type ManagedPrivateEndpointsClientCheckNameAvailabilityOptions 

type ManagedPrivateEndpointsClientCheckNameAvailabilityOptions struct {
}

ManagedPrivateEndpointsClientCheckNameAvailabilityOptions contains the optional parameters for the ManagedPrivateEndpointsClient.CheckNameAvailability method.

type ManagedPrivateEndpointsClientCheckNameAvailabilityResponse 

type ManagedPrivateEndpointsClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

ManagedPrivateEndpointsClientCheckNameAvailabilityResponse contains the response from method ManagedPrivateEndpointsClient.CheckNameAvailability.

type ManagedPrivateEndpointsClientCreateOrUpdateResponse 

type ManagedPrivateEndpointsClientCreateOrUpdateResponse struct {
	// Class representing a managed private endpoint.
	ManagedPrivateEndpoint
}

ManagedPrivateEndpointsClientCreateOrUpdateResponse contains the response from method ManagedPrivateEndpointsClient.BeginCreateOrUpdate.

type ManagedPrivateEndpointsClientDeleteResponse 

type ManagedPrivateEndpointsClientDeleteResponse struct {
}

ManagedPrivateEndpointsClientDeleteResponse contains the response from method ManagedPrivateEndpointsClient.BeginDelete.

type ManagedPrivateEndpointsClientGetOptions 

type ManagedPrivateEndpointsClientGetOptions struct {
}

ManagedPrivateEndpointsClientGetOptions contains the optional parameters for the ManagedPrivateEndpointsClient.Get method.

type ManagedPrivateEndpointsClientGetResponse 

type ManagedPrivateEndpointsClientGetResponse struct {
	// Class representing a managed private endpoint.
	ManagedPrivateEndpoint
}

ManagedPrivateEndpointsClientGetResponse contains the response from method ManagedPrivateEndpointsClient.Get.

type ManagedPrivateEndpointsClientListOptions 

type ManagedPrivateEndpointsClientListOptions struct {
}

ManagedPrivateEndpointsClientListOptions contains the optional parameters for the ManagedPrivateEndpointsClient.NewListPager method.

type ManagedPrivateEndpointsClientListResponse 

type ManagedPrivateEndpointsClientListResponse struct {
	// The list managed private endpoints operation response.
	ManagedPrivateEndpointListResult
}

ManagedPrivateEndpointsClientListResponse contains the response from method ManagedPrivateEndpointsClient.NewListPager.

type ManagedPrivateEndpointsClientUpdateResponse 

type ManagedPrivateEndpointsClientUpdateResponse struct {
	// Class representing a managed private endpoint.
	ManagedPrivateEndpoint
}

ManagedPrivateEndpointsClientUpdateResponse contains the response from method ManagedPrivateEndpointsClient.BeginUpdate.

type MigrationClusterProperties 

type MigrationClusterProperties struct {
	// READ-ONLY; The public data ingestion URL of the cluster.
	DataIngestionURI *string

	// READ-ONLY; The resource ID of the cluster.
	ID *string

	// READ-ONLY; The role of the cluster in the migration process.
	Role *MigrationClusterRole

	// READ-ONLY; The public URL of the cluster.
	URI *string
}

MigrationClusterProperties - Represents a properties of a cluster that is part of a migration.

func (MigrationClusterProperties) MarshalJSON 

func (m MigrationClusterProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MigrationClusterProperties.

func (*MigrationClusterProperties) UnmarshalJSON 

func (m *MigrationClusterProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MigrationClusterProperties.

type MigrationClusterRole 

type MigrationClusterRole string

MigrationClusterRole - The role of the cluster in the migration process. 

const (
	MigrationClusterRoleDestination MigrationClusterRole = "Destination"
	MigrationClusterRoleSource      MigrationClusterRole = "Source"
)

func PossibleMigrationClusterRoleValues 

func PossibleMigrationClusterRoleValues() []MigrationClusterRole

PossibleMigrationClusterRoleValues returns the possible values for the MigrationClusterRole 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 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON 

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 

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON 

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	// The URL to get the next set of operation list results if there are any.
	NextLink *string

	// The list of operations supported by the resource provider.
	Value []*Operation
}

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 

func (o *OperationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.

type OperationResult 

type OperationResult struct {
	// The operation end time
	EndTime *time.Time

	// Object that contains the error code and message if the operation failed.
	Error *OperationResultErrorProperties

	// Percentage completed.
	PercentComplete *float64

	// Properties of the operation results
	Properties *OperationResultProperties

	// The operation start time
	StartTime *time.Time

	// READ-ONLY; ID of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; status of the Operation result.
	Status *Status
}

OperationResult - Operation Result Entity.

func (OperationResult) MarshalJSON 

func (o OperationResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResult.

func (*OperationResult) UnmarshalJSON 

func (o *OperationResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResult.

type OperationResultErrorProperties 

type OperationResultErrorProperties struct {
	// The code of the error.
	Code *string

	// The error message.
	Message *string
}

OperationResultErrorProperties - Operation result error properties

func (OperationResultErrorProperties) MarshalJSON 

func (o OperationResultErrorProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResultErrorProperties.

func (*OperationResultErrorProperties) UnmarshalJSON 

func (o *OperationResultErrorProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResultErrorProperties.

type OperationResultProperties 

type OperationResultProperties struct {
	// The kind of the operation.
	OperationKind *string

	// The state of the operation.
	OperationState *string

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

OperationResultProperties - Operation result properties

func (OperationResultProperties) MarshalJSON 

func (o OperationResultProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResultProperties.

func (*OperationResultProperties) UnmarshalJSON 

func (o *OperationResultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResultProperties.

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(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists available operations for the Microsoft.Kusto provider.

Generated from API version 2023-08-15

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoOperationsList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOperationsClient().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 = armkusto.OperationListResult{
	// 	Value: []*armkusto.Operation{
	// 		{
	// 			Name: to.Ptr("operationName"),
	// 			Display: &armkusto.OperationDisplay{
	// 				Description: to.Ptr("operation description"),
	// 				Operation: to.Ptr("operationName"),
	// 				Provider: to.Ptr("providerName"),
	// 				Resource: to.Ptr("resourceName"),
	// 			},
	// 	}},
	// }
}

Output:

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse 

type OperationsClientListResponse 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
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type OperationsResultsClient 

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

OperationsResultsClient contains the methods for the OperationsResults group. Don't use this type directly, use NewOperationsResultsClient() instead.

func NewOperationsResultsClient 

func NewOperationsResultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsResultsClient, error)

NewOperationsResultsClient creates a new instance of OperationsResultsClient 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 (*OperationsResultsClient) Get 

func (client *OperationsResultsClient) Get(ctx context.Context, location string, operationID string, options *OperationsResultsClientGetOptions) (OperationsResultsClientGetResponse, error)

Get - Returns operation results. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • location - The name of Azure region.
  • operationID - The ID of an ongoing async operation.
  • options - OperationsResultsClientGetOptions contains the optional parameters for the OperationsResultsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoOperationResultsGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOperationsResultsClient().Get(ctx, "westus", "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", 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.OperationResult = armkusto.OperationResult{
// 	Name: to.Ptr("30972f1b-b61d-4fd8-bd34-3dcfa24670f3"),
// 	EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-26T13:45:42.702Z"); return t}()),
// 	Error: &armkusto.OperationResultErrorProperties{
// 		Code: to.Ptr("CannotAlterFollowerDatabase"),
// 		Message: to.Ptr("[BadRequest] Cannot alter leader cluster 'test' for resource name 'adc'."),
// 	},
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationresults/30972f1b-b61d-4fd8-bd34-3dcfa24670f3"),
// 	PercentComplete: to.Ptr[float64](1),
// 	Properties: &armkusto.OperationResultProperties{
// 		OperationKind: to.Ptr("FollowerDatabaseCreate"),
// 		OperationState: to.Ptr("BadInput"),
// 	},
// 	StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-26T13:45:39.655Z"); return t}()),
// 	Status: to.Ptr(armkusto.StatusFailed),
// }

Output:

type OperationsResultsClientGetOptions 

type OperationsResultsClientGetOptions struct {
}

OperationsResultsClientGetOptions contains the optional parameters for the OperationsResultsClient.Get method.

type OperationsResultsClientGetResponse 

type OperationsResultsClientGetResponse struct {
	// Operation Result Entity.
	OperationResult
}

OperationsResultsClientGetResponse contains the response from method OperationsResultsClient.Get.

type OperationsResultsLocationClient 

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

OperationsResultsLocationClient contains the methods for the OperationsResultsLocation group. Don't use this type directly, use NewOperationsResultsLocationClient() instead.

func NewOperationsResultsLocationClient 

func NewOperationsResultsLocationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsResultsLocationClient, error)

NewOperationsResultsLocationClient creates a new instance of OperationsResultsLocationClient 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 (*OperationsResultsLocationClient) Get 

func (client *OperationsResultsLocationClient) Get(ctx context.Context, location string, operationID string, options *OperationsResultsLocationClientGetOptions) (OperationsResultsLocationClientGetResponse, error)

Get - Returns operation results. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • location - The name of Azure region.
  • operationID - The ID of an ongoing async operation.
  • options - OperationsResultsLocationClientGetOptions contains the optional parameters for the OperationsResultsLocationClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoOperationResultsOperationResultResponseTypeGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewOperationsResultsLocationClient().Get(ctx, "westus", "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

type OperationsResultsLocationClientGetOptions 

type OperationsResultsLocationClientGetOptions struct {
}

OperationsResultsLocationClientGetOptions contains the optional parameters for the OperationsResultsLocationClient.Get method.

type OperationsResultsLocationClientGetResponse 

type OperationsResultsLocationClientGetResponse struct {
	// AzureAsyncOperation contains the information returned from the Azure-AsyncOperation header response.
	AzureAsyncOperation *string
}

OperationsResultsLocationClientGetResponse contains the response from method OperationsResultsLocationClient.Get.

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 

func (o OptimizedAutoscale) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OptimizedAutoscale.

func (*OptimizedAutoscale) UnmarshalJSON 

func (o *OptimizedAutoscale) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OptimizedAutoscale.

type OutboundNetworkDependenciesEndpoint 

type OutboundNetworkDependenciesEndpoint struct {
	// The outbound environment endpoint properties.
	Properties *OutboundNetworkDependenciesEndpointProperties

	// 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; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

OutboundNetworkDependenciesEndpoint - Endpoints accessed for a common purpose that the Kusto Service Environment requires outbound network access to.

func (OutboundNetworkDependenciesEndpoint) MarshalJSON 

func (o OutboundNetworkDependenciesEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundNetworkDependenciesEndpoint.

func (*OutboundNetworkDependenciesEndpoint) UnmarshalJSON 

func (o *OutboundNetworkDependenciesEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OutboundNetworkDependenciesEndpoint.

type OutboundNetworkDependenciesEndpointListResult 

type OutboundNetworkDependenciesEndpointListResult struct {
	// REQUIRED; Collection of resources.
	Value []*OutboundNetworkDependenciesEndpoint

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

OutboundNetworkDependenciesEndpointListResult - Collection of Outbound Environment Endpoints

func (OutboundNetworkDependenciesEndpointListResult) MarshalJSON 

func (o OutboundNetworkDependenciesEndpointListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundNetworkDependenciesEndpointListResult.

func (*OutboundNetworkDependenciesEndpointListResult) UnmarshalJSON 

func (o *OutboundNetworkDependenciesEndpointListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OutboundNetworkDependenciesEndpointListResult.

type OutboundNetworkDependenciesEndpointProperties 

type OutboundNetworkDependenciesEndpointProperties struct {
	// The type of service accessed by the Kusto Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active
	// Directory.
	Category *string

	// The endpoints that the Kusto Service Environment reaches the service at.
	Endpoints []*EndpointDependency

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

OutboundNetworkDependenciesEndpointProperties - Endpoints accessed for a common purpose that the Kusto Service Environment requires outbound network access to.

func (OutboundNetworkDependenciesEndpointProperties) MarshalJSON 

func (o OutboundNetworkDependenciesEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundNetworkDependenciesEndpointProperties.

func (*OutboundNetworkDependenciesEndpointProperties) UnmarshalJSON 

func (o *OutboundNetworkDependenciesEndpointProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OutboundNetworkDependenciesEndpointProperties.

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 

type PrincipalsModificationKind string

PrincipalsModificationKind - The principals modification kind of the database 

const (
	PrincipalsModificationKindNone    PrincipalsModificationKind = "None"
	PrincipalsModificationKindReplace PrincipalsModificationKind = "Replace"
	PrincipalsModificationKindUnion   PrincipalsModificationKind = "Union"
)

func PossiblePrincipalsModificationKindValues 

func PossiblePrincipalsModificationKindValues() []PrincipalsModificationKind

PossiblePrincipalsModificationKindValues returns the possible values for the PrincipalsModificationKind const type.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// Resource 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; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// 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 PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// Array of private endpoint connections
	Value []*PrivateEndpointConnection
}

PrivateEndpointConnectionListResult - A list of private endpoint connections

func (PrivateEndpointConnectionListResult) MarshalJSON 

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

func (*PrivateEndpointConnectionListResult) UnmarshalJSON 

func (p *PrivateEndpointConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; Connection State of the Private Endpoint Connection.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionStateProperty

	// READ-ONLY; Group id of the private endpoint.
	GroupID *string

	// READ-ONLY; Private endpoint which the connection belongs to.
	PrivateEndpoint *PrivateEndpointProperty

	// READ-ONLY; Provisioning state of the private endpoint.
	ProvisioningState *string
}

PrivateEndpointConnectionProperties - Properties of a private endpoint connection.

func (PrivateEndpointConnectionProperties) MarshalJSON 

func (p PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.

func (*PrivateEndpointConnectionProperties) UnmarshalJSON 

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) BeginCreateOrUpdate 

func (client *PrivateEndpointConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, privateEndpointConnectionName string, parameters PrivateEndpointConnection, options *PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[PrivateEndpointConnectionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Approve or reject a private endpoint connection with a given name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • privateEndpointConnectionName - The name of the private endpoint connection.
  • options - PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoPrivateEndpointConnectionsCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoclusterrptest4", "privateEndpointTest", armkusto.PrivateEndpointConnection{
	Properties: &armkusto.PrivateEndpointConnectionProperties{
		PrivateLinkServiceConnectionState: &armkusto.PrivateLinkServiceConnectionStateProperty{
			Description: to.Ptr("Approved by johndoe@contoso.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 = armkusto.PrivateEndpointConnection{
// 	Name: to.Ptr("privateEndpointTest"),
// 	Type: to.Ptr("Microsoft.Kusto/clusters/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/privateEndpointConnections/privateEndpointTest"),
// 	Properties: &armkusto.PrivateEndpointConnectionProperties{
// 		PrivateLinkServiceConnectionState: &armkusto.PrivateLinkServiceConnectionStateProperty{
// 			Description: to.Ptr("Approved by johndoe@contoso.com"),
// 			ActionsRequired: to.Ptr("None"),
// 			Status: to.Ptr("Approved"),
// 		},
// 	},
// }

Output:

func (*PrivateEndpointConnectionsClient) BeginDelete 

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointConnectionsClientDeleteResponse], error)

BeginDelete - Deletes a private endpoint connection with a given name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • 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/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoPrivateEndpointConnectionsDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginDelete(ctx, "kustorptest", "kustoCluster", "privateEndpointTest", 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, clusterName 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 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • 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/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoPrivateEndpointConnectionsGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateEndpointConnectionsClient().Get(ctx, "kustorptest", "kustoCluster", "privateEndpointTest", 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 = armkusto.PrivateEndpointConnection{
// 	Name: to.Ptr("privateEndpointTest"),
// 	Type: to.Ptr("Microsoft.Kusto/clusters/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/privateEndpointConnections/privateEndpointTest"),
// 	Properties: &armkusto.PrivateEndpointConnectionProperties{
// 		GroupID: to.Ptr("cluster"),
// 		PrivateEndpoint: &armkusto.PrivateEndpointProperty{
// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName"),
// 		},
// 		PrivateLinkServiceConnectionState: &armkusto.PrivateLinkServiceConnectionStateProperty{
// 			Description: to.Ptr("Auto-approved"),
// 			ActionsRequired: to.Ptr("None"),
// 			Status: to.Ptr("Approved"),
// 		},
// 		ProvisioningState: to.Ptr("Succeeded"),
// 	},
// }

Output:

func (*PrivateEndpointConnectionsClient) NewListPager 

func (client *PrivateEndpointConnectionsClient) NewListPager(resourceGroupName string, clusterName string, options *PrivateEndpointConnectionsClientListOptions) *runtime.Pager[PrivateEndpointConnectionsClientListResponse]

NewListPager - Returns the list of private endpoint connections.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • 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/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoPrivateEndpointConnectionsList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListPager("kustorptest", "kustoCluster", 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.PrivateEndpointConnectionListResult = armkusto.PrivateEndpointConnectionListResult{
	// 	Value: []*armkusto.PrivateEndpointConnection{
	// 		{
	// 			Name: to.Ptr("privateEndpointTest"),
	// 			Type: to.Ptr("Microsoft.Kusto/clusters/privateEndpointConnections"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/privateEndpointConnections/privateEndpointTest"),
	// 			Properties: &armkusto.PrivateEndpointConnectionProperties{
	// 				GroupID: to.Ptr("cluster"),
	// 				PrivateEndpoint: &armkusto.PrivateEndpointProperty{
	// 					ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName"),
	// 				},
	// 				PrivateLinkServiceConnectionState: &armkusto.PrivateLinkServiceConnectionStateProperty{
	// 					Description: to.Ptr("Auto-approved"),
	// 					ActionsRequired: to.Ptr("None"),
	// 					Status: to.Ptr("Approved"),
	// 				},
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("privateEndpointTest2"),
	// 			Type: to.Ptr("Microsoft.Kusto/clusters/privateEndpointConnections"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/privateEndpointConnections/privateEndpointTest2"),
	// 			Properties: &armkusto.PrivateEndpointConnectionProperties{
	// 				GroupID: to.Ptr("cluster"),
	// 				PrivateEndpoint: &armkusto.PrivateEndpointProperty{
	// 					ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName2"),
	// 				},
	// 				PrivateLinkServiceConnectionState: &armkusto.PrivateLinkServiceConnectionStateProperty{
	// 					Description: to.Ptr("Auto-approved"),
	// 					ActionsRequired: to.Ptr("None"),
	// 					Status: to.Ptr("Approved"),
	// 				},
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 			},
	// 	}},
	// }
}

Output:

type PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions 

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

PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreateOrUpdate method.

type PrivateEndpointConnectionsClientBeginDeleteOptions 

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

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientCreateOrUpdateResponse 

type PrivateEndpointConnectionsClientCreateOrUpdateResponse struct {
	// A private endpoint connection
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateOrUpdateResponse contains the response from method PrivateEndpointConnectionsClient.BeginCreateOrUpdate.

type PrivateEndpointConnectionsClientDeleteResponse 

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.BeginDelete.

type PrivateEndpointConnectionsClientGetOptions 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse 

type PrivateEndpointConnectionsClientGetResponse struct {
	// A private endpoint connection
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListOptions 

type PrivateEndpointConnectionsClientListOptions struct {
}

PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListPager method.

type PrivateEndpointConnectionsClientListResponse 

type PrivateEndpointConnectionsClientListResponse struct {
	// A list of private endpoint connections
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListResponse contains the response from method PrivateEndpointConnectionsClient.NewListPager.

type PrivateEndpointProperty 

type PrivateEndpointProperty struct {
	// READ-ONLY; Resource id of the private endpoint.
	ID *string
}

PrivateEndpointProperty - Private endpoint which the connection belongs to.

func (PrivateEndpointProperty) MarshalJSON 

func (p PrivateEndpointProperty) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointProperty.

func (*PrivateEndpointProperty) UnmarshalJSON 

func (p *PrivateEndpointProperty) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointProperty.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// Resource properties.
	Properties *PrivateLinkResourceProperties

	// 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; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

	// 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 {
	// Array of private link resources
	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 

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; The private link resource required zone names.
	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 

func (p *PrivateLinkResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceProperties.

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, clusterName string, privateLinkResourceName string, options *PrivateLinkResourcesClientGetOptions) (PrivateLinkResourcesClientGetResponse, error)

Get - Gets a private link resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • 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/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoPrivateLinkResourcesGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateLinkResourcesClient().Get(ctx, "kustorptest", "kustoCluster", "cluster", 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 = armkusto.PrivateLinkResource{
// 	Name: to.Ptr("cluster"),
// 	Type: to.Ptr("Microsoft.Kusto/clusters/PrivateLinkResources"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/privateLinkResources/cluster"),
// 	Properties: &armkusto.PrivateLinkResourceProperties{
// 		GroupID: to.Ptr("cluster"),
// 		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:

func (*PrivateLinkResourcesClient) NewListPager 

func (client *PrivateLinkResourcesClient) NewListPager(resourceGroupName string, clusterName string, options *PrivateLinkResourcesClientListOptions) *runtime.Pager[PrivateLinkResourcesClientListResponse]

NewListPager - Returns the list of private link resources.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • 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/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoPrivateLinkResourcesList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateLinkResourcesClient().NewListPager("kustorptest", "kustoCluster", 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 = armkusto.PrivateLinkResourceListResult{
	// 	Value: []*armkusto.PrivateLinkResource{
	// 		{
	// 			Name: to.Ptr("cluster"),
	// 			Type: to.Ptr("Microsoft.Kusto/clusters/PrivateLinkResources"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/privateLinkResources/cluster"),
	// 			Properties: &armkusto.PrivateLinkResourceProperties{
	// 				GroupID: to.Ptr("cluster"),
	// 				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 PrivateLinkResourcesClientGetOptions 

type PrivateLinkResourcesClientGetOptions struct {
}

PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

type PrivateLinkResourcesClientGetResponse 

type PrivateLinkResourcesClientGetResponse struct {
	// A private link resource
	PrivateLinkResource
}

PrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientListOptions 

type PrivateLinkResourcesClientListOptions struct {
}

PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.NewListPager method.

type PrivateLinkResourcesClientListResponse 

type PrivateLinkResourcesClientListResponse struct {
	// A list of private link resources
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientListResponse contains the response from method PrivateLinkResourcesClient.NewListPager.

type PrivateLinkServiceConnectionStateProperty 

type PrivateLinkServiceConnectionStateProperty struct {
	// The private link service connection description.
	Description *string

	// The private link service connection status.
	Status *string

	// READ-ONLY; Any action that is required beyond basic workflow (approve/ reject/ disconnect)
	ActionsRequired *string
}

PrivateLinkServiceConnectionStateProperty - Connection State of the Private Endpoint Connection.

func (PrivateLinkServiceConnectionStateProperty) MarshalJSON 

func (p PrivateLinkServiceConnectionStateProperty) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceConnectionStateProperty.

func (*PrivateLinkServiceConnectionStateProperty) UnmarshalJSON 

func (p *PrivateLinkServiceConnectionStateProperty) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceConnectionStateProperty.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - The provisioned state of the resource. 

const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateMoving    ProvisioningState = "Moving"
	ProvisioningStateRunning   ProvisioningState = "Running"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type PublicIPType 

type PublicIPType string

PublicIPType - Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) 

const (
	PublicIPTypeDualStack PublicIPType = "DualStack"
	PublicIPTypeIPv4      PublicIPType = "IPv4"
)

func PossiblePublicIPTypeValues 

func PossiblePublicIPTypeValues() []PublicIPType

PossiblePublicIPTypeValues returns the possible values for the PublicIPType const type.

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess - Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed 

const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

type ReadOnlyFollowingDatabase 

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; 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 

func (r *ReadOnlyFollowingDatabase) GetDatabase() *Database

GetDatabase implements the DatabaseClassification interface for type ReadOnlyFollowingDatabase.

func (ReadOnlyFollowingDatabase) MarshalJSON 

func (r ReadOnlyFollowingDatabase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReadOnlyFollowingDatabase.

func (*ReadOnlyFollowingDatabase) UnmarshalJSON 

func (r *ReadOnlyFollowingDatabase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReadOnlyFollowingDatabase.

type ReadOnlyFollowingDatabaseProperties 

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 origin of the following setup.
	DatabaseShareOrigin *DatabaseShareOrigin

	// READ-ONLY; The name of the leader cluster
	LeaderClusterResourceID *string

	// READ-ONLY; The original database name, before databaseNameOverride or databaseNamePrefix where applied.
	OriginalDatabaseName *string

	// READ-ONLY; The principals modification kind of the database
	PrincipalsModificationKind *PrincipalsModificationKind

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

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

	// READ-ONLY; The database suspension details. If the database is suspended, this object contains information related to the
	// database's suspension state.
	SuspensionDetails *SuspensionDetails

	// READ-ONLY; Table level sharing specifications
	TableLevelSharingProperties *TableLevelSharingProperties
}

ReadOnlyFollowingDatabaseProperties - Class representing the Kusto database properties.

func (ReadOnlyFollowingDatabaseProperties) MarshalJSON 

func (r ReadOnlyFollowingDatabaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReadOnlyFollowingDatabaseProperties.

func (*ReadOnlyFollowingDatabaseProperties) UnmarshalJSON 

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; 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 

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

	// KeyVault properties for the database encryption.
	KeyVaultProperties *KeyVaultProperties

	// 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 *ProvisioningState

	// READ-ONLY; The statistics of the database.
	Statistics *DatabaseStatistics

	// READ-ONLY; The database suspension details. If the database is suspended, this object contains information related to the
	// database's suspension state.
	SuspensionDetails *SuspensionDetails
}

ReadWriteDatabaseProperties - Class representing the Kusto database properties.

func (ReadWriteDatabaseProperties) MarshalJSON 

func (r ReadWriteDatabaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReadWriteDatabaseProperties.

func (*ReadWriteDatabaseProperties) UnmarshalJSON 

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 ResourceSKUCapabilities 

type ResourceSKUCapabilities struct {
	// READ-ONLY; An invariant to describe the feature.
	Name *string

	// READ-ONLY; An invariant if the feature is measured by quantity.
	Value *string
}

ResourceSKUCapabilities - Describes The SKU capabilities object.

func (ResourceSKUCapabilities) MarshalJSON 

func (r ResourceSKUCapabilities) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKUCapabilities.

func (*ResourceSKUCapabilities) UnmarshalJSON 

func (r *ResourceSKUCapabilities) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceSKUCapabilities.

type ResourceSKUZoneDetails 

type ResourceSKUZoneDetails struct {
	// READ-ONLY; A list of capabilities that are available for the SKU in the specified list of zones.
	Capabilities []*ResourceSKUCapabilities

	// READ-ONLY; The set of zones that the SKU is available in with the specified capabilities.
	Name []*string
}

ResourceSKUZoneDetails - Describes The zonal capabilities of a SKU.

func (ResourceSKUZoneDetails) MarshalJSON 

func (r ResourceSKUZoneDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSKUZoneDetails.

func (*ResourceSKUZoneDetails) UnmarshalJSON 

func (r *ResourceSKUZoneDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceSKUZoneDetails.

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 tier of the SKU
	Tier *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 

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 EngagementFabric SKU descriptions

func (SKUDescriptionList) MarshalJSON 

func (s SKUDescriptionList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUDescriptionList.

func (*SKUDescriptionList) UnmarshalJSON 

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

	// Gets details of capabilities available to a SKU in specific zones.
	ZoneDetails []*ResourceSKUZoneDetails

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

func (s *SKULocationInfoItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKULocationInfoItem.

type SKUsClient 

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

SKUsClient contains the methods for the SKUs group. Don't use this type directly, use NewSKUsClient() instead.

func NewSKUsClient 

func NewSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SKUsClient, error)

NewSKUsClient creates a new instance of SKUsClient 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 (*SKUsClient) NewListPager 

func (client *SKUsClient) NewListPager(location string, options *SKUsClientListOptions) *runtime.Pager[SKUsClientListResponse]

NewListPager - Lists eligible region SKUs for Kusto resource provider by Azure region.

Generated from API version 2023-08-15

  • location - The name of Azure region.
  • options - SKUsClientListOptions contains the optional parameters for the SKUsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoSkus.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSKUsClient().NewListPager("westus", 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 = armkusto.SKUDescriptionList{
	// 	Value: []*armkusto.SKUDescription{
	// 		{
	// 			Name: to.Ptr("Standard_L8s_v3"),
	// 			LocationInfo: []*armkusto.SKULocationInfoItem{
	// 				{
	// 					Location: to.Ptr("West US"),
	// 					Zones: []*string{
	// 						to.Ptr("1"),
	// 						to.Ptr("2"),
	// 						to.Ptr("3")},
	// 					},
	// 					{
	// 						Location: to.Ptr("West US"),
	// 						Zones: []*string{
	// 						},
	// 				}},
	// 				Locations: []*string{
	// 					to.Ptr("West US")},
	// 					Tier: to.Ptr("Standard"),
	// 				},
	// 				{
	// 					Name: to.Ptr("Standard_L16s_v3"),
	// 					LocationInfo: []*armkusto.SKULocationInfoItem{
	// 						{
	// 							Location: to.Ptr("West US"),
	// 							Zones: []*string{
	// 								to.Ptr("1"),
	// 								to.Ptr("2"),
	// 								to.Ptr("3")},
	// 							},
	// 							{
	// 								Location: to.Ptr("West US"),
	// 								Zones: []*string{
	// 								},
	// 						}},
	// 						Locations: []*string{
	// 							to.Ptr("West US")},
	// 							Tier: to.Ptr("Standard"),
	// 						},
	// 						{
	// 							Name: to.Ptr("Standard_L8as_v3"),
	// 							LocationInfo: []*armkusto.SKULocationInfoItem{
	// 								{
	// 									Location: to.Ptr("West US"),
	// 									Zones: []*string{
	// 										to.Ptr("1"),
	// 										to.Ptr("2"),
	// 										to.Ptr("3")},
	// 									},
	// 									{
	// 										Location: to.Ptr("West US"),
	// 										Zones: []*string{
	// 										},
	// 								}},
	// 								Locations: []*string{
	// 									to.Ptr("West US"),
	// 									to.Ptr("West Europe")},
	// 									Tier: to.Ptr("Standard"),
	// 								},
	// 								{
	// 									Name: to.Ptr("Standard_L16as_v3"),
	// 									LocationInfo: []*armkusto.SKULocationInfoItem{
	// 										{
	// 											Location: to.Ptr("West US"),
	// 											Zones: []*string{
	// 												to.Ptr("1"),
	// 												to.Ptr("2"),
	// 												to.Ptr("3")},
	// 											},
	// 											{
	// 												Location: to.Ptr("West US"),
	// 												Zones: []*string{
	// 												},
	// 										}},
	// 										Locations: []*string{
	// 											to.Ptr("West US"),
	// 											to.Ptr("West Europe")},
	// 											Tier: to.Ptr("Standard"),
	// 									}},
	// 								}
}

Output:

type SKUsClientListOptions 

type SKUsClientListOptions struct {
}

SKUsClientListOptions contains the optional parameters for the SKUsClient.NewListPager method.

type SKUsClientListResponse 

type SKUsClientListResponse struct {
	// The list of the EngagementFabric SKU descriptions
	SKUDescriptionList
}

SKUsClientListResponse contains the response from method SKUsClient.NewListPager.

type SandboxCustomImage added in v2.1.0 

type SandboxCustomImage struct {
	// A sandbox custom image.
	Properties *SandboxCustomImageProperties

	// 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
}

SandboxCustomImage - Class representing a Kusto sandbox custom image.

func (SandboxCustomImage) MarshalJSON added in v2.1.0 

func (s SandboxCustomImage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SandboxCustomImage.

func (*SandboxCustomImage) UnmarshalJSON added in v2.1.0 

func (s *SandboxCustomImage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SandboxCustomImage.

type SandboxCustomImageProperties added in v2.1.0 

type SandboxCustomImageProperties struct {
	// REQUIRED; The language name, for example Python.
	Language *Language

	// REQUIRED; The version of the language.
	LanguageVersion *string

	// The requirements file content.
	RequirementsFileContent *string

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

SandboxCustomImageProperties - A class representing the properties of a sandbox custom image object.

func (SandboxCustomImageProperties) MarshalJSON added in v2.1.0 

func (s SandboxCustomImageProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SandboxCustomImageProperties.

func (*SandboxCustomImageProperties) UnmarshalJSON added in v2.1.0 

func (s *SandboxCustomImageProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SandboxCustomImageProperties.

type SandboxCustomImagesCheckNameRequest added in v2.1.0 

type SandboxCustomImagesCheckNameRequest struct {
	// REQUIRED; Sandbox custom image resource name.
	Name *string

	// CONSTANT; The type of resource, for instance Microsoft.Kusto/clusters/sandboxCustomImages.
	// Field has constant value "Microsoft.Kusto/clusters/sandboxCustomImages", any specified value is ignored.
	Type *string
}

SandboxCustomImagesCheckNameRequest - The result returned from a sandboxCustomImage check name availability request.

func (SandboxCustomImagesCheckNameRequest) MarshalJSON added in v2.1.0 

func (s SandboxCustomImagesCheckNameRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SandboxCustomImagesCheckNameRequest.

func (*SandboxCustomImagesCheckNameRequest) UnmarshalJSON added in v2.1.0 

func (s *SandboxCustomImagesCheckNameRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SandboxCustomImagesCheckNameRequest.

type SandboxCustomImagesClient added in v2.1.0 

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

SandboxCustomImagesClient contains the methods for the SandboxCustomImages group. Don't use this type directly, use NewSandboxCustomImagesClient() instead.

func NewSandboxCustomImagesClient added in v2.1.0 

func NewSandboxCustomImagesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SandboxCustomImagesClient, error)

NewSandboxCustomImagesClient creates a new instance of SandboxCustomImagesClient 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 (*SandboxCustomImagesClient) BeginCreateOrUpdate added in v2.1.0 

func (client *SandboxCustomImagesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, sandboxCustomImageName string, parameters SandboxCustomImage, options *SandboxCustomImagesClientBeginCreateOrUpdateOptions) (*runtime.Poller[SandboxCustomImagesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a sandbox custom image. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • sandboxCustomImageName - The name of the sandbox custom image.
  • parameters - The sandbox custom image parameters.
  • options - SandboxCustomImagesClientBeginCreateOrUpdateOptions contains the optional parameters for the SandboxCustomImagesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoSandboxCustomImagesCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSandboxCustomImagesClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "customImage8", armkusto.SandboxCustomImage{
	Properties: &armkusto.SandboxCustomImageProperties{
		LanguageVersion:         to.Ptr("3.10.8"),
		RequirementsFileContent: to.Ptr("Requests"),
		Language:                to.Ptr(armkusto.LanguagePython),
	},
}, 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.SandboxCustomImage = armkusto.SandboxCustomImage{
// 	Name: to.Ptr("kustoCluster/customImage8"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/SandboxCustomImages"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage8"),
// 	Properties: &armkusto.SandboxCustomImageProperties{
// 		LanguageVersion: to.Ptr("3.10.8"),
// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 		RequirementsFileContent: to.Ptr("Requests"),
// 		Language: to.Ptr(armkusto.LanguagePython),
// 	},
// }

Output:

func (*SandboxCustomImagesClient) BeginDelete added in v2.1.0 

func (client *SandboxCustomImagesClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, sandboxCustomImageName string, options *SandboxCustomImagesClientBeginDeleteOptions) (*runtime.Poller[SandboxCustomImagesClientDeleteResponse], error)

BeginDelete - Deletes a sandbox custom image. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • sandboxCustomImageName - The name of the sandbox custom image.
  • options - SandboxCustomImagesClientBeginDeleteOptions contains the optional parameters for the SandboxCustomImagesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoSandboxCustomImageDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSandboxCustomImagesClient().BeginDelete(ctx, "kustorptest", "kustoCluster", "customImage8", 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 (*SandboxCustomImagesClient) BeginUpdate added in v2.1.0 

func (client *SandboxCustomImagesClient) BeginUpdate(ctx context.Context, resourceGroupName string, clusterName string, sandboxCustomImageName string, parameters SandboxCustomImage, options *SandboxCustomImagesClientBeginUpdateOptions) (*runtime.Poller[SandboxCustomImagesClientUpdateResponse], error)

BeginUpdate - Updates a sandbox custom image. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • sandboxCustomImageName - The name of the sandbox custom image.
  • parameters - The sandbox custom image parameters.
  • options - SandboxCustomImagesClientBeginUpdateOptions contains the optional parameters for the SandboxCustomImagesClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoSandboxCustomImageUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSandboxCustomImagesClient().BeginUpdate(ctx, "kustorptest", "kustoCluster", "customImage8", armkusto.SandboxCustomImage{
	Properties: &armkusto.SandboxCustomImageProperties{
		LanguageVersion:         to.Ptr("3.10.8"),
		RequirementsFileContent: to.Ptr("Requests"),
		Language:                to.Ptr(armkusto.LanguagePython),
	},
}, 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.SandboxCustomImage = armkusto.SandboxCustomImage{
// 	Name: to.Ptr("kustoCluster/customImage8"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/SandboxCustomImages"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage8"),
// 	Properties: &armkusto.SandboxCustomImageProperties{
// 		LanguageVersion: to.Ptr("3.10.8"),
// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 		RequirementsFileContent: to.Ptr("Requests"),
// 		Language: to.Ptr(armkusto.LanguagePython),
// 	},
// }

Output:

func (*SandboxCustomImagesClient) CheckNameAvailability added in v2.1.0 

func (client *SandboxCustomImagesClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, clusterName string, resourceName SandboxCustomImagesCheckNameRequest, options *SandboxCustomImagesClientCheckNameAvailabilityOptions) (SandboxCustomImagesClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the sandbox custom image resource name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • resourceName - The name of the resource.
  • options - SandboxCustomImagesClientCheckNameAvailabilityOptions contains the optional parameters for the SandboxCustomImagesClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoSandboxCustomImagesCheckNameAvailability.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSandboxCustomImagesClient().CheckNameAvailability(ctx, "kustorptest", "kustoCluster", armkusto.SandboxCustomImagesCheckNameRequest{
	Name: to.Ptr("sandboxCustomImage1"),
	Type: to.Ptr("Microsoft.Kusto/clusters/sandboxCustomImages"),
}, 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 = armkusto.CheckNameResult{
// 	Name: to.Ptr("sandboxCustomImage1"),
// 	Message: to.Ptr("Name 'sandboxCustomImage1' is already taken. Please specify a different name"),
// 	NameAvailable: to.Ptr(false),
// }

Output:

func (*SandboxCustomImagesClient) Get added in v2.1.0 

func (client *SandboxCustomImagesClient) Get(ctx context.Context, resourceGroupName string, clusterName string, sandboxCustomImageName string, options *SandboxCustomImagesClientGetOptions) (SandboxCustomImagesClientGetResponse, error)

Get - Returns a sandbox custom image If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • sandboxCustomImageName - The name of the sandbox custom image.
  • options - SandboxCustomImagesClientGetOptions contains the optional parameters for the SandboxCustomImagesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoSandboxCustomImagesGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSandboxCustomImagesClient().Get(ctx, "kustorptest", "kustoCluster", "customImage8", 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.SandboxCustomImage = armkusto.SandboxCustomImage{
// 	Name: to.Ptr("kustoCluster/customImage8"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/SandboxCustomImages"),
// 	ID: to.Ptr("/subscriptions/f12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage8"),
// 	Properties: &armkusto.SandboxCustomImageProperties{
// 		LanguageVersion: to.Ptr("3.10.8"),
// 		ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
// 		RequirementsFileContent: to.Ptr("Requests"),
// 		Language: to.Ptr(armkusto.LanguagePython),
// 	},
// }

Output:

func (*SandboxCustomImagesClient) NewListByClusterPager added in v2.1.0 

func (client *SandboxCustomImagesClient) NewListByClusterPager(resourceGroupName string, clusterName string, options *SandboxCustomImagesClientListByClusterOptions) *runtime.Pager[SandboxCustomImagesClientListByClusterResponse]

NewListByClusterPager - Returns the list of the existing sandbox custom images of the given Kusto cluster.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • options - SandboxCustomImagesClientListByClusterOptions contains the optional parameters for the SandboxCustomImagesClient.NewListByClusterPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoSandboxCustomImagesList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSandboxCustomImagesClient().NewListByClusterPager("kustorptest", "kustoCluster", 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.SandboxCustomImagesListResult = armkusto.SandboxCustomImagesListResult{
	// 	Value: []*armkusto.SandboxCustomImage{
	// 		{
	// 			Name: to.Ptr("kustoCluster/customImage7"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/SandboxCustomImages"),
	// 			ID: to.Ptr("/subscriptions/f12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage7"),
	// 			Properties: &armkusto.SandboxCustomImageProperties{
	// 				LanguageVersion: to.Ptr("3.10.8"),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				RequirementsFileContent: to.Ptr("Requests"),
	// 				Language: to.Ptr(armkusto.LanguagePython),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("kustoCluster/customImage8"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/SandboxCustomImages"),
	// 			ID: to.Ptr("/subscriptions/f12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/SandboxCustomImages/customImage8"),
	// 			Properties: &armkusto.SandboxCustomImageProperties{
	// 				LanguageVersion: to.Ptr("3.9.7"),
	// 				ProvisioningState: to.Ptr(armkusto.ProvisioningStateSucceeded),
	// 				RequirementsFileContent: to.Ptr("PyTorch"),
	// 				Language: to.Ptr(armkusto.LanguagePython),
	// 			},
	// 	}},
	// }
}

Output:

type SandboxCustomImagesClientBeginCreateOrUpdateOptions added in v2.1.0 

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

SandboxCustomImagesClientBeginCreateOrUpdateOptions contains the optional parameters for the SandboxCustomImagesClient.BeginCreateOrUpdate method.

type SandboxCustomImagesClientBeginDeleteOptions added in v2.1.0 

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

SandboxCustomImagesClientBeginDeleteOptions contains the optional parameters for the SandboxCustomImagesClient.BeginDelete method.

type SandboxCustomImagesClientBeginUpdateOptions added in v2.1.0 

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

SandboxCustomImagesClientBeginUpdateOptions contains the optional parameters for the SandboxCustomImagesClient.BeginUpdate method.

type SandboxCustomImagesClientCheckNameAvailabilityOptions added in v2.1.0 

type SandboxCustomImagesClientCheckNameAvailabilityOptions struct {
}

SandboxCustomImagesClientCheckNameAvailabilityOptions contains the optional parameters for the SandboxCustomImagesClient.CheckNameAvailability method.

type SandboxCustomImagesClientCheckNameAvailabilityResponse added in v2.1.0 

type SandboxCustomImagesClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

SandboxCustomImagesClientCheckNameAvailabilityResponse contains the response from method SandboxCustomImagesClient.CheckNameAvailability.

type SandboxCustomImagesClientCreateOrUpdateResponse added in v2.1.0 

type SandboxCustomImagesClientCreateOrUpdateResponse struct {
	// Class representing a Kusto sandbox custom image.
	SandboxCustomImage
}

SandboxCustomImagesClientCreateOrUpdateResponse contains the response from method SandboxCustomImagesClient.BeginCreateOrUpdate.

type SandboxCustomImagesClientDeleteResponse added in v2.1.0 

type SandboxCustomImagesClientDeleteResponse struct {
}

SandboxCustomImagesClientDeleteResponse contains the response from method SandboxCustomImagesClient.BeginDelete.

type SandboxCustomImagesClientGetOptions added in v2.1.0 

type SandboxCustomImagesClientGetOptions struct {
}

SandboxCustomImagesClientGetOptions contains the optional parameters for the SandboxCustomImagesClient.Get method.

type SandboxCustomImagesClientGetResponse added in v2.1.0 

type SandboxCustomImagesClientGetResponse struct {
	// Class representing a Kusto sandbox custom image.
	SandboxCustomImage
}

SandboxCustomImagesClientGetResponse contains the response from method SandboxCustomImagesClient.Get.

type SandboxCustomImagesClientListByClusterOptions added in v2.1.0 

type SandboxCustomImagesClientListByClusterOptions struct {
}

SandboxCustomImagesClientListByClusterOptions contains the optional parameters for the SandboxCustomImagesClient.NewListByClusterPager method.

type SandboxCustomImagesClientListByClusterResponse added in v2.1.0 

type SandboxCustomImagesClientListByClusterResponse struct {
	// The list Kusto sandbox custom images operation response.
	SandboxCustomImagesListResult
}

SandboxCustomImagesClientListByClusterResponse contains the response from method SandboxCustomImagesClient.NewListByClusterPager.

type SandboxCustomImagesClientUpdateResponse added in v2.1.0 

type SandboxCustomImagesClientUpdateResponse struct {
	// Class representing a Kusto sandbox custom image.
	SandboxCustomImage
}

SandboxCustomImagesClientUpdateResponse contains the response from method SandboxCustomImagesClient.BeginUpdate.

type SandboxCustomImagesListResult added in v2.1.0 

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

	// The list of Kusto sandbox custom images.
	Value []*SandboxCustomImage
}

SandboxCustomImagesListResult - The list Kusto sandbox custom images operation response.

func (SandboxCustomImagesListResult) MarshalJSON added in v2.1.0 

func (s SandboxCustomImagesListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SandboxCustomImagesListResult.

func (*SandboxCustomImagesListResult) UnmarshalJSON added in v2.1.0 

func (s *SandboxCustomImagesListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SandboxCustomImagesListResult.

type Script 

type Script struct {
	// The database script.
	Properties *ScriptProperties

	// 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; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData

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

Script - Class representing a database script.

func (Script) MarshalJSON 

func (s Script) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Script.

func (*Script) UnmarshalJSON 

func (s *Script) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Script.

type ScriptCheckNameRequest 

type ScriptCheckNameRequest struct {
	// REQUIRED; Script name.
	Name *string

	// CONSTANT; The type of resource, Microsoft.Kusto/clusters/databases/scripts.
	// Field has constant value "Microsoft.Kusto/clusters/databases/scripts", any specified value is ignored.
	Type *string
}

ScriptCheckNameRequest - A script name availability request.

func (ScriptCheckNameRequest) MarshalJSON 

func (s ScriptCheckNameRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScriptCheckNameRequest.

func (*ScriptCheckNameRequest) UnmarshalJSON 

func (s *ScriptCheckNameRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScriptCheckNameRequest.

type ScriptListResult 

type ScriptListResult struct {
	// The list of Kusto scripts.
	Value []*Script
}

ScriptListResult - The list Kusto database script operation response.

func (ScriptListResult) MarshalJSON 

func (s ScriptListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScriptListResult.

func (*ScriptListResult) UnmarshalJSON 

func (s *ScriptListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScriptListResult.

type ScriptProperties 

type ScriptProperties struct {
	// Flag that indicates whether to continue if one of the command fails.
	ContinueOnErrors *bool

	// A unique string. If changed the script will be applied again.
	ForceUpdateTag *string

	// The script content. This property should be used when the script is provide inline and not through file in a SA. Must not
	// be used together with scriptUrl and scriptUrlSasToken properties.
	ScriptContent *string

	// The url to the KQL script blob file. Must not be used together with scriptContent property
	ScriptURL *string

	// The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property.
	ScriptURLSasToken *string

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

ScriptProperties - A class representing database script property.

func (ScriptProperties) MarshalJSON 

func (s ScriptProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScriptProperties.

func (*ScriptProperties) UnmarshalJSON 

func (s *ScriptProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScriptProperties.

type ScriptsClient 

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

ScriptsClient contains the methods for the Scripts group. Don't use this type directly, use NewScriptsClient() instead.

func NewScriptsClient 

func NewScriptsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ScriptsClient, error)

NewScriptsClient creates a new instance of ScriptsClient 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 (*ScriptsClient) BeginCreateOrUpdate 

func (client *ScriptsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, scriptName string, parameters Script, options *ScriptsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ScriptsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a Kusto database script. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • scriptName - The name of the Kusto database script.
  • parameters - The Kusto Script parameters contains the KQL to run.
  • options - ScriptsClientBeginCreateOrUpdateOptions contains the optional parameters for the ScriptsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoScriptsCreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewScriptsClient().BeginCreateOrUpdate(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", "kustoScript", armkusto.Script{
	Properties: &armkusto.ScriptProperties{
		ContinueOnErrors:  to.Ptr(true),
		ForceUpdateTag:    to.Ptr("2bcf3c21-ffd1-4444-b9dd-e52e00ee53fe"),
		ScriptURL:         to.Ptr("https://mysa.blob.core.windows.net/container/script.txt"),
		ScriptURLSasToken: to.Ptr("?sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=********************************"),
	},
}, 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.Script = armkusto.Script{
// 	Name: to.Ptr("kustoCluster/KustoDatabase8/kustoScript"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/Scripts"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/Scripts/kustoScript"),
// 	Properties: &armkusto.ScriptProperties{
// 		ContinueOnErrors: to.Ptr(true),
// 		ForceUpdateTag: to.Ptr("2bcf3c21-ffd1-4444-b9dd-e52e00ee53fe"),
// 		ScriptURL: to.Ptr("https://mysa.blob.core.windows.net/container/script.txt"),
// 	},
// 	SystemData: &armkusto.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-29T15:06:54.275Z"); return t}()),
// 		CreatedBy: to.Ptr("user@microsoft.com"),
// 		CreatedByType: to.Ptr(armkusto.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-07-01T17:16:24.364Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2@microsoft.com"),
// 		LastModifiedByType: to.Ptr(armkusto.CreatedByTypeUser),
// 	},
// }

Output:

func (*ScriptsClient) BeginDelete 

func (client *ScriptsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, scriptName string, options *ScriptsClientBeginDeleteOptions) (*runtime.Poller[ScriptsClientDeleteResponse], error)

BeginDelete - Deletes a Kusto database script. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • scriptName - The name of the Kusto database script.
  • options - ScriptsClientBeginDeleteOptions contains the optional parameters for the ScriptsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoScriptsDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewScriptsClient().BeginDelete(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", "kustoScript", 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 (*ScriptsClient) BeginUpdate 

func (client *ScriptsClient) BeginUpdate(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, scriptName string, parameters Script, options *ScriptsClientBeginUpdateOptions) (*runtime.Poller[ScriptsClientUpdateResponse], error)

BeginUpdate - Updates a database script. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • scriptName - The name of the Kusto database script.
  • parameters - The Kusto Script parameters contains to the KQL to run.
  • options - ScriptsClientBeginUpdateOptions contains the optional parameters for the ScriptsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoScriptsUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewScriptsClient().BeginUpdate(ctx, "kustorptest", "kustoCluster", "KustoDatabase8", "kustoScript", armkusto.Script{
	Properties: &armkusto.ScriptProperties{
		ContinueOnErrors:  to.Ptr(true),
		ForceUpdateTag:    to.Ptr("2bcf3c21-ffd1-4444-b9dd-e52e00ee53fe"),
		ScriptURL:         to.Ptr("https://mysa.blob.core.windows.net/container/script.txt"),
		ScriptURLSasToken: to.Ptr("?sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=********************************"),
	},
}, 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.Script = armkusto.Script{
// 	Name: to.Ptr("kustoCluster/KustoDatabase8/kustoScript"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/Scripts"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/KustoDatabase8/Scripts/kustoScript"),
// 	Properties: &armkusto.ScriptProperties{
// 		ContinueOnErrors: to.Ptr(true),
// 		ForceUpdateTag: to.Ptr("2bcf3c21-ffd1-4444-b9dd-e52e00ee53fe"),
// 		ScriptURL: to.Ptr("https://mysa.blob.core.windows.net/container/script.txt"),
// 	},
// 	SystemData: &armkusto.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-29T15:06:54.275Z"); return t}()),
// 		CreatedBy: to.Ptr("user@microsoft.com"),
// 		CreatedByType: to.Ptr(armkusto.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-07-01T17:16:24.364Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2@microsoft.com"),
// 		LastModifiedByType: to.Ptr(armkusto.CreatedByTypeUser),
// 	},
// }

Output:

func (*ScriptsClient) CheckNameAvailability 

func (client *ScriptsClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, scriptName ScriptCheckNameRequest, options *ScriptsClientCheckNameAvailabilityOptions) (ScriptsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the script name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • scriptName - The name of the script.
  • options - ScriptsClientCheckNameAvailabilityOptions contains the optional parameters for the ScriptsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoScriptsCheckNameAvailability.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewScriptsClient().CheckNameAvailability(ctx, "kustorptest", "kustoCluster", "db", armkusto.ScriptCheckNameRequest{
	Name: to.Ptr("kustoScriptName1"),
	Type: to.Ptr("Microsoft.Kusto/clusters/databases/scripts"),
}, 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 = armkusto.CheckNameResult{
// 	Name: to.Ptr("kustoScriptName1"),
// 	Message: to.Ptr("Name 'kustoScriptName1' is already taken. Please specify a different name"),
// 	NameAvailable: to.Ptr(false),
// }

Output:

func (*ScriptsClient) Get 

func (client *ScriptsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, scriptName string, options *ScriptsClientGetOptions) (ScriptsClientGetResponse, error)

Get - Gets a Kusto cluster database script. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • scriptName - The name of the Kusto database script.
  • options - ScriptsClientGetOptions contains the optional parameters for the ScriptsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoScriptsGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewScriptsClient().Get(ctx, "kustorptest", "kustoCluster", "Kustodatabase8", "kustoScript", 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.Script = armkusto.Script{
// 	Name: to.Ptr("kustoCluster/Kustodatabase8/kustoScript"),
// 	Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/Scripts"),
// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/Scripts/kustoScript"),
// 	Properties: &armkusto.ScriptProperties{
// 		ContinueOnErrors: to.Ptr(true),
// 		ForceUpdateTag: to.Ptr("2bcf3c21-ffd1-4444-b9dd-e52e00ee53fe"),
// 		ScriptURL: to.Ptr("https://mysa.blob.core.windows.net/container/script.txt"),
// 	},
// 	SystemData: &armkusto.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-29T15:06:54.275Z"); return t}()),
// 		CreatedBy: to.Ptr("user@microsoft.com"),
// 		CreatedByType: to.Ptr(armkusto.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-29T15:06:54.275Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user@microsoft.com"),
// 		LastModifiedByType: to.Ptr(armkusto.CreatedByTypeUser),
// 	},
// }

Output:

func (*ScriptsClient) NewListByDatabasePager 

func (client *ScriptsClient) NewListByDatabasePager(resourceGroupName string, clusterName string, databaseName string, options *ScriptsClientListByDatabaseOptions) *runtime.Pager[ScriptsClientListByDatabaseResponse]

NewListByDatabasePager - Returns the list of database scripts for given database.

Generated from API version 2023-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • clusterName - The name of the Kusto cluster.
  • databaseName - The name of the database in the Kusto cluster.
  • options - ScriptsClientListByDatabaseOptions contains the optional parameters for the ScriptsClient.NewListByDatabasePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ec0fcc278aa2128c4fbb2b8a1aa93432d72cce0/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2023-08-15/examples/KustoScriptsListByDatabase.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armkusto.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewScriptsClient().NewListByDatabasePager("kustorptest", "kustoCluster", "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.ScriptListResult = armkusto.ScriptListResult{
	// 	Value: []*armkusto.Script{
	// 		{
	// 			Name: to.Ptr("kustoCluster/Kustodatabase8/kustoScript1"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/Scripts"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/Scripts/kustoScript1"),
	// 			Properties: &armkusto.ScriptProperties{
	// 				ContinueOnErrors: to.Ptr(true),
	// 				ForceUpdateTag: to.Ptr("2bcf3c21-ffd1-4444-b9dd-e52e00ee53fe"),
	// 				ScriptURL: to.Ptr("https://mysa.blob.core.windows.net/container/script.txt"),
	// 			},
	// 			SystemData: &armkusto.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-29T15:06:54.275Z"); return t}()),
	// 				CreatedBy: to.Ptr("user@microsoft.com"),
	// 				CreatedByType: to.Ptr(armkusto.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-29T15:06:54.275Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user@microsoft.com"),
	// 				LastModifiedByType: to.Ptr(armkusto.CreatedByTypeUser),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("kustoCluster/Kustodatabase8/kustoScript2"),
	// 			Type: to.Ptr("Microsoft.Kusto/Clusters/Databases/Scripts"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/Scripts/kustoScript2"),
	// 			Properties: &armkusto.ScriptProperties{
	// 				ContinueOnErrors: to.Ptr(true),
	// 				ForceUpdateTag: to.Ptr("2bcf3c21-ffd1-4444-b9dd-e52e00ee53fe"),
	// 				ScriptURL: to.Ptr("https://mysa.blob.core.windows.net/container/script2.txt"),
	// 			},
	// 			SystemData: &armkusto.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-29T15:06:54.275Z"); return t}()),
	// 				CreatedBy: to.Ptr("user@microsoft.com"),
	// 				CreatedByType: to.Ptr(armkusto.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-30T16:07:55.283Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2@microsoft.com"),
	// 				LastModifiedByType: to.Ptr(armkusto.CreatedByTypeUser),
	// 			},
	// 	}},
	// }
}

Output:

type ScriptsClientBeginCreateOrUpdateOptions 

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

ScriptsClientBeginCreateOrUpdateOptions contains the optional parameters for the ScriptsClient.BeginCreateOrUpdate method.

type ScriptsClientBeginDeleteOptions 

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

ScriptsClientBeginDeleteOptions contains the optional parameters for the ScriptsClient.BeginDelete method.

type ScriptsClientBeginUpdateOptions 

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

ScriptsClientBeginUpdateOptions contains the optional parameters for the ScriptsClient.BeginUpdate method.

type ScriptsClientCheckNameAvailabilityOptions 

type ScriptsClientCheckNameAvailabilityOptions struct {
}

ScriptsClientCheckNameAvailabilityOptions contains the optional parameters for the ScriptsClient.CheckNameAvailability method.

type ScriptsClientCheckNameAvailabilityResponse 

type ScriptsClientCheckNameAvailabilityResponse struct {
	// The result returned from a check name availability request.
	CheckNameResult
}

ScriptsClientCheckNameAvailabilityResponse contains the response from method ScriptsClient.CheckNameAvailability.

type ScriptsClientCreateOrUpdateResponse 

type ScriptsClientCreateOrUpdateResponse struct {
	// Class representing a database script.
	Script
}

ScriptsClientCreateOrUpdateResponse contains the response from method ScriptsClient.BeginCreateOrUpdate.

type ScriptsClientDeleteResponse 

type ScriptsClientDeleteResponse struct {
}

ScriptsClientDeleteResponse contains the response from method ScriptsClient.BeginDelete.

type ScriptsClientGetOptions 

type ScriptsClientGetOptions struct {
}

ScriptsClientGetOptions contains the optional parameters for the ScriptsClient.Get method.

type ScriptsClientGetResponse 

type ScriptsClientGetResponse struct {
	// Class representing a database script.
	Script
}

ScriptsClientGetResponse contains the response from method ScriptsClient.Get.

type ScriptsClientListByDatabaseOptions 

type ScriptsClientListByDatabaseOptions struct {
}

ScriptsClientListByDatabaseOptions contains the optional parameters for the ScriptsClient.NewListByDatabasePager method.

type ScriptsClientListByDatabaseResponse 

type ScriptsClientListByDatabaseResponse struct {
	// The list Kusto database script operation response.
	ScriptListResult
}

ScriptsClientListByDatabaseResponse contains the response from method ScriptsClient.NewListByDatabasePager.

type ScriptsClientUpdateResponse 

type ScriptsClientUpdateResponse struct {
	// Class representing a database script.
	Script
}

ScriptsClientUpdateResponse contains the response from method ScriptsClient.BeginUpdate.

type State 

type State string

State - The state of the resource. 

const (
	StateCreating    State = "Creating"
	StateDeleted     State = "Deleted"
	StateDeleting    State = "Deleting"
	StateMigrated    State = "Migrated"
	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 Status 

type Status string

Status - The status of operation. 

const (
	StatusCanceled  Status = "Canceled"
	StatusFailed    Status = "Failed"
	StatusRunning   Status = "Running"
	StatusSucceeded Status = "Succeeded"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns the possible values for the Status const type.

type SuspensionDetails 

type SuspensionDetails struct {
	// The starting date and time of the suspension state.
	SuspensionStartDate *time.Time
}

SuspensionDetails - The database suspension details. If the database is suspended, this object contains information related to the database's suspension state.

func (SuspensionDetails) MarshalJSON 

func (s SuspensionDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SuspensionDetails.

func (*SuspensionDetails) UnmarshalJSON 

func (s *SuspensionDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SuspensionDetails.

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 to exclude from the follower database
	ExternalTablesToExclude []*string

	// List of external tables to include in the follower database
	ExternalTablesToInclude []*string

	// List of functions to exclude from the follower database
	FunctionsToExclude []*string

	// List of functions to include in the follower database
	FunctionsToInclude []*string

	// List of materialized views to 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 

func (t *TableLevelSharingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TableLevelSharingProperties.

type TrustedExternalTenant 

type TrustedExternalTenant struct {
	// GUID representing an external tenant.
	Value *string
}

TrustedExternalTenant - Represents a tenant ID that is trusted by the cluster.

func (TrustedExternalTenant) MarshalJSON 

func (t TrustedExternalTenant) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrustedExternalTenant.

func (*TrustedExternalTenant) UnmarshalJSON 

func (t *TrustedExternalTenant) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrustedExternalTenant.

type Type 

type Type string

Type - The type of resource, for instance Microsoft.Kusto/clusters/databases. 

const (
	TypeMicrosoftKustoClustersAttachedDatabaseConfigurations Type = "Microsoft.Kusto/clusters/attachedDatabaseConfigurations"
	TypeMicrosoftKustoClustersDatabases                      Type = "Microsoft.Kusto/clusters/databases"
)

func PossibleTypeValues 

func PossibleTypeValues() []Type

PossibleTypeValues returns the possible values for the Type const type.

type VirtualNetworkConfiguration 

type VirtualNetworkConfiguration struct {
	// REQUIRED; Data management's service public IP address resource id.
	DataManagementPublicIPID *string

	// REQUIRED; Engine service's public IP address resource id.
	EnginePublicIPID *string

	// REQUIRED; The subnet resource id.
	SubnetID *string

	// When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet.
	State *VnetState
}

VirtualNetworkConfiguration - A class that contains virtual network definition.

func (VirtualNetworkConfiguration) MarshalJSON 

func (v VirtualNetworkConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkConfiguration.

func (*VirtualNetworkConfiguration) UnmarshalJSON 

func (v *VirtualNetworkConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkConfiguration.

type VnetState added in v2.1.0 

type VnetState string

VnetState - When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet. 

const (
	VnetStateDisabled VnetState = "Disabled"
	VnetStateEnabled  VnetState = "Enabled"
)

func PossibleVnetStateValues added in v2.1.0 

func PossibleVnetStateValues() []VnetState

PossibleVnetStateValues returns the possible values for the VnetState const type.

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.