kqldashboard

package
v0.1.0-beta.5 Latest Latest
Warning

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

 Go to latest Published: Nov 13, 2024 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

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(credential azcore.TokenCredential, endpoint *string, options *azcore.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.

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

func NewClientFactoryWithClient 

func NewClientFactoryWithClient(client fabric.Client) *ClientFactory

NewClientFactoryWithClient creates a new instance of ClientFactory with sharable Client. The Client will be propagated to any client created from this factory.

  • client - Client created in the containing module: github.com/microsoft/fabric-sdk-go/fabric

func (*ClientFactory) NewItemsClient 

func (c *ClientFactory) NewItemsClient() *ItemsClient

NewItemsClient creates a new instance of ItemsClient.

type CreateKQLDashboardRequest 

type CreateKQLDashboardRequest struct {
	// REQUIRED; The KQL dashboard name. The display name must follow naming rules according to item type.
	DisplayName *string

	// The KQL dashboard public definition.
	Definition *Definition

	// The KQL dashboard description. Maximum length is 256 characters.
	Description *string
}

CreateKQLDashboardRequest - Create KQL dashboard request payload.

func (CreateKQLDashboardRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CreateKQLDashboardRequest.

func (*CreateKQLDashboardRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CreateKQLDashboardRequest.

type Definition 

type Definition struct {
	// REQUIRED; A list of definition parts.
	Parts []DefinitionPart

	// The format of the item definition.
	Format *string
}

Definition - KQL dashboard public definition object.

func (Definition) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Definition.

func (*Definition) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Definition.

type DefinitionPart 

type DefinitionPart struct {
	// REQUIRED; The KQL dashboard part path.
	Path *string

	// REQUIRED; The KQL dashboard part payload.
	Payload *string

	// REQUIRED; The payload type.
	PayloadType *PayloadType
}

DefinitionPart - KQL dashboard definition part object.

func (DefinitionPart) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DefinitionPart.

func (*DefinitionPart) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefinitionPart.

type DefinitionResponse 

type DefinitionResponse struct {
	// READ-ONLY; KQL dashboard public definition object.
	Definition *Definition
}

DefinitionResponse - KQL dashboard public definition response.

func (DefinitionResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DefinitionResponse.

func (*DefinitionResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefinitionResponse.

type ItemType 

type ItemType string

ItemType - The type of the item. Additional item types may be added over time. 

const (
	// ItemTypeDashboard - PowerBI dashboard.
	ItemTypeDashboard ItemType = "Dashboard"
	// ItemTypeDataPipeline - A data pipeline.
	ItemTypeDataPipeline ItemType = "DataPipeline"
	// ItemTypeDatamart - PowerBI datamart.
	ItemTypeDatamart ItemType = "Datamart"
	// ItemTypeEnvironment - An environment.
	ItemTypeEnvironment ItemType = "Environment"
	// ItemTypeEventhouse - An eventhouse.
	ItemTypeEventhouse ItemType = "Eventhouse"
	// ItemTypeEventstream - An eventstream.
	ItemTypeEventstream ItemType = "Eventstream"
	// ItemTypeKQLDashboard - A KQL dashboard.
	ItemTypeKQLDashboard ItemType = "KQLDashboard"
	// ItemTypeKQLDatabase - A KQL database.
	ItemTypeKQLDatabase ItemType = "KQLDatabase"
	// ItemTypeKQLQueryset - A KQL queryset.
	ItemTypeKQLQueryset ItemType = "KQLQueryset"
	// ItemTypeLakehouse - A lakehouse.
	ItemTypeLakehouse ItemType = "Lakehouse"
	// ItemTypeMLExperiment - A machine learning experiment.
	ItemTypeMLExperiment ItemType = "MLExperiment"
	// ItemTypeMLModel - A machine learning model.
	ItemTypeMLModel ItemType = "MLModel"
	// ItemTypeMirroredDatabase - A mirrored database.
	ItemTypeMirroredDatabase ItemType = "MirroredDatabase"
	// ItemTypeMirroredWarehouse - A mirrored warehouse.
	ItemTypeMirroredWarehouse ItemType = "MirroredWarehouse"
	// ItemTypeNotebook - A notebook.
	ItemTypeNotebook ItemType = "Notebook"
	// ItemTypePaginatedReport - PowerBI paginated report.
	ItemTypePaginatedReport ItemType = "PaginatedReport"
	// ItemTypeReport - PowerBI report.
	ItemTypeReport ItemType = "Report"
	// ItemTypeSQLEndpoint - An SQL endpoint.
	ItemTypeSQLEndpoint ItemType = "SQLEndpoint"
	// ItemTypeSemanticModel - PowerBI semantic model.
	ItemTypeSemanticModel ItemType = "SemanticModel"
	// ItemTypeSparkJobDefinition - A spark job definition.
	ItemTypeSparkJobDefinition ItemType = "SparkJobDefinition"
	// ItemTypeWarehouse - A warehouse.
	ItemTypeWarehouse ItemType = "Warehouse"
)

func PossibleItemTypeValues 

func PossibleItemTypeValues() []ItemType

PossibleItemTypeValues returns the possible values for the ItemType const type.

type ItemsClient 

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

ItemsClient contains the methods for the Items group. Don't use this type directly, use a constructor function instead.

func (*ItemsClient) CreateKQLDashboard 

func (client *ItemsClient) CreateKQLDashboard(ctx context.Context, workspaceID string, createKQLDashboardRequest CreateKQLDashboardRequest, options *ItemsClientCreateKQLDashboardOptions) (ItemsClientCreateKQLDashboardResponse, error)

CreateKQLDashboard - To create a KQL dashboard with definition, refer to the KQL dashboard definition article [/rest/api/fabric/articles/item-management/definitions/kql-dashboard-definition]. PERMISSIONS The caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES KQLDashboard.ReadWrite.All or Item.ReadWrite.All MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] | Yes | | Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE If the operation fails it returns an *core.ResponseError type.

Generated from API version v1

  • workspaceID - The workspace ID.
  • createKQLDashboardRequest - Create KQL dashboard definition request payload.
  • options - ItemsClientCreateKQLDashboardOptions contains the optional parameters for the ItemsClient.CreateKQLDashboard method.
Example (CreateAKqlDashboardExample)

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/kqldashboard"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := kqldashboard.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewItemsClient().CreateKQLDashboard(ctx, "cfafbeb1-8037-4d0c-896e-a46fb27ff229", kqldashboard.CreateKQLDashboardRequest{
		Description: to.Ptr("A KQL dashboard description"),
		DisplayName: to.Ptr("KQLDashboard_1"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:
Example (CreateAKqlDashboardExampleWithDefinition)

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/kqldashboard"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := kqldashboard.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewItemsClient().CreateKQLDashboard(ctx, "cfafbeb1-8037-4d0c-896e-a46fb27ff229", kqldashboard.CreateKQLDashboardRequest{
		Description: to.Ptr("A KQL dashboard description"),
		Definition: &kqldashboard.Definition{
			Parts: []kqldashboard.DefinitionPart{
				{
					Path:        to.Ptr("RealTimeDashboard.json"),
					Payload:     to.Ptr("ewogICJhdXRvUmVmcmVzaCI6IHsKICAgICJlbmFibGVkIjogZmFsc2UKICB9LAogICJiYXNlUXVlcmllcyI6IFtdLAogICJ0aWxlcyI6IFtdLAogICJkYXRhU291cmNlcyI6IFtdLAogICJwYWdlcyI6IFsKICAgIHsKICAgICAgIm5hbWUiOiAiUGFnZSAxIiwKICAgICAgImlkIjogImFiNWYwNjI4LTk3NTAtNDNlNi05YmE0LTIwMTE2ZTg2ODc1NSIKICAgIH0KICBdLAogICJwYXJhbWV0ZXJzIjogWwogICAgewogICAgICAia2luZCI6ICJkdXJhdGlvbiIsCiAgICAgICJpZCI6ICJmNTEwYjlmZi0xZjI3LTQ4YmQtODBlNC1mZDFhNTllODQ5MjQiLAogICAgICAiZGlzcGxheU5hbWUiOiAiVGltZSByYW5nZSIsCiAgICAgICJkZXNjcmlwdGlvbiI6ICIiLAogICAgICAiYmVnaW5WYXJpYWJsZU5hbWUiOiAiX3N0YXJ0VGltZSIsCiAgICAgICJlbmRWYXJpYWJsZU5hbWUiOiAiX2VuZFRpbWUiLAogICAgICAiZGVmYXVsdFZhbHVlIjogewogICAgICAgICJraW5kIjogImR5bmFtaWMiLAogICAgICAgICJjb3VudCI6IDEsCiAgICAgICAgInVuaXQiOiAiaG91cnMiCiAgICAgIH0sCiAgICAgICJzaG93T25QYWdlcyI6IHsKICAgICAgICAia2luZCI6ICJhbGwiCiAgICAgIH0KICAgIH0KICBdLAogICJxdWVyaWVzIjogW10sCiAgInNjaGVtYV92ZXJzaW9uIjogIjUyIiwKICAidGl0bGUiOiAidmNkem5ncnpzbSIKfQ=="),
					PayloadType: to.Ptr(kqldashboard.PayloadTypeInlineBase64),
				},
				{
					Path:        to.Ptr(".platform"),
					Payload:     to.Ptr("ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc="),
					PayloadType: to.Ptr(kqldashboard.PayloadTypeInlineBase64),
				}},
		},
		DisplayName: to.Ptr("KQL Dashboard 1"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ItemsClient) DeleteKQLDashboard 

func (client *ItemsClient) DeleteKQLDashboard(ctx context.Context, workspaceID string, kqlDashboardID string, options *ItemsClientDeleteKQLDashboardOptions) (ItemsClientDeleteKQLDashboardResponse, error)

DeleteKQLDashboard - PERMISSIONS The caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES KQLDashboard.ReadWrite.All or Item.ReadWrite.All MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] | Yes | | Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE If the operation fails it returns an *core.ResponseError type.

Generated from API version v1

  • workspaceID - The workspace ID.
  • kqlDashboardID - The KQL dashboard ID.
  • options - ItemsClientDeleteKQLDashboardOptions contains the optional parameters for the ItemsClient.DeleteKQLDashboard method.
Example

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/kqldashboard"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := kqldashboard.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewItemsClient().DeleteKQLDashboard(ctx, "cfafbeb1-8037-4d0c-896e-a46fb27ff229", "5b218778-e7a5-4d73-8187-f10824047715", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*ItemsClient) GetKQLDashboard 

func (client *ItemsClient) GetKQLDashboard(ctx context.Context, workspaceID string, kqlDashboardID string, options *ItemsClientGetKQLDashboardOptions) (ItemsClientGetKQLDashboardResponse, error)

GetKQLDashboard - PERMISSIONS The caller must have viewer or higher workspace role. REQUIRED DELEGATED SCOPES KQLDashboard.Read.All or KQLDashboard.ReadWrite.All or Item.Read.All or Item.ReadWrite.All MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] | Yes | | Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE If the operation fails it returns an *core.ResponseError type.

Generated from API version v1

  • workspaceID - The workspace ID.
  • kqlDashboardID - The KQL dashboard ID.
  • options - ItemsClientGetKQLDashboardOptions contains the optional parameters for the ItemsClient.GetKQLDashboard method.
Example

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/kqldashboard"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := kqldashboard.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewItemsClient().GetKQLDashboard(ctx, "cfafbeb1-8037-4d0c-896e-a46fb27ff229", "5b218778-e7a5-4d73-8187-f10824047715", 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.KQLDashboard = kqldashboard.KQLDashboard{
	// 	Type: to.Ptr(kqldashboard.ItemTypeKQLDashboard),
	// 	Description: to.Ptr("A KQL dashboard description."),
	// 	DisplayName: to.Ptr("KQLDashboard_1"),
	// 	ID: to.Ptr("5b218778-e7a5-4d73-8187-f10824047715"),
	// 	WorkspaceID: to.Ptr("cfafbeb1-8037-4d0c-896e-a46fb27ff229"),
	// }
}

Output:

func (*ItemsClient) GetKQLDashboardDefinition 

func (client *ItemsClient) GetKQLDashboardDefinition(ctx context.Context, workspaceID string, kqlDashboardID string, options *ItemsClientGetKQLDashboardDefinitionOptions) (ItemsClientGetKQLDashboardDefinitionResponse, error)

GetKQLDashboardDefinition - PERMISSIONS The caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES KQLDashboard.ReadWrite.All or Item.ReadWrite.All MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] | Yes | | Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE If the operation fails it returns an *core.ResponseError type.

Generated from API version v1

  • workspaceID - The workspace ID.
  • kqlDashboardID - The KQL dashboard ID.
  • options - ItemsClientGetKQLDashboardDefinitionOptions contains the optional parameters for the ItemsClient.GetKQLDashboardDefinition method.
Example

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/kqldashboard"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := kqldashboard.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewItemsClient().GetKQLDashboardDefinition(ctx, "6e335e92-a2a2-4b5a-970a-bd6a89fbb765", "cfafbeb1-8037-4d0c-896e-a46fb27ff229", &kqldashboard.ItemsClientGetKQLDashboardDefinitionOptions{Format: 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.DefinitionResponse = kqldashboard.DefinitionResponse{
	// 	Definition: &kqldashboard.Definition{
	// 		Parts: []kqldashboard.DefinitionPart{
	// 			{
	// 				Path: to.Ptr("RealTimeDashboard.json"),
	// 				Payload: to.Ptr("ewogICJhdXRvUmVmcmVzaCI6IHsKICAgICJlbmFibGVkIjogZmFsc2UKICB9LAogICJiYXNlUXVlcmllcyI6IFtdLAogICJ0aWxlcyI6IFtdLAogICJkYXRhU291cmNlcyI6IFtdLAogICJwYWdlcyI6IFsKICAgIHsKICAgICAgIm5hbWUiOiAiUGFnZSAxIiwKICAgICAgImlkIjogImFiNWYwNjI4LTk3NTAtNDNlNi05YmE0LTIwMTE2ZTg2ODc1NSIKICAgIH0KICBdLAogICJwYXJhbWV0ZXJzIjogWwogICAgewogICAgICAia2luZCI6ICJkdXJhdGlvbiIsCiAgICAgICJpZCI6ICJmNTEwYjlmZi0xZjI3LTQ4YmQtODBlNC1mZDFhNTllODQ5MjQiLAogICAgICAiZGlzcGxheU5hbWUiOiAiVGltZSByYW5nZSIsCiAgICAgICJkZXNjcmlwdGlvbiI6ICIiLAogICAgICAiYmVnaW5WYXJpYWJsZU5hbWUiOiAiX3N0YXJ0VGltZSIsCiAgICAgICJlbmRWYXJpYWJsZU5hbWUiOiAiX2VuZFRpbWUiLAogICAgICAiZGVmYXVsdFZhbHVlIjogewogICAgICAgICJraW5kIjogImR5bmFtaWMiLAogICAgICAgICJjb3VudCI6IDEsCiAgICAgICAgInVuaXQiOiAiaG91cnMiCiAgICAgIH0sCiAgICAgICJzaG93T25QYWdlcyI6IHsKICAgICAgICAia2luZCI6ICJhbGwiCiAgICAgIH0KICAgIH0KICBdLAogICJxdWVyaWVzIjogW10sCiAgInNjaGVtYV92ZXJzaW9uIjogIjUyIiwKICAidGl0bGUiOiAidmNkem5ncnpzbSIKfQ=="),
	// 				PayloadType: to.Ptr(kqldashboard.PayloadTypeInlineBase64),
	// 			},
	// 			{
	// 				Path: to.Ptr(".platform"),
	// 				Payload: to.Ptr("ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIktRTERhc2hib2FyZCIsCiAgICAiZGlzcGxheU5hbWUiOiAidmNkem5ncnpzbSIsCiAgICAiZGVzY3JpcHRpb24iOiAidmNkem5ncnpzbSIKICB9LAogICJjb25maWciOiB7CiAgICAidmVyc2lvbiI6ICIyLjAiLAogICAgImxvZ2ljYWxJZCI6ICIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiCiAgfQp9"),
	// 				PayloadType: to.Ptr(kqldashboard.PayloadTypeInlineBase64),
	// 		}},
	// 	},
	// }
}

