kusto

package
v56.1.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Aug 5, 2021 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package kusto implements the Azure ARM Kusto service API version 2018-09-07-preview.

The Azure Kusto management API provides a RESTful set of web services that interact with Azure Kusto services to manage your clusters and databases. The API enables you to create, update, and delete clusters and databases.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Kusto
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AzureCapacity

type AzureCapacity struct {
	// ScaleType - Scale type. Possible values include: 'Automatic', 'Manual', 'None'
	ScaleType AzureScaleType `json:"scaleType,omitempty"`
	// Minimum - Minimum allowed capacity.
	Minimum *int32 `json:"minimum,omitempty"`
	// Maximum - Maximum allowed capacity.
	Maximum *int32 `json:"maximum,omitempty"`
	// Default - The default capacity that would be used.
	Default *int32 `json:"default,omitempty"`
}

AzureCapacity ...

type AzureEntityResource

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

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

func (AzureEntityResource) MarshalJSON

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

MarshalJSON is the custom marshaler for AzureEntityResource.

type AzureResourceSku

type AzureResourceSku struct {
	// ResourceType - Resource Namespace and Type.
	ResourceType *string `json:"resourceType,omitempty"`
	// Sku - The SKU details.
	Sku *AzureSku `json:"sku,omitempty"`
	// Capacity - The SKU capacity.
	Capacity *AzureCapacity `json:"capacity,omitempty"`
}

AzureResourceSku ...

type AzureScaleType

type AzureScaleType string

AzureScaleType enumerates the values for azure scale type.

const (
	// Automatic ...
	Automatic AzureScaleType = "automatic"
	// Manual ...
	Manual AzureScaleType = "manual"
	// None ...
	None AzureScaleType = "none"
)

func PossibleAzureScaleTypeValues

func PossibleAzureScaleTypeValues() []AzureScaleType

PossibleAzureScaleTypeValues returns an array of possible values for the AzureScaleType const type.

type AzureSku

type AzureSku struct {
	// Name - SKU name. Possible values include: 'KC8', 'KC16', 'KS8', 'KS16', 'D13V2', 'D14V2', 'L8', 'L16'
	Name AzureSkuName `json:"name,omitempty"`
	// Capacity - SKU capacity.
	Capacity *int32 `json:"capacity,omitempty"`
	// Tier - SKU tier.
	Tier *string `json:"tier,omitempty"`
}

AzureSku ...

type AzureSkuName

type AzureSkuName string

AzureSkuName enumerates the values for azure sku name.

const (
	// D13V2 ...
	D13V2 AzureSkuName = "D13_v2"
	// D14V2 ...
	D14V2 AzureSkuName = "D14_v2"
	// KC16 ...
	KC16 AzureSkuName = "KC16"
	// KC8 ...
	KC8 AzureSkuName = "KC8"
	// KS16 ...
	KS16 AzureSkuName = "KS16"
	// KS8 ...
	KS8 AzureSkuName = "KS8"
	// L16 ...
	L16 AzureSkuName = "L16"
	// L8 ...
	L8 AzureSkuName = "L8"
)

func PossibleAzureSkuNameValues

func PossibleAzureSkuNameValues() []AzureSkuName

PossibleAzureSkuNameValues returns an array of possible values for the AzureSkuName const type.

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Kusto.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CheckNameResult

type CheckNameResult struct {
	autorest.Response `json:"-"`
	// NameAvailable - Specifies a Boolean value that indicates if the name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Name - The name that was checked.
	Name *string `json:"name,omitempty"`
	// Message - Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
	Message *string `json:"message,omitempty"`
}

CheckNameResult ...

type CloudError

type CloudError struct {
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError an error response from Kusto.

type CloudErrorBody

type CloudErrorBody struct {
	// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`
	// Message - A message describing the error, intended to be suitable for displaying in a user interface.
	Message *string `json:"message,omitempty"`
	// Target - The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
	// Details - A list of additional details about the error.
	Details *[]CloudErrorBody `json:"details,omitempty"`
}

CloudErrorBody an error response from Kusto.

type Cluster

type Cluster struct {
	autorest.Response `json:"-"`
	// Etag - READ-ONLY; An ETag of the resource created.
	Etag *string `json:"etag,omitempty"`
	// Sku - The SKU of the cluster.
	Sku                *AzureSku `json:"sku,omitempty"`
	*ClusterProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Cluster class representing a Kusto cluster.

func (Cluster) MarshalJSON

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

MarshalJSON is the custom marshaler for Cluster.

func (*Cluster) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaler for Cluster struct.

type ClusterCheckNameRequest

type ClusterCheckNameRequest struct {
	// Name - Cluster name.
	Name *string `json:"name,omitempty"`
	// Type - The type of resource, Microsoft.Kusto/clusters.
	Type *string `json:"type,omitempty"`
}

ClusterCheckNameRequest ...

type ClusterListResult

type ClusterListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of Kusto clusters.
	Value *[]Cluster `json:"value,omitempty"`
}

ClusterListResult the list Kusto clusters operation response.

type ClusterProperties

type ClusterProperties struct {
	// State - READ-ONLY; The state of the resource. Possible values include: 'StateCreating', 'StateUnavailable', 'StateRunning', 'StateDeleting', 'StateDeleted', 'StateStopping', 'StateStopped', 'StateStarting'
	State State `json:"state,omitempty"`
	// ProvisioningState - READ-ONLY; The provisioned state of the resource. Possible values include: 'Running', 'Creating', 'Deleting', 'Succeeded', 'Failed'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// URI - READ-ONLY; The cluster URI.
	URI *string `json:"uri,omitempty"`
	// DataIngestionURI - READ-ONLY; The cluster data ingestion URI.
	DataIngestionURI *string `json:"dataIngestionUri,omitempty"`
	// TrustedExternalTenants - The cluster's external tenants.
	TrustedExternalTenants *[]TrustedExternalTenant `json:"trustedExternalTenants,omitempty"`
}

ClusterProperties class representing the Kusto cluster properties.

func (ClusterProperties) MarshalJSON

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

MarshalJSON is the custom marshaler for ClusterProperties.

type ClusterUpdate

type ClusterUpdate struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Etag - READ-ONLY; An ETag of the resource updated.
	Etag *string `json:"etag,omitempty"`
	// Sku - The SKU of the cluster.
	Sku                *AzureSku `json:"sku,omitempty"`
	*ClusterProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ClusterUpdate class representing an update to a Kusto cluster.

func (ClusterUpdate) MarshalJSON

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

MarshalJSON is the custom marshaler for ClusterUpdate.

func (*ClusterUpdate) UnmarshalJSON

func (cu *ClusterUpdate) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ClusterUpdate struct.

type ClustersClient

type ClustersClient struct {
	BaseClient
}

ClustersClient is the the Azure Kusto management API provides a RESTful set of web services that interact with Azure Kusto services to manage your clusters and databases. The API enables you to create, update, and delete clusters and databases.

func NewClustersClient

func NewClustersClient(subscriptionID string) ClustersClient

NewClustersClient creates an instance of the ClustersClient client.

func NewClustersClientWithBaseURI

func NewClustersClientWithBaseURI(baseURI string, subscriptionID string) ClustersClient

NewClustersClientWithBaseURI creates an instance of the ClustersClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ClustersClient) CheckNameAvailability

func (client ClustersClient) CheckNameAvailability(ctx context.Context, location string, clusterName ClusterCheckNameRequest) (result CheckNameResult, err error)

CheckNameAvailability checks that the cluster name is valid and is not already in use. Parameters: location - azure location. clusterName - the name of the cluster.

func (ClustersClient) CheckNameAvailabilityPreparer

func (client ClustersClient) CheckNameAvailabilityPreparer(ctx context.Context, location string, clusterName ClusterCheckNameRequest) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (ClustersClient) CheckNameAvailabilityResponder

func (client ClustersClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameResult, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (ClustersClient) CheckNameAvailabilitySender

func (client ClustersClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) CreateOrUpdate

func (client ClustersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, parameters Cluster) (result ClustersCreateOrUpdateFuture, err error)

CreateOrUpdate create or update a Kusto cluster. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. parameters - the Kusto cluster parameters supplied to the CreateOrUpdate operation.

func (ClustersClient) CreateOrUpdatePreparer

func (client ClustersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters Cluster) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ClustersClient) CreateOrUpdateResponder

func (client ClustersClient) CreateOrUpdateResponder(resp *http.Response) (result Cluster, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ClustersClient) CreateOrUpdateSender

func (client ClustersClient) CreateOrUpdateSender(req *http.Request) (future ClustersCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) Delete

func (client ClustersClient) Delete(ctx context.Context, resourceGroupName string, clusterName string) (result ClustersDeleteFuture, err error)

Delete deletes a Kusto cluster. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster.

func (ClustersClient) DeletePreparer

func (client ClustersClient) DeletePreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ClustersClient) DeleteResponder

func (client ClustersClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ClustersClient) DeleteSender

func (client ClustersClient) DeleteSender(req *http.Request) (future ClustersDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) Get

func (client ClustersClient) Get(ctx context.Context, resourceGroupName string, clusterName string) (result Cluster, err error)

Get gets a Kusto cluster. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster.

func (ClustersClient) GetPreparer

func (client ClustersClient) GetPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ClustersClient) GetResponder

func (client ClustersClient) GetResponder(resp *http.Response) (result Cluster, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ClustersClient) GetSender

func (client ClustersClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) List

func (client ClustersClient) List(ctx context.Context) (result ClusterListResult, err error)

List lists all Kusto clusters within a subscription.

func (ClustersClient) ListByResourceGroup

func (client ClustersClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ClusterListResult, err error)

ListByResourceGroup lists all Kusto clusters within a resource group. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster.

func (ClustersClient) ListByResourceGroupPreparer

func (client ClustersClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ClustersClient) ListByResourceGroupResponder