Output:

func (*ItemsClient) ListKQLDashboards 

func (client *ItemsClient) ListKQLDashboards(ctx context.Context, workspaceID string, options *ItemsClientListKQLDashboardsOptions) ([]KQLDashboard, error)

ListKQLDashboards - returns array of KQLDashboard from all pages. This API supports pagination [/rest/api/fabric/articles/pagination].

PERMISSIONS The caller must have viewer or higher workspace role.

REQUIRED DELEGATED SCOPES Workspace.Read.All or Workspace.ReadWrite.All

MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section.

| Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] | Yes | | Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes |

INTERFACE Generated from API version v1

  • workspaceID - The workspace ID.
  • options - ItemsClientListKQLDashboardsOptions contains the optional parameters for the ItemsClient.NewListKQLDashboardsPager method.

func (*ItemsClient) NewListKQLDashboardsPager 

func (client *ItemsClient) NewListKQLDashboardsPager(workspaceID string, options *ItemsClientListKQLDashboardsOptions) *runtime.Pager[ItemsClientListKQLDashboardsResponse]

NewListKQLDashboardsPager - This API supports pagination [/rest/api/fabric/articles/pagination]. PERMISSIONS The caller must have viewer or higher workspace role. REQUIRED DELEGATED SCOPES Workspace.Read.All or Workspace.ReadWrite.All MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] | Yes | | Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE

Generated from API version v1

  • workspaceID - The workspace ID.
  • options - ItemsClientListKQLDashboardsOptions contains the optional parameters for the ItemsClient.NewListKQLDashboardsPager method.
Example

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/kqldashboard"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := kqldashboard.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewItemsClient().NewListKQLDashboardsPager("cfafbeb1-8037-4d0c-896e-a46fb27ff229", &kqldashboard.ItemsClientListKQLDashboardsOptions{ContinuationToken: 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.KQLDashboards = kqldashboard.KQLDashboards{
		// 	Value: []kqldashboard.KQLDashboard{
		// 		{
		// 			Type: to.Ptr(kqldashboard.ItemTypeKQLDashboard),
		// 			Description: to.Ptr("A KQL dashboard description."),
		// 			DisplayName: to.Ptr("KQLDashboard_1"),
		// 			ID: to.Ptr("3546052c-ae64-4526-b1a8-52af7761426f"),
		// 			WorkspaceID: to.Ptr("cfafbeb1-8037-4d0c-896e-a46fb27ff229"),
		// 		},
		// 		{
		// 			Type: to.Ptr(kqldashboard.ItemTypeKQLDashboard),
		// 			Description: to.Ptr("A KQL dashboard description."),
		// 			DisplayName: to.Ptr("KQLDashboard_2"),
		// 			ID: to.Ptr("340d91b9-5a39-409c-b9c0-05ba832c476e"),
		// 			WorkspaceID: to.Ptr("cfafbeb1-8037-4d0c-896e-a46fb27ff229"),
		// 	}},
		// }
	}
}