func (client ClustersClient) ListByResourceGroupResponder(resp *http.Response) (result ClusterListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (ClustersClient) ListByResourceGroupSender

func (client ClustersClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) ListPreparer

func (client ClustersClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (ClustersClient) ListResponder

func (client ClustersClient) ListResponder(resp *http.Response) (result ClusterListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ClustersClient) ListSender

func (client ClustersClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) ListSkus

func (client ClustersClient) ListSkus(ctx context.Context) (result ListSkusResult, err error)

ListSkus lists eligible SKUs for Kusto resource provider.

func (ClustersClient) ListSkusByResource

func (client ClustersClient) ListSkusByResource(ctx context.Context, resourceGroupName string, clusterName string) (result ListResourceSkusResult, err error)

ListSkusByResource returns the SKUs available for the provided resource. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster.

func (ClustersClient) ListSkusByResourcePreparer

func (client ClustersClient) ListSkusByResourcePreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

ListSkusByResourcePreparer prepares the ListSkusByResource request.

func (ClustersClient) ListSkusByResourceResponder

func (client ClustersClient) ListSkusByResourceResponder(resp *http.Response) (result ListResourceSkusResult, err error)

ListSkusByResourceResponder handles the response to the ListSkusByResource request. The method always closes the http.Response Body.

func (ClustersClient) ListSkusByResourceSender

func (client ClustersClient) ListSkusByResourceSender(req *http.Request) (*http.Response, error)

ListSkusByResourceSender sends the ListSkusByResource request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) ListSkusPreparer

func (client ClustersClient) ListSkusPreparer(ctx context.Context) (*http.Request, error)

ListSkusPreparer prepares the ListSkus request.

func (ClustersClient) ListSkusResponder

func (client ClustersClient) ListSkusResponder(resp *http.Response) (result ListSkusResult, err error)

ListSkusResponder handles the response to the ListSkus request. The method always closes the http.Response Body.

func (ClustersClient) ListSkusSender

func (client ClustersClient) ListSkusSender(req *http.Request) (*http.Response, error)

ListSkusSender sends the ListSkus request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) Start

func (client ClustersClient) Start(ctx context.Context, resourceGroupName string, clusterName string) (result ClustersStartFuture, err error)

Start starts a Kusto cluster. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster.

func (ClustersClient) StartPreparer

func (client ClustersClient) StartPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

StartPreparer prepares the Start request.

func (ClustersClient) StartResponder

func (client ClustersClient) StartResponder(resp *http.Response) (result autorest.Response, err error)

StartResponder handles the response to the Start request. The method always closes the http.Response Body.

func (ClustersClient) StartSender

func (client ClustersClient) StartSender(req *http.Request) (future ClustersStartFuture, err error)

StartSender sends the Start request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) Stop

func (client ClustersClient) Stop(ctx context.Context, resourceGroupName string, clusterName string) (result ClustersStopFuture, err error)

Stop stops a Kusto cluster. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster.

func (ClustersClient) StopPreparer

func (client ClustersClient) StopPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

StopPreparer prepares the Stop request.

func (ClustersClient) StopResponder

func (client ClustersClient) StopResponder(resp *http.Response) (result autorest.Response, err error)

StopResponder handles the response to the Stop request. The method always closes the http.Response Body.

func (ClustersClient) StopSender

func (client ClustersClient) StopSender(req *http.Request) (future ClustersStopFuture, err error)

StopSender sends the Stop request. The method will close the http.Response Body if it receives an error.

func (ClustersClient) Update

func (client ClustersClient) Update(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterUpdate) (result ClustersUpdateFuture, err error)

Update update a Kusto cluster. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. parameters - the Kusto cluster parameters supplied to the Update operation.

func (ClustersClient) UpdatePreparer

func (client ClustersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterUpdate) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ClustersClient) UpdateResponder

func (client ClustersClient) UpdateResponder(resp *http.Response) (result Cluster, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ClustersClient) UpdateSender

func (client ClustersClient) UpdateSender(req *http.Request) (future ClustersUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type ClustersCreateOrUpdateFuture

type ClustersCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ClustersClient) (Cluster, error)
}

ClustersCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ClustersCreateOrUpdateFuture) UnmarshalJSON

func (future *ClustersCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ClustersDeleteFuture

type ClustersDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ClustersClient) (autorest.Response, error)
}

ClustersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ClustersDeleteFuture) UnmarshalJSON

func (future *ClustersDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ClustersStartFuture

type ClustersStartFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ClustersClient) (autorest.Response, error)
}

ClustersStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ClustersStartFuture) UnmarshalJSON

func (future *ClustersStartFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ClustersStopFuture

type ClustersStopFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ClustersClient) (autorest.Response, error)
}

ClustersStopFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ClustersStopFuture) UnmarshalJSON

func (future *ClustersStopFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ClustersUpdateFuture

type ClustersUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ClustersClient) (Cluster, error)
}

ClustersUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ClustersUpdateFuture) UnmarshalJSON

func (future *ClustersUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DataFormat

type DataFormat string

DataFormat enumerates the values for data format.

const (
	// CSV ...
	CSV DataFormat = "CSV"
	// JSON ...
	JSON DataFormat = "JSON"
	// MULTIJSON ...
	MULTIJSON DataFormat = "MULTIJSON"
)

func PossibleDataFormatValues

func PossibleDataFormatValues() []DataFormat

PossibleDataFormatValues returns an array of possible values for the DataFormat const type.

type Database

type Database struct {
	autorest.Response `json:"-"`
	// Etag - READ-ONLY; An ETag of the resource created.
	Etag                *string `json:"etag,omitempty"`
	*DatabaseProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Database class representing a Kusto database.

func (Database) MarshalJSON

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

MarshalJSON is the custom marshaler for Database.

func (*Database) UnmarshalJSON

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

UnmarshalJSON is the custom unmarshaler for Database struct.

type DatabaseCheckNameRequest

type DatabaseCheckNameRequest struct {
	// Name - Database name.
	Name *string `json:"name,omitempty"`
	// Type - The type of resource, Microsoft.Kusto/clusters/databases.
	Type *string `json:"type,omitempty"`
}

DatabaseCheckNameRequest ...

type DatabaseListResult

type DatabaseListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of Kusto databases.
	Value *[]Database `json:"value,omitempty"`
}

DatabaseListResult the list Kusto databases operation response.

type DatabasePrincipal

type DatabasePrincipal struct {
	// Role - Database principal role. Possible values include: 'Admin', 'Ingestor', 'Monitor', 'User', 'UnrestrictedViewers', 'Viewer'
	Role DatabasePrincipalRole `json:"role,omitempty"`
	// Name - Database principal name.
	Name *string `json:"name,omitempty"`
	// Type - Database principal type. Possible values include: 'DatabasePrincipalTypeApp', 'DatabasePrincipalTypeGroup', 'DatabasePrincipalTypeUser'
	Type DatabasePrincipalType `json:"type,omitempty"`
	// Fqn - Database principal fully qualified name.
	Fqn *string `json:"fqn,omitempty"`
	// Email - Database principal email if exists.
	Email *string `json:"email,omitempty"`
	// AppID - Application id - relevant only for application principal type.
	AppID *string `json:"appId,omitempty"`
}

DatabasePrincipal ...

type DatabasePrincipalListRequest

type DatabasePrincipalListRequest struct {
	// Value - The list of Kusto database principals.
	Value *[]DatabasePrincipal `json:"value,omitempty"`
}

DatabasePrincipalListRequest the list Kusto database principals operation request.

type DatabasePrincipalListResult

type DatabasePrincipalListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of Kusto database principals.
	Value *[]DatabasePrincipal `json:"value,omitempty"`
}

DatabasePrincipalListResult the list Kusto database principals operation response.

type DatabasePrincipalRole

type DatabasePrincipalRole string

DatabasePrincipalRole enumerates the values for database principal role.

const (
	// Admin ...
	Admin DatabasePrincipalRole = "Admin"
	// Ingestor ...
	Ingestor DatabasePrincipalRole = "Ingestor"
	// Monitor ...
	Monitor DatabasePrincipalRole = "Monitor"
	// UnrestrictedViewers ...
	UnrestrictedViewers DatabasePrincipalRole = "UnrestrictedViewers"
	// User ...
	User DatabasePrincipalRole = "User"
	// Viewer ...
	Viewer DatabasePrincipalRole = "Viewer"
)

func PossibleDatabasePrincipalRoleValues

func PossibleDatabasePrincipalRoleValues() []DatabasePrincipalRole

PossibleDatabasePrincipalRoleValues returns an array of possible values for the DatabasePrincipalRole const type.

type DatabasePrincipalType

type DatabasePrincipalType string

DatabasePrincipalType enumerates the values for database principal type.

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

func PossibleDatabasePrincipalTypeValues

func PossibleDatabasePrincipalTypeValues() []DatabasePrincipalType

PossibleDatabasePrincipalTypeValues returns an array of possible values for the DatabasePrincipalType const type.

type DatabaseProperties

type DatabaseProperties struct {
	// ProvisioningState - READ-ONLY; The provisioned state of the resource. Possible values include: 'Running', 'Creating', 'Deleting', 'Succeeded', 'Failed'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// SoftDeletePeriodInDays - The number of days data should be kept before it stops being accessible to queries.
	SoftDeletePeriodInDays *int32 `json:"softDeletePeriodInDays,omitempty"`
	// HotCachePeriodInDays - The number of days of data that should be kept in cache for fast queries.
	HotCachePeriodInDays *int32 `json:"hotCachePeriodInDays,omitempty"`
	// Statistics - The statistics of the database.
	Statistics *DatabaseStatistics `json:"statistics,omitempty"`
}

DatabaseProperties class representing the Kusto database properties.

func (DatabaseProperties) MarshalJSON