Output:

func (*ItemsClient) UpdateKQLDashboard 

func (client *ItemsClient) UpdateKQLDashboard(ctx context.Context, workspaceID string, kqlDashboardID string, updateKQLDashboardRequest UpdateKQLDashboardRequest, options *ItemsClientUpdateKQLDashboardOptions) (ItemsClientUpdateKQLDashboardResponse, error)

UpdateKQLDashboard - PERMISSIONS The caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES KQLDashboard.ReadWrite.All or Item.ReadWrite.All MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] | Yes | | Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE If the operation fails it returns an *core.ResponseError type.

Generated from API version v1

  • workspaceID - The workspace ID.
  • kqlDashboardID - The KQL dashboard ID.
  • updateKQLDashboardRequest - Update KQL dashboard request payload.
  • options - ItemsClientUpdateKQLDashboardOptions contains the optional parameters for the ItemsClient.UpdateKQLDashboard method.
Example

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/kqldashboard"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := kqldashboard.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewItemsClient().UpdateKQLDashboard(ctx, "cfafbeb1-8037-4d0c-896e-a46fb27ff229", "5b218778-e7a5-4d73-8187-f10824047715", kqldashboard.UpdateKQLDashboardRequest{
		Description: to.Ptr("KQL dashboard new description"),
		DisplayName: to.Ptr("KQL dashboard new name"),
	}, 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.KQLDashboard = kqldashboard.KQLDashboard{
	// 	Type: to.Ptr(kqldashboard.ItemTypeKQLDashboard),
	// 	Description: to.Ptr("KQL dashboard new description"),
	// 	DisplayName: to.Ptr("KQL dashboard new name"),
	// 	ID: to.Ptr("5b218778-e7a5-4d73-8187-f10824047715"),
	// 	WorkspaceID: to.Ptr("cfafbeb1-8037-4d0c-896e-a46fb27ff229"),
	// }
}

Output:

func (*ItemsClient) UpdateKQLDashboardDefinition 

func (client *ItemsClient) UpdateKQLDashboardDefinition(ctx context.Context, workspaceID string, kqlDashboardID string, updateKQLDashboardDefinitionRequest UpdateKQLDashboardDefinitionRequest, options *ItemsClientUpdateKQLDashboardDefinitionOptions) (ItemsClientUpdateKQLDashboardDefinitionResponse, error)

UpdateKQLDashboardDefinition - PERMISSIONS The caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES KQLDashboard.ReadWrite.All or Item.ReadWrite.All MICROSOFT ENTRA SUPPORTED IDENTITIES This API supports the Microsoft identities [/rest/api/fabric/articles/identity-support] listed in this section. | Identity | Support | |-|-| | User | Yes | | Service principal [/entra/identity-platform/app-objects-and-service-principals#service-principal-object] | Yes | | Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE If the operation fails it returns an *core.ResponseError type.

Generated from API version v1

  • workspaceID - The workspace ID.
  • kqlDashboardID - The KQL dashboard ID.
  • updateKQLDashboardDefinitionRequest - Update KQL dashboard definition request payload.
  • options - ItemsClientUpdateKQLDashboardDefinitionOptions contains the optional parameters for the ItemsClient.UpdateKQLDashboardDefinition method.
Example

Generated from example definition 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"

	"github.com/microsoft/fabric-sdk-go/fabric/kqldashboard"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := kqldashboard.NewClientFactory(cred, nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewItemsClient().UpdateKQLDashboardDefinition(ctx, "cfafbeb1-8037-4d0c-896e-a46fb27ff229", "5b218778-e7a5-4d73-8187-f10824047715", kqldashboard.UpdateKQLDashboardDefinitionRequest{
		Definition: &kqldashboard.Definition{
			Parts: []kqldashboard.DefinitionPart{
				{
					Path:        to.Ptr("RealTimeDashboard.json"),
					Payload:     to.Ptr("ewogICJhdXRvUmVmcmVzaCI6IHsKICAgICJlbmFibGVkIjogZmFsc2UKICB9LAogICJiYXNlUXVlcmllcyI6IFtdLAogICJ0aWxlcyI6IFtdLAogICJkYXRhU291cmNlcyI6IFtdLAogICJwYWdlcyI6IFsKICAgIHsKICAgICAgIm5hbWUiOiAiUGFnZSAxIiwKICAgICAgImlkIjogImFiNWYwNjI4LTk3NTAtNDNlNi05YmE0LTIwMTE2ZTg2ODc1NSIKICAgIH0KICBdLAogICJwYXJhbWV0ZXJzIjogWwogICAgewogICAgICAia2luZCI6ICJkdXJhdGlvbiIsCiAgICAgICJpZCI6ICJmNTEwYjlmZi0xZjI3LTQ4YmQtODBlNC1mZDFhNTllODQ5MjQiLAogICAgICAiZGlzcGxheU5hbWUiOiAiVGltZSByYW5nZSIsCiAgICAgICJkZXNjcmlwdGlvbiI6ICIiLAogICAgICAiYmVnaW5WYXJpYWJsZU5hbWUiOiAiX3N0YXJ0VGltZSIsCiAgICAgICJlbmRWYXJpYWJsZU5hbWUiOiAiX2VuZFRpbWUiLAogICAgICAiZGVmYXVsdFZhbHVlIjogewogICAgICAgICJraW5kIjogImR5bmFtaWMiLAogICAgICAgICJjb3VudCI6IDEsCiAgICAgICAgInVuaXQiOiAiaG91cnMiCiAgICAgIH0sCiAgICAgICJzaG93T25QYWdlcyI6IHsKICAgICAgICAia2luZCI6ICJhbGwiCiAgICAgIH0KICAgIH0KICBdLAogICJxdWVyaWVzIjogW10sCiAgInNjaGVtYV92ZXJzaW9uIjogIjUyIiwKICAidGl0bGUiOiAidmNkem5ncnpzbSIKfQ=="),
					PayloadType: to.Ptr(kqldashboard.PayloadTypeInlineBase64),
				},
				{
					Path:        to.Ptr(".platform"),
					Payload:     to.Ptr("ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc="),
					PayloadType: to.Ptr(kqldashboard.PayloadTypeInlineBase64),
				}},
		},
	}, &kqldashboard.ItemsClientUpdateKQLDashboardDefinitionOptions{UpdateMetadata: to.Ptr(true)})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

type ItemsClientCreateKQLDashboardOptions 

type ItemsClientCreateKQLDashboardOptions struct {
}

ItemsClientCreateKQLDashboardOptions contains the optional parameters for the ItemsClient.CreateKQLDashboard method.

type ItemsClientCreateKQLDashboardResponse 

type ItemsClientCreateKQLDashboardResponse struct {
	// A KQL dashboard object.
	KQLDashboard

	// Location contains the information returned from the Location header response.
	Location *string
}

ItemsClientCreateKQLDashboardResponse contains the response from method ItemsClient.CreateKQLDashboard.

type ItemsClientDeleteKQLDashboardOptions 

type ItemsClientDeleteKQLDashboardOptions struct {
}

ItemsClientDeleteKQLDashboardOptions contains the optional parameters for the ItemsClient.DeleteKQLDashboard method.

type ItemsClientDeleteKQLDashboardResponse 

type ItemsClientDeleteKQLDashboardResponse struct {
}

ItemsClientDeleteKQLDashboardResponse contains the response from method ItemsClient.DeleteKQLDashboard.

type ItemsClientGetKQLDashboardDefinitionOptions 

type ItemsClientGetKQLDashboardDefinitionOptions struct {
	// The format of the KQL dashboard public definition.
	Format *string
}

ItemsClientGetKQLDashboardDefinitionOptions contains the optional parameters for the ItemsClient.GetKQLDashboardDefinition method.

type ItemsClientGetKQLDashboardDefinitionResponse 

type ItemsClientGetKQLDashboardDefinitionResponse struct {
	// KQL dashboard public definition response.
	DefinitionResponse
}

ItemsClientGetKQLDashboardDefinitionResponse contains the response from method ItemsClient.GetKQLDashboardDefinition.

type ItemsClientGetKQLDashboardOptions 

type ItemsClientGetKQLDashboardOptions struct {
}

ItemsClientGetKQLDashboardOptions contains the optional parameters for the ItemsClient.GetKQLDashboard method.

type ItemsClientGetKQLDashboardResponse 

type ItemsClientGetKQLDashboardResponse struct {
	// A KQL dashboard object.
	KQLDashboard
}

ItemsClientGetKQLDashboardResponse contains the response from method ItemsClient.GetKQLDashboard.

type ItemsClientListKQLDashboardsOptions 

type ItemsClientListKQLDashboardsOptions struct {
	// A token for retrieving the next page of results.
	ContinuationToken *string
}

ItemsClientListKQLDashboardsOptions contains the optional parameters for the ItemsClient.NewListKQLDashboardsPager method.

type ItemsClientListKQLDashboardsResponse 

type ItemsClientListKQLDashboardsResponse struct {
	// A list of KQL dashboards.
	KQLDashboards
}

ItemsClientListKQLDashboardsResponse contains the response from method ItemsClient.NewListKQLDashboardsPager.

type ItemsClientUpdateKQLDashboardDefinitionOptions 

type ItemsClientUpdateKQLDashboardDefinitionOptions struct {
	// When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the
	// metadata in the .platform file
	UpdateMetadata *bool
}

ItemsClientUpdateKQLDashboardDefinitionOptions contains the optional parameters for the ItemsClient.UpdateKQLDashboardDefinition method.

type ItemsClientUpdateKQLDashboardDefinitionResponse 

type ItemsClientUpdateKQLDashboardDefinitionResponse struct {
}

ItemsClientUpdateKQLDashboardDefinitionResponse contains the response from method ItemsClient.UpdateKQLDashboardDefinition.

type ItemsClientUpdateKQLDashboardOptions 

type ItemsClientUpdateKQLDashboardOptions struct {
}

ItemsClientUpdateKQLDashboardOptions contains the optional parameters for the ItemsClient.UpdateKQLDashboard method.

type ItemsClientUpdateKQLDashboardResponse 

type ItemsClientUpdateKQLDashboardResponse struct {
	// A KQL dashboard object.
	KQLDashboard
}

ItemsClientUpdateKQLDashboardResponse contains the response from method ItemsClient.UpdateKQLDashboard.

type KQLDashboard 

type KQLDashboard struct {
	// REQUIRED; The item type.
	Type *ItemType

	// The item description.
	Description *string

	// The item display name.
	DisplayName *string

	// READ-ONLY; The item ID.
	ID *string

	// READ-ONLY; The workspace ID.
	WorkspaceID *string
}

KQLDashboard - A KQL dashboard object.

func (KQLDashboard) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KQLDashboard.

func (*KQLDashboard) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KQLDashboard.

type KQLDashboards 

type KQLDashboards struct {
	// REQUIRED; A list of KQL dashboards.
	Value []KQLDashboard

	// The token for the next result set batch. If there are no more records, it's removed from the response.
	ContinuationToken *string

	// The URI of the next result set batch. If there are no more records, it's removed from the response.
	ContinuationURI *string
}

KQLDashboards - A list of KQL dashboards.

func (KQLDashboards) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KQLDashboards.

func (*KQLDashboards) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KQLDashboards.

type PayloadType 

type PayloadType string

PayloadType - The type of the definition part payload. Additional payload types may be added over time. 

const (
	// PayloadTypeInlineBase64 - Inline Base 64.
	PayloadTypeInlineBase64 PayloadType = "InlineBase64"
)

func PossiblePayloadTypeValues 

func PossiblePayloadTypeValues() []PayloadType

PossiblePayloadTypeValues returns the possible values for the PayloadType const type.

type UpdateKQLDashboardDefinitionRequest 

type UpdateKQLDashboardDefinitionRequest struct {
	// REQUIRED; KQL dashboard public definition object.
	Definition *Definition
}

UpdateKQLDashboardDefinitionRequest - Update KQL dashboard public definition request payload.

func (UpdateKQLDashboardDefinitionRequest) MarshalJSON 

func (u UpdateKQLDashboardDefinitionRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateKQLDashboardDefinitionRequest.

func (*UpdateKQLDashboardDefinitionRequest) UnmarshalJSON 

func (u *UpdateKQLDashboardDefinitionRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateKQLDashboardDefinitionRequest.

type UpdateKQLDashboardRequest 

type UpdateKQLDashboardRequest struct {
	// The KQL dashboard description. Maximum length is 256 characters.
	Description *string

	// The KQL dashboard display name. The display name must follow naming rules according to item type.
	DisplayName *string
}

UpdateKQLDashboardRequest - Update KQL dashboard request.

func (UpdateKQLDashboardRequest) MarshalJSON 

func (u UpdateKQLDashboardRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateKQLDashboardRequest.

func (*UpdateKQLDashboardRequest) UnmarshalJSON 

func (u *UpdateKQLDashboardRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateKQLDashboardRequest.

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.