func (dp DatabaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DatabaseProperties.

type DatabaseStatistics

type DatabaseStatistics struct {
	// Size - The database size - the total size of compressed data and index in bytes.
	Size *float64 `json:"size,omitempty"`
}

DatabaseStatistics ...

type DatabaseUpdate

type DatabaseUpdate struct {
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Etag - READ-ONLY; An ETag of the resource updated.
	Etag                *string `json:"etag,omitempty"`
	*DatabaseProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

DatabaseUpdate class representing an update to a Kusto database.

func (DatabaseUpdate) MarshalJSON

func (du DatabaseUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DatabaseUpdate.

func (*DatabaseUpdate) UnmarshalJSON

func (du *DatabaseUpdate) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DatabaseUpdate struct.

type DatabasesClient

type DatabasesClient struct {
	BaseClient
}

DatabasesClient is the the Azure Kusto management API provides a RESTful set of web services that interact with Azure Kusto services to manage your clusters and databases. The API enables you to create, update, and delete clusters and databases.

func NewDatabasesClient

func NewDatabasesClient(subscriptionID string) DatabasesClient

NewDatabasesClient creates an instance of the DatabasesClient client.

func NewDatabasesClientWithBaseURI

func NewDatabasesClientWithBaseURI(baseURI string, subscriptionID string) DatabasesClient

NewDatabasesClientWithBaseURI creates an instance of the DatabasesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (DatabasesClient) AddPrincipals

func (client DatabasesClient) AddPrincipals(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, databasePrincipalsToAdd DatabasePrincipalListRequest) (result DatabasePrincipalListResult, err error)

AddPrincipals add Database principals permissions. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database in the Kusto cluster. databasePrincipalsToAdd - list of database principals to add.

func (DatabasesClient) AddPrincipalsPreparer

func (client DatabasesClient) AddPrincipalsPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, databasePrincipalsToAdd DatabasePrincipalListRequest) (*http.Request, error)

AddPrincipalsPreparer prepares the AddPrincipals request.

func (DatabasesClient) AddPrincipalsResponder

func (client DatabasesClient) AddPrincipalsResponder(resp *http.Response) (result DatabasePrincipalListResult, err error)

AddPrincipalsResponder handles the response to the AddPrincipals request. The method always closes the http.Response Body.

func (DatabasesClient) AddPrincipalsSender

func (client DatabasesClient) AddPrincipalsSender(req *http.Request) (*http.Response, error)

AddPrincipalsSender sends the AddPrincipals request. The method will close the http.Response Body if it receives an error.

func (DatabasesClient) CheckNameAvailability

func (client DatabasesClient) CheckNameAvailability(ctx context.Context, resourceGroupName string, clusterName string, databaseName DatabaseCheckNameRequest) (result CheckNameResult, err error)

CheckNameAvailability checks that the database name is valid and is not already in use. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database.

func (DatabasesClient) CheckNameAvailabilityPreparer

func (client DatabasesClient) CheckNameAvailabilityPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName DatabaseCheckNameRequest) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (DatabasesClient) CheckNameAvailabilityResponder

func (client DatabasesClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameResult, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (DatabasesClient) CheckNameAvailabilitySender

func (client DatabasesClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.

func (DatabasesClient) CreateOrUpdate

func (client DatabasesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters Database) (result DatabasesCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates a database. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. 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.

func (DatabasesClient) CreateOrUpdatePreparer

func (client DatabasesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters Database) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DatabasesClient) CreateOrUpdateResponder

func (client DatabasesClient) CreateOrUpdateResponder(resp *http.Response) (result Database, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (DatabasesClient) CreateOrUpdateSender

func (client DatabasesClient) CreateOrUpdateSender(req *http.Request) (future DatabasesCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (DatabasesClient) Delete

func (client DatabasesClient) Delete(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (result DatabasesDeleteFuture, err error)

Delete deletes the database with the given name. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database in the Kusto cluster.

func (DatabasesClient) DeletePreparer

func (client DatabasesClient) DeletePreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (DatabasesClient) DeleteResponder

func (client DatabasesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (DatabasesClient) DeleteSender

func (client DatabasesClient) DeleteSender(req *http.Request) (future DatabasesDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (DatabasesClient) Get

func (client DatabasesClient) Get(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (result Database, err error)

Get returns a database. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database in the Kusto cluster.

func (DatabasesClient) GetPreparer

func (client DatabasesClient) GetPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DatabasesClient) GetResponder

func (client DatabasesClient) GetResponder(resp *http.Response) (result Database, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (DatabasesClient) GetSender

func (client DatabasesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (DatabasesClient) ListByCluster

func (client DatabasesClient) ListByCluster(ctx context.Context, resourceGroupName string, clusterName string) (result DatabaseListResult, err error)

ListByCluster returns the list of databases of the given Kusto cluster. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster.

func (DatabasesClient) ListByClusterPreparer

func (client DatabasesClient) ListByClusterPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

ListByClusterPreparer prepares the ListByCluster request.

func (DatabasesClient) ListByClusterResponder

func (client DatabasesClient) ListByClusterResponder(resp *http.Response) (result DatabaseListResult, err error)

ListByClusterResponder handles the response to the ListByCluster request. The method always closes the http.Response Body.

func (DatabasesClient) ListByClusterSender

func (client DatabasesClient) ListByClusterSender(req *http.Request) (*http.Response, error)

ListByClusterSender sends the ListByCluster request. The method will close the http.Response Body if it receives an error.

func (DatabasesClient) ListPrincipals

func (client DatabasesClient) ListPrincipals(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (result DatabasePrincipalListResult, err error)

ListPrincipals returns a list of database principals of the given Kusto cluster and database. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database in the Kusto cluster.

func (DatabasesClient) ListPrincipalsPreparer

func (client DatabasesClient) ListPrincipalsPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (*http.Request, error)

ListPrincipalsPreparer prepares the ListPrincipals request.

func (DatabasesClient) ListPrincipalsResponder

func (client DatabasesClient) ListPrincipalsResponder(resp *http.Response) (result DatabasePrincipalListResult, err error)

ListPrincipalsResponder handles the response to the ListPrincipals request. The method always closes the http.Response Body.

func (DatabasesClient) ListPrincipalsSender

func (client DatabasesClient) ListPrincipalsSender(req *http.Request) (*http.Response, error)

ListPrincipalsSender sends the ListPrincipals request. The method will close the http.Response Body if it receives an error.

func (DatabasesClient) RemovePrincipals

func (client DatabasesClient) RemovePrincipals(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, databasePrincipalsToRemove DatabasePrincipalListRequest) (result DatabasePrincipalListResult, err error)

RemovePrincipals remove Database principals permissions. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database in the Kusto cluster. databasePrincipalsToRemove - list of database principals to remove.

func (DatabasesClient) RemovePrincipalsPreparer

func (client DatabasesClient) RemovePrincipalsPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, databasePrincipalsToRemove DatabasePrincipalListRequest) (*http.Request, error)

RemovePrincipalsPreparer prepares the RemovePrincipals request.

func (DatabasesClient) RemovePrincipalsResponder

func (client DatabasesClient) RemovePrincipalsResponder(resp *http.Response) (result DatabasePrincipalListResult, err error)

RemovePrincipalsResponder handles the response to the RemovePrincipals request. The method always closes the http.Response Body.

func (DatabasesClient) RemovePrincipalsSender

func (client DatabasesClient) RemovePrincipalsSender(req *http.Request) (*http.Response, error)

RemovePrincipalsSender sends the RemovePrincipals request. The method will close the http.Response Body if it receives an error.

func (DatabasesClient) Update

func (client DatabasesClient) Update(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters DatabaseUpdate) (result DatabasesUpdateFuture, err error)

Update updates a database. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. 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.

func (DatabasesClient) UpdatePreparer

func (client DatabasesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters DatabaseUpdate) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DatabasesClient) UpdateResponder

func (client DatabasesClient) UpdateResponder(resp *http.Response) (result Database, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (DatabasesClient) UpdateSender

func (client DatabasesClient) UpdateSender(req *http.Request) (future DatabasesUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type DatabasesCreateOrUpdateFuture

type DatabasesCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DatabasesClient) (Database, error)
}

DatabasesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DatabasesCreateOrUpdateFuture) UnmarshalJSON

func (future *DatabasesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DatabasesDeleteFuture

type DatabasesDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DatabasesClient) (autorest.Response, error)
}

DatabasesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DatabasesDeleteFuture) UnmarshalJSON

func (future *DatabasesDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DatabasesUpdateFuture

type DatabasesUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DatabasesClient) (Database, error)
}

DatabasesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DatabasesUpdateFuture) UnmarshalJSON

func (future *DatabasesUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type EventHubConnection

type EventHubConnection struct {
	autorest.Response `json:"-"`
	// Location - Resource location.
	Location                      *string `json:"location,omitempty"`
	*EventHubConnectionProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

EventHubConnection class representing an event hub connection.

func (EventHubConnection) MarshalJSON

func (ehc EventHubConnection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventHubConnection.

func (*EventHubConnection) UnmarshalJSON

func (ehc *EventHubConnection) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EventHubConnection struct.

type EventHubConnectionListResult

type EventHubConnectionListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of Kusto event hub connections.
	Value *[]EventHubConnection `json:"value,omitempty"`
}

EventHubConnectionListResult the list Kusto event hub connections operation response.

type EventHubConnectionProperties

type EventHubConnectionProperties struct {
	// EventHubResourceID - The resource ID of the event hub to be used to create a data connection.
	EventHubResourceID *string `json:"eventHubResourceId,omitempty"`
	// ConsumerGroup - The event hub consumer group.
	ConsumerGroup *string `json:"consumerGroup,omitempty"`
	// TableName - The table where the data should be ingested. Optionally the table information can be added to each message.
	TableName *string `json:"tableName,omitempty"`
	// MappingRuleName - The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
	MappingRuleName *string `json:"mappingRuleName,omitempty"`
	// DataFormat - The data format of the message. Optionally the data format can be added to each message. Possible values include: 'MULTIJSON', 'JSON', 'CSV'
	DataFormat DataFormat `json:"dataFormat,omitempty"`
}

EventHubConnectionProperties class representing the Kusto event hub connection properties.

type EventHubConnectionUpdate

type EventHubConnectionUpdate struct {
	// Location - Resource location.
	Location                      *string `json:"location,omitempty"`
	*EventHubConnectionProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

EventHubConnectionUpdate class representing an update to event hub connection.

func (EventHubConnectionUpdate) MarshalJSON

func (ehcu EventHubConnectionUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventHubConnectionUpdate.

func (*EventHubConnectionUpdate) UnmarshalJSON

func (ehcu *EventHubConnectionUpdate) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EventHubConnectionUpdate struct.

type EventHubConnectionValidation

type EventHubConnectionValidation struct {
	// EventhubConnectionName - The name of the event hub connection.
	EventhubConnectionName        *string `json:"eventhubConnectionName,omitempty"`
	*EventHubConnectionProperties `json:"properties,omitempty"`
}

EventHubConnectionValidation class representing an event hub connection validation.

func (EventHubConnectionValidation) MarshalJSON

func (ehcv EventHubConnectionValidation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventHubConnectionValidation.

func (*EventHubConnectionValidation) UnmarshalJSON

func (ehcv *EventHubConnectionValidation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EventHubConnectionValidation struct.

type EventHubConnectionValidationListResult

type EventHubConnectionValidationListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of Kusto event hub connection validation errors.
	Value *[]EventHubConnectionValidationResult `json:"value,omitempty"`
}

EventHubConnectionValidationListResult the list Kusto event hub connection validation result.

type EventHubConnectionValidationResult

type EventHubConnectionValidationResult struct {
	// ErrorMessage - A message which indicates a problem in event hub connection validation.
	ErrorMessage *string `json:"errorMessage,omitempty"`
}

EventHubConnectionValidationResult ...

type EventHubConnectionsClient

type EventHubConnectionsClient struct {
	BaseClient
}

EventHubConnectionsClient is the the Azure Kusto management API provides a RESTful set of web services that interact with Azure Kusto services to manage your clusters and databases. The API enables you to create, update, and delete clusters and databases.

func NewEventHubConnectionsClient

func NewEventHubConnectionsClient(subscriptionID string) EventHubConnectionsClient

NewEventHubConnectionsClient creates an instance of the EventHubConnectionsClient client.

func NewEventHubConnectionsClientWithBaseURI

func NewEventHubConnectionsClientWithBaseURI(baseURI string, subscriptionID string) EventHubConnectionsClient

NewEventHubConnectionsClientWithBaseURI creates an instance of the EventHubConnectionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (EventHubConnectionsClient) CreateOrUpdate

func (client EventHubConnectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, eventHubConnectionName string, parameters EventHubConnection) (result EventHubConnectionsCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates a Event Hub connection. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database in the Kusto cluster. eventHubConnectionName - the name of the event hub connection. parameters - the Event Hub connection parameters supplied to the CreateOrUpdate operation.

func (EventHubConnectionsClient) CreateOrUpdatePreparer

func (client EventHubConnectionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, eventHubConnectionName string, parameters EventHubConnection) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (EventHubConnectionsClient) CreateOrUpdateResponder

func (client EventHubConnectionsClient) CreateOrUpdateResponder(resp *http.Response) (result EventHubConnection, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (EventHubConnectionsClient) CreateOrUpdateSender

func (client EventHubConnectionsClient) CreateOrUpdateSender(req *http.Request) (future EventHubConnectionsCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (EventHubConnectionsClient) Delete

func (client EventHubConnectionsClient) Delete(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, eventHubConnectionName string) (result EventHubConnectionsDeleteFuture, err error)

Delete deletes the Event Hub connection with the given name. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database in the Kusto cluster. eventHubConnectionName - the name of the event hub connection.

func (EventHubConnectionsClient) DeletePreparer

func (client EventHubConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, eventHubConnectionName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (EventHubConnectionsClient) DeleteResponder

func (client EventHubConnectionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (EventHubConnectionsClient) DeleteSender

func (client EventHubConnectionsClient) DeleteSender(req *http.Request) (future EventHubConnectionsDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (EventHubConnectionsClient) EventhubConnectionValidation

func (client EventHubConnectionsClient) EventhubConnectionValidation(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters EventHubConnectionValidation) (result EventHubConnectionValidationListResult, err error)

EventhubConnectionValidation checks that the Event Hub data connection parameters are valid. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database in the Kusto cluster. parameters - the Event Hub connection parameters supplied to the CreateOrUpdate operation.

func (EventHubConnectionsClient) EventhubConnectionValidationPreparer

func (client EventHubConnectionsClient) EventhubConnectionValidationPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters EventHubConnectionValidation) (*http.Request, error)

EventhubConnectionValidationPreparer prepares the EventhubConnectionValidation request.

func (EventHubConnectionsClient) EventhubConnectionValidationResponder

func (client EventHubConnectionsClient) EventhubConnectionValidationResponder(resp *http.Response) (result EventHubConnectionValidationListResult, err error)

EventhubConnectionValidationResponder handles the response to the EventhubConnectionValidation request. The method always closes the http.Response Body.

func (EventHubConnectionsClient) EventhubConnectionValidationSender

func (client EventHubConnectionsClient) EventhubConnectionValidationSender(req *http.Request) (*http.Response, error)

EventhubConnectionValidationSender sends the EventhubConnectionValidation request. The method will close the http.Response Body if it receives an error.

func (EventHubConnectionsClient) Get

func (client EventHubConnectionsClient) Get(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, eventHubConnectionName string) (result EventHubConnection, err error)

Get returns an Event Hub connection. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database in the Kusto cluster. eventHubConnectionName - the name of the event hub connection.

func (EventHubConnectionsClient) GetPreparer

func (client EventHubConnectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, eventHubConnectionName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (EventHubConnectionsClient) GetResponder

func (client EventHubConnectionsClient) GetResponder(resp *http.Response) (result EventHubConnection, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (EventHubConnectionsClient) GetSender

func (client EventHubConnectionsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (EventHubConnectionsClient) ListByDatabase

func (client EventHubConnectionsClient) ListByDatabase(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (result EventHubConnectionListResult, err error)

ListByDatabase returns the list of Event Hub connections of the given Kusto database. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database in the Kusto cluster.

func (EventHubConnectionsClient) ListByDatabasePreparer

func (client EventHubConnectionsClient) ListByDatabasePreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (*http.Request, error)

ListByDatabasePreparer prepares the ListByDatabase request.

func (EventHubConnectionsClient) ListByDatabaseResponder

func (client EventHubConnectionsClient) ListByDatabaseResponder(resp *http.Response) (result EventHubConnectionListResult, err error)

ListByDatabaseResponder handles the response to the ListByDatabase request. The method always closes the http.Response Body.

func (EventHubConnectionsClient) ListByDatabaseSender

func (client EventHubConnectionsClient) ListByDatabaseSender(req *http.Request) (*http.Response, error)

ListByDatabaseSender sends the ListByDatabase request. The method will close the http.Response Body if it receives an error.

func (EventHubConnectionsClient) Update

func (client EventHubConnectionsClient) Update(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, eventHubConnectionName string, parameters EventHubConnectionUpdate) (result EventHubConnectionsUpdateFuture, err error)

Update updates a Event Hub connection. Parameters: resourceGroupName - the name of the resource group containing the Kusto cluster. clusterName - the name of the Kusto cluster. databaseName - the name of the database in the Kusto cluster. eventHubConnectionName - the name of the event hub connection. parameters - the Event Hub connection parameters supplied to the Update operation.

func (EventHubConnectionsClient) UpdatePreparer

func (client EventHubConnectionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, eventHubConnectionName string, parameters EventHubConnectionUpdate) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (EventHubConnectionsClient) UpdateResponder

func (client EventHubConnectionsClient) UpdateResponder(resp *http.Response) (result EventHubConnection, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (EventHubConnectionsClient) UpdateSender

func (client EventHubConnectionsClient) UpdateSender(req *http.Request) (future EventHubConnectionsUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type EventHubConnectionsCreateOrUpdateFuture

type EventHubConnectionsCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(EventHubConnectionsClient) (EventHubConnection, error)
}

EventHubConnectionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*EventHubConnectionsCreateOrUpdateFuture) UnmarshalJSON

func (future *EventHubConnectionsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type EventHubConnectionsDeleteFuture

type EventHubConnectionsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(EventHubConnectionsClient) (autorest.Response, error)
}

EventHubConnectionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*EventHubConnectionsDeleteFuture) UnmarshalJSON

func (future *EventHubConnectionsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type EventHubConnectionsUpdateFuture

type EventHubConnectionsUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(EventHubConnectionsClient) (EventHubConnection, error)
}

EventHubConnectionsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*EventHubConnectionsUpdateFuture) UnmarshalJSON

func (future *EventHubConnectionsUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ListResourceSkusResult

type ListResourceSkusResult struct {
	autorest.Response `json:"-"`
	// Value - The collection of available SKUs for an existing resource.
	Value *[]AzureResourceSku `json:"value,omitempty"`
}

ListResourceSkusResult list of available SKUs for an existing Kusto Cluster.

type ListSkusResult

type ListSkusResult struct {
	autorest.Response `json:"-"`
	// Value - The collection of available SKUs for new resources.
	Value *[]AzureSku `json:"value,omitempty"`
}

ListSkusResult list of available SKUs for a new Kusto Cluster.

type Operation

type Operation struct {
	// Name - This is of the format {provider}/{resource}/{operation}.
	Name       *string           `json:"name,omitempty"`
	Display    *OperationDisplay `json:"display,omitempty"`
	Origin     *string           `json:"origin,omitempty"`
	Properties interface{}       `json:"properties,omitempty"`
}

Operation ...

type OperationDisplay

type OperationDisplay struct {
	Provider *string `json:"provider,omitempty"`
	// Operation - For example: read, write, delete.
	Operation   *string `json:"operation,omitempty"`
	Resource    *string `json:"resource,omitempty"`
	Description *string `json:"description,omitempty"`
}

OperationDisplay ...

type OperationListResult

type OperationListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Operation `json:"value,omitempty"`
	NextLink          *string      `json:"nextLink,omitempty"`
}

OperationListResult ...

func (OperationListResult) IsEmpty

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone

func (iter OperationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListResultIterator) Response

Response returns the raw server response from the last page request.

func (OperationListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListResultPage

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListResultPage) NotDone

func (page OperationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListResultPage) Response

Response returns the raw server response from the last page request.

func (OperationListResultPage) Values

func (page OperationListResultPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the the Azure Kusto management API provides a RESTful set of web services that interact with Azure Kusto services to manage your clusters and databases. The API enables you to create, update, and delete clusters and databases.

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists available operations for the Microsoft.Kusto provider.

func (OperationsClient) ListComplete

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ProvisioningState

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
	// Creating ...
	Creating ProvisioningState = "Creating"
	// Deleting ...
	Deleting ProvisioningState = "Deleting"
	// Failed ...
	Failed ProvisioningState = "Failed"
	// Running ...
	Running ProvisioningState = "Running"
	// Succeeded ...
	Succeeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type ProxyResource

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type Resource

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type State

type State string

State enumerates the values for state.

const (
	// StateCreating ...
	StateCreating State = "Creating"
	// StateDeleted ...
	StateDeleted State = "Deleted"
	// StateDeleting ...
	StateDeleting State = "Deleting"
	// StateRunning ...
	StateRunning State = "Running"
	// StateStarting ...
	StateStarting State = "Starting"
	// StateStopped ...
	StateStopped State = "Stopped"
	// StateStopping ...
	StateStopping State = "Stopping"
	// StateUnavailable ...
	StateUnavailable State = "Unavailable"
)

func PossibleStateValues

func PossibleStateValues() []State

PossibleStateValues returns an array of possible values for the State const type.

type TrackedResource

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type TrustedExternalTenant

type TrustedExternalTenant struct {
	// Value - GUID representing an external tenant.
	Value *string `json:"value,omitempty"`
}

TrustedExternalTenant ...

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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