mirroreddatabase

package
v0.1.0-beta.11 Latest Latest
Warning

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

 Go to latest Published: Jan 30, 2025 License: MIT Imports: 16 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.

func (*ClientFactory) NewMirroringClient 

func (c *ClientFactory) NewMirroringClient() *MirroringClient

NewMirroringClient creates a new instance of MirroringClient.

type CreateMirroredDatabaseRequest 

type CreateMirroredDatabaseRequest struct {
	// REQUIRED; The mirrored database public definition.
	Definition *Definition

	// REQUIRED; The mirrored database display name. The display name must follow naming rules according to item type.
	DisplayName *string

	// The mirrored database description. Maximum length is 256 characters.
	Description *string
}

CreateMirroredDatabaseRequest - Create mirrored database request payload.

func (CreateMirroredDatabaseRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CreateMirroredDatabaseRequest.

func (*CreateMirroredDatabaseRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CreateMirroredDatabaseRequest.

type Definition 

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

Definition - Mirrored database 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 {
	// The mirrored database part path.
	Path *string

	// The mirrored database part payload.
	Payload *string

	// The payload type.
	PayloadType *PayloadType
}

DefinitionPart - Mirrored database 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; Mirrored database public definition object.
	Definition *Definition
}

DefinitionResponse - Mirrored database 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 ErrorRelatedResource 

type ErrorRelatedResource struct {
	// READ-ONLY; The resource ID that's involved in the error.
	ResourceID *string

	// READ-ONLY; The type of the resource that's involved in the error.
	ResourceType *string
}

ErrorRelatedResource - The error related resource details object.

func (ErrorRelatedResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorRelatedResource.

func (*ErrorRelatedResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorRelatedResource.

type ErrorResponse 

type ErrorResponse struct {
	// READ-ONLY; A specific identifier that provides information about an error condition, allowing for standardized communication
	// between our service and its users.
	ErrorCode *string

	// READ-ONLY; A human readable representation of the error.
	Message *string

	// READ-ONLY; List of additional error details.
	MoreDetails []ErrorResponseDetails

	// READ-ONLY; The error related resource details.
	RelatedResource *ErrorRelatedResource

	// READ-ONLY; ID of the request associated with the error.
	RequestID *string
}

ErrorResponse - The error response.

func (ErrorResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type ErrorResponseDetails 

type ErrorResponseDetails struct {
	// READ-ONLY; A specific identifier that provides information about an error condition, allowing for standardized communication
	// between our service and its users.
	ErrorCode *string

	// READ-ONLY; A human readable representation of the error.
	Message *string

	// READ-ONLY; The error related resource details.
	RelatedResource *ErrorRelatedResource
}

ErrorResponseDetails - The error response details.

func (ErrorResponseDetails) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponseDetails.

func (*ErrorResponseDetails) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponseDetails.

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"
	// ItemTypeGraphQLAPI - An API for GraphQL item.
	ItemTypeGraphQLAPI ItemType = "GraphQLApi"
	// 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"
	// ItemTypeReflex - A Reflex.
	ItemTypeReflex ItemType = "Reflex"
	// 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) CreateMirroredDatabase 

func (client *ItemsClient) CreateMirroredDatabase(ctx context.Context, workspaceID string, createMirroredDatabaseRequest CreateMirroredDatabaseRequest, options *ItemsClientCreateMirroredDatabaseOptions) (ItemsClientCreateMirroredDatabaseResponse, error)

CreateMirroredDatabase - This API does not support creating a mirrored database without a definition. To create Mirrored database with definition, refer to Mirrored database definition [/rest/api/fabric/articles/item-management/definitions/mirrored-database-definition] article. PERMISSIONS The caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES MirroredDatabase.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] and 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.
  • createMirroredDatabaseRequest - Create item request payload.
  • options - ItemsClientCreateMirroredDatabaseOptions contains the optional parameters for the ItemsClient.CreateMirroredDatabase method.
Example

Generated from example definition 

Output:

func (*ItemsClient) DeleteMirroredDatabase 

func (client *ItemsClient) DeleteMirroredDatabase(ctx context.Context, workspaceID string, mirroredDatabaseID string, options *ItemsClientDeleteMirroredDatabaseOptions) (ItemsClientDeleteMirroredDatabaseResponse, error)

DeleteMirroredDatabase - PERMISSIONS The caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES MirroredDatabase.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] and 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.
  • mirroredDatabaseID - The mirrored database ID.
  • options - ItemsClientDeleteMirroredDatabaseOptions contains the optional parameters for the ItemsClient.DeleteMirroredDatabase method.
Example

Generated from example definition 

Output:

func (*ItemsClient) GetMirroredDatabase 

func (client *ItemsClient) GetMirroredDatabase(ctx context.Context, workspaceID string, mirroredDatabaseID string, options *ItemsClientGetMirroredDatabaseOptions) (ItemsClientGetMirroredDatabaseResponse, error)

GetMirroredDatabase - PERMISSIONS The caller must have viewer or higher workspace role. REQUIRED DELEGATED SCOPES MirroredDatabase.Read.All or MirroredDatabase.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] and 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.
  • mirroredDatabaseID - The mirrored database ID.
  • options - ItemsClientGetMirroredDatabaseOptions contains the optional parameters for the ItemsClient.GetMirroredDatabase method.
Example

Generated from example definition 

Output:

func (*ItemsClient) GetMirroredDatabaseDefinition 

func (client *ItemsClient) GetMirroredDatabaseDefinition(ctx context.Context, workspaceID string, mirroredDatabaseID string, options *ItemsClientGetMirroredDatabaseDefinitionOptions) (ItemsClientGetMirroredDatabaseDefinitionResponse, error)

GetMirroredDatabaseDefinition - PERMISSIONS The caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES MirroredDatabase.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] and 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.
  • mirroredDatabaseID - The mirrored database ID.
  • options - ItemsClientGetMirroredDatabaseDefinitionOptions contains the optional parameters for the ItemsClient.GetMirroredDatabaseDefinition method.
Example

Generated from example definition 

Output:

func (*ItemsClient) ListMirroredDatabases 

func (client *ItemsClient) ListMirroredDatabases(ctx context.Context, workspaceID string, options *ItemsClientListMirroredDatabasesOptions) ([]MirroredDatabase, error)

ListMirroredDatabases - returns array of MirroredDatabase 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] and Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes |

INTERFACE Generated from API version v1

  • workspaceID - The workspace ID.
  • options - ItemsClientListMirroredDatabasesOptions contains the optional parameters for the ItemsClient.NewListMirroredDatabasesPager method.

func (*ItemsClient) NewListMirroredDatabasesPager 

func (client *ItemsClient) NewListMirroredDatabasesPager(workspaceID string, options *ItemsClientListMirroredDatabasesOptions) *runtime.Pager[ItemsClientListMirroredDatabasesResponse]

NewListMirroredDatabasesPager - 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] and Managed identities [/entra/identity/managed-identities-azure-resources/overview] | Yes | INTERFACE

Generated from API version v1

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

Generated from example definition 

Output:

func (*ItemsClient) UpdateMirroredDatabase 

func (client *ItemsClient) UpdateMirroredDatabase(ctx context.Context, workspaceID string, mirroredDatabaseID string, updateMirroredDatabaseRequest UpdateMirroredDatabaseRequest, options *ItemsClientUpdateMirroredDatabaseOptions) (ItemsClientUpdateMirroredDatabaseResponse, error)

UpdateMirroredDatabase - PERMISSIONS The caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES MirroredDatabase.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] and 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.
  • mirroredDatabaseID - The mirrored database ID.
  • updateMirroredDatabaseRequest - Update mirrored database request payload.
  • options - ItemsClientUpdateMirroredDatabaseOptions contains the optional parameters for the ItemsClient.UpdateMirroredDatabase method.
Example

Generated from example definition 

Output:

func (*ItemsClient) UpdateMirroredDatabaseDefinition 

func (client *ItemsClient) UpdateMirroredDatabaseDefinition(ctx context.Context, workspaceID string, mirroredDatabaseID string, updateMirroredDatabaseDefinitionRequest UpdateMirroredDatabaseDefinitionRequest, options *ItemsClientUpdateMirroredDatabaseDefinitionOptions) (ItemsClientUpdateMirroredDatabaseDefinitionResponse, error)

UpdateMirroredDatabaseDefinition - PERMISSIONS The API caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES MirroredDatabase.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] and 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.
  • mirroredDatabaseID - The mirrored database ID.
  • updateMirroredDatabaseDefinitionRequest - Update mirrored database definition request payload.
  • options - ItemsClientUpdateMirroredDatabaseDefinitionOptions contains the optional parameters for the ItemsClient.UpdateMirroredDatabaseDefinition method.
Example

Generated from example definition 

Output:

type ItemsClientCreateMirroredDatabaseOptions 

type ItemsClientCreateMirroredDatabaseOptions struct {
}

ItemsClientCreateMirroredDatabaseOptions contains the optional parameters for the ItemsClient.CreateMirroredDatabase method.

type ItemsClientCreateMirroredDatabaseResponse 

type ItemsClientCreateMirroredDatabaseResponse struct {
	// A mirrored database item.
	MirroredDatabase
}

ItemsClientCreateMirroredDatabaseResponse contains the response from method ItemsClient.CreateMirroredDatabase.

type ItemsClientDeleteMirroredDatabaseOptions 

type ItemsClientDeleteMirroredDatabaseOptions struct {
}

ItemsClientDeleteMirroredDatabaseOptions contains the optional parameters for the ItemsClient.DeleteMirroredDatabase method.

type ItemsClientDeleteMirroredDatabaseResponse 

type ItemsClientDeleteMirroredDatabaseResponse struct {
}

ItemsClientDeleteMirroredDatabaseResponse contains the response from method ItemsClient.DeleteMirroredDatabase.

type ItemsClientGetMirroredDatabaseDefinitionOptions 

type ItemsClientGetMirroredDatabaseDefinitionOptions struct {
}

ItemsClientGetMirroredDatabaseDefinitionOptions contains the optional parameters for the ItemsClient.GetMirroredDatabaseDefinition method.

type ItemsClientGetMirroredDatabaseDefinitionResponse 

type ItemsClientGetMirroredDatabaseDefinitionResponse struct {
	// Mirrored database public definition response.
	DefinitionResponse
}

ItemsClientGetMirroredDatabaseDefinitionResponse contains the response from method ItemsClient.GetMirroredDatabaseDefinition.

type ItemsClientGetMirroredDatabaseOptions 

type ItemsClientGetMirroredDatabaseOptions struct {
}

ItemsClientGetMirroredDatabaseOptions contains the optional parameters for the ItemsClient.GetMirroredDatabase method.

type ItemsClientGetMirroredDatabaseResponse 

type ItemsClientGetMirroredDatabaseResponse struct {
	// A mirrored database item.
	MirroredDatabase
}

ItemsClientGetMirroredDatabaseResponse contains the response from method ItemsClient.GetMirroredDatabase.

type ItemsClientListMirroredDatabasesOptions 

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

ItemsClientListMirroredDatabasesOptions contains the optional parameters for the ItemsClient.NewListMirroredDatabasesPager method.

type ItemsClientListMirroredDatabasesResponse 

type ItemsClientListMirroredDatabasesResponse struct {
	// A list of mirrored databases.
	MirroredDatabases
}

ItemsClientListMirroredDatabasesResponse contains the response from method ItemsClient.NewListMirroredDatabasesPager.

type ItemsClientUpdateMirroredDatabaseDefinitionOptions 

type ItemsClientUpdateMirroredDatabaseDefinitionOptions struct {
}

ItemsClientUpdateMirroredDatabaseDefinitionOptions contains the optional parameters for the ItemsClient.UpdateMirroredDatabaseDefinition method.

type ItemsClientUpdateMirroredDatabaseDefinitionResponse 

type ItemsClientUpdateMirroredDatabaseDefinitionResponse struct {
}

ItemsClientUpdateMirroredDatabaseDefinitionResponse contains the response from method ItemsClient.UpdateMirroredDatabaseDefinition.

type ItemsClientUpdateMirroredDatabaseOptions 

type ItemsClientUpdateMirroredDatabaseOptions struct {
}

ItemsClientUpdateMirroredDatabaseOptions contains the optional parameters for the ItemsClient.UpdateMirroredDatabase method.

type ItemsClientUpdateMirroredDatabaseResponse 

type ItemsClientUpdateMirroredDatabaseResponse struct {
	// A mirrored database item.
	MirroredDatabase
}

ItemsClientUpdateMirroredDatabaseResponse contains the response from method ItemsClient.UpdateMirroredDatabase.

type MirroredDatabase 

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

	// The item description.
	Description *string

	// The item display name.
	DisplayName *string

	// The mirrored database properties.
	Properties *Properties

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

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

MirroredDatabase - A mirrored database item.

func (MirroredDatabase) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type MirroredDatabase.

func (*MirroredDatabase) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type MirroredDatabase.

type MirroredDatabases 

type MirroredDatabases struct {
	// REQUIRED; A list of mirrored databases.
	Value []MirroredDatabase

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

MirroredDatabases - A list of mirrored databases.

func (MirroredDatabases) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type MirroredDatabases.

func (*MirroredDatabases) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type MirroredDatabases.

type MirroringClient 

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

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

func (*MirroringClient) GetMirroringStatus 

func (client *MirroringClient) GetMirroringStatus(ctx context.Context, workspaceID string, mirroredDatabaseID string, options *MirroringClientGetMirroringStatusOptions) (MirroringClientGetMirroringStatusResponse, error)

GetMirroringStatus - PERMISSIONS The caller must have viewer or higher workspace role. REQUIRED DELEGATED SCOPES MirroredDatabase.Read.All or MirroredDatabase.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] and 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.
  • mirroredDatabaseID - The mirrored database ID.
  • options - MirroringClientGetMirroringStatusOptions contains the optional parameters for the MirroringClient.GetMirroringStatus method.
Example

Generated from example definition 

Output:

func (*MirroringClient) GetTablesMirroringStatus 

func (client *MirroringClient) GetTablesMirroringStatus(ctx context.Context, workspaceID string, mirroredDatabaseID string, options *MirroringClientGetTablesMirroringStatusOptions) (MirroringClientGetTablesMirroringStatusResponse, error)

GetTablesMirroringStatus - his API supports pagination [/rest/api/fabric/articles/pagination]. PERMISSIONS The caller must have viewer or higher workspace role. REQUIRED DELEGATED SCOPES MirroredDatabase.Read.All or MirroredDatabase.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] and 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.
  • mirroredDatabaseID - The mirrored database ID.
  • options - MirroringClientGetTablesMirroringStatusOptions contains the optional parameters for the MirroringClient.GetTablesMirroringStatus method.
Example

Generated from example definition 

Output:

func (*MirroringClient) StartMirroring 

func (client *MirroringClient) StartMirroring(ctx context.Context, workspaceID string, mirroredDatabaseID string, options *MirroringClientStartMirroringOptions) (MirroringClientStartMirroringResponse, error)

StartMirroring - PERMISSIONS The API caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES MirroredDatabase.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] and 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.
  • mirroredDatabaseID - The mirrored database ID.
  • options - MirroringClientStartMirroringOptions contains the optional parameters for the MirroringClient.StartMirroring method.
Example

Generated from example definition 

Output:

func (*MirroringClient) StopMirroring 

func (client *MirroringClient) StopMirroring(ctx context.Context, workspaceID string, mirroredDatabaseID string, options *MirroringClientStopMirroringOptions) (MirroringClientStopMirroringResponse, error)

StopMirroring - PERMISSIONS The API caller must have contributor or higher workspace role. REQUIRED DELEGATED SCOPES MirroredDatabase.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] and 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.
  • mirroredDatabaseID - The mirrored database ID.
  • options - MirroringClientStopMirroringOptions contains the optional parameters for the MirroringClient.StopMirroring method.
Example

Generated from example definition 

Output:

type MirroringClientGetMirroringStatusOptions 

type MirroringClientGetMirroringStatusOptions struct {
}

MirroringClientGetMirroringStatusOptions contains the optional parameters for the MirroringClient.GetMirroringStatus method.

type MirroringClientGetMirroringStatusResponse 

type MirroringClientGetMirroringStatusResponse struct {
	// Response of getting mirroring status.
	MirroringStatusResponse
}

MirroringClientGetMirroringStatusResponse contains the response from method MirroringClient.GetMirroringStatus.

type MirroringClientGetTablesMirroringStatusOptions 

type MirroringClientGetTablesMirroringStatusOptions struct {
}

MirroringClientGetTablesMirroringStatusOptions contains the optional parameters for the MirroringClient.GetTablesMirroringStatus method.

type MirroringClientGetTablesMirroringStatusResponse 

type MirroringClientGetTablesMirroringStatusResponse struct {
	// A paginated list of table mirroring statuses.
	TablesMirroringStatusResponse
}

MirroringClientGetTablesMirroringStatusResponse contains the response from method MirroringClient.GetTablesMirroringStatus.

type MirroringClientStartMirroringOptions 

type MirroringClientStartMirroringOptions struct {
}

MirroringClientStartMirroringOptions contains the optional parameters for the MirroringClient.StartMirroring method.

type MirroringClientStartMirroringResponse 

type MirroringClientStartMirroringResponse struct {
}

MirroringClientStartMirroringResponse contains the response from method MirroringClient.StartMirroring.

type MirroringClientStopMirroringOptions 

type MirroringClientStopMirroringOptions struct {
}

MirroringClientStopMirroringOptions contains the optional parameters for the MirroringClient.StopMirroring method.

type MirroringClientStopMirroringResponse 

type MirroringClientStopMirroringResponse struct {
}

MirroringClientStopMirroringResponse contains the response from method MirroringClient.StopMirroring.

type MirroringStatus 

type MirroringStatus string

MirroringStatus - The mirroring status type. Additional MirroringStatus types may be added over time. 

const (
	// MirroringStatusInitialized - The associated SQL endpoint provisioning is succeeded and the mirrored database is ready for
	// start.
	MirroringStatusInitialized MirroringStatus = "Initialized"
	// MirroringStatusInitializing - The associated SQL endpoint provisioning is in progress.
	MirroringStatusInitializing MirroringStatus = "Initializing"
	// MirroringStatusRunning - The mirroring instance for the mirrored database is running.
	MirroringStatusRunning MirroringStatus = "Running"
	// MirroringStatusStarting - The mirroring instance for the mirrored database is starting.
	MirroringStatusStarting MirroringStatus = "Starting"
	// MirroringStatusStopped - The mirroring instance for the mirrored database is stopped.
	MirroringStatusStopped MirroringStatus = "Stopped"
	// MirroringStatusStopping - The mirroring instance for the mirrored database is stopping.
	MirroringStatusStopping MirroringStatus = "Stopping"
)

func PossibleMirroringStatusValues 

func PossibleMirroringStatusValues() []MirroringStatus

PossibleMirroringStatusValues returns the possible values for the MirroringStatus const type.

type MirroringStatusResponse 

type MirroringStatusResponse struct {
	// REQUIRED; The status of mirroring
	Status *MirroringStatus

	// READ-ONLY; Error is set if error happens in mirroring
	Error *ErrorResponse
}

MirroringStatusResponse - Response of getting mirroring status.

func (MirroringStatusResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type MirroringStatusResponse.

func (*MirroringStatusResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type MirroringStatusResponse.

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 Properties 

type Properties struct {
	// Default schema of the mirrored database. This property is returned only for mirrored database that enables default schema
	// in definition.
	DefaultSchema *string

	// OneLake path to the mirrored database tables directory.
	OneLakeTablesPath *string

	// An object containing the properties of the SQL endpoint.
	SQLEndpointProperties *SQLEndpointProperties
}

Properties - The mirrored database properties.

func (Properties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Properties.

func (*Properties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Properties.

type SQLEndpointProperties 

type SQLEndpointProperties struct {
	// REQUIRED; The SQL endpoint provisioning status.
	ProvisioningStatus *SQLEndpointProvisioningStatus

	// SQL endpoint connection string.
	ConnectionString *string

	// SQL endpoint ID.
	ID *string
}

SQLEndpointProperties - An object containing the properties of the SQL endpoint.

func (SQLEndpointProperties) MarshalJSON 

func (s SQLEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SQLEndpointProperties.

func (*SQLEndpointProperties) UnmarshalJSON 

func (s *SQLEndpointProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLEndpointProperties.

type SQLEndpointProvisioningStatus 

type SQLEndpointProvisioningStatus string

SQLEndpointProvisioningStatus - The SQL endpoint provisioning status type. Additional SqlEndpointProvisioningStatus types may be added over time. 

const (
	// SQLEndpointProvisioningStatusFailed - SQL endpoint provisioning failed.
	SQLEndpointProvisioningStatusFailed SQLEndpointProvisioningStatus = "Failed"
	// SQLEndpointProvisioningStatusInProgress - SQL endpoint provisioning is in progress.
	SQLEndpointProvisioningStatusInProgress SQLEndpointProvisioningStatus = "InProgress"
	// SQLEndpointProvisioningStatusSuccess - SQL endpoint provisioning succeeded.
	SQLEndpointProvisioningStatusSuccess SQLEndpointProvisioningStatus = "Success"
)

func PossibleSQLEndpointProvisioningStatusValues 

func PossibleSQLEndpointProvisioningStatusValues() []SQLEndpointProvisioningStatus

PossibleSQLEndpointProvisioningStatusValues returns the possible values for the SQLEndpointProvisioningStatus const type.

type TableMirroringMetrics 

type TableMirroringMetrics struct {
	// REQUIRED; Last processed time of the table in in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
	LastSyncDateTime *time.Time

	// REQUIRED; Processed bytes for this table.
	ProcessedBytes *int64

	// REQUIRED; Processed row count for this table.
	ProcessedRows *int64
}

TableMirroringMetrics - Table mirroring metrics.

func (TableMirroringMetrics) MarshalJSON 

func (t TableMirroringMetrics) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TableMirroringMetrics.

func (*TableMirroringMetrics) UnmarshalJSON 

func (t *TableMirroringMetrics) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TableMirroringMetrics.

type TableMirroringStatus 

type TableMirroringStatus string

TableMirroringStatus - The table mirroring status type. Additional TableMirroringStatus types may be added over time. 

const (
	// TableMirroringStatusFailed - Mirroing of the table failed with error.
	TableMirroringStatusFailed TableMirroringStatus = "Failed"
	// TableMirroringStatusInitialized - Mirroing of the table is initialized.
	TableMirroringStatusInitialized TableMirroringStatus = "Initialized"
	// TableMirroringStatusReplicating - The table is replicating.
	TableMirroringStatusReplicating TableMirroringStatus = "Replicating"
	// TableMirroringStatusReseeding - The table is reseeding.
	TableMirroringStatusReseeding TableMirroringStatus = "Reseeding"
	// TableMirroringStatusSnapshotting - The table is snapshotting.
	TableMirroringStatusSnapshotting TableMirroringStatus = "Snapshotting"
	// TableMirroringStatusStopped - Mirroring of the table is stopped.
	TableMirroringStatusStopped TableMirroringStatus = "Stopped"
)

func PossibleTableMirroringStatusValues 

func PossibleTableMirroringStatusValues() []TableMirroringStatus

PossibleTableMirroringStatusValues returns the possible values for the TableMirroringStatus const type.

type TableMirroringStatusResponse 

type TableMirroringStatusResponse struct {
	// REQUIRED; The mirroring status type of table.
	Status *TableMirroringStatus

	// The mirroring metrics of table.
	Metrics *TableMirroringMetrics

	// Source table schema name.
	SourceSchemaName *string

	// Source table name.
	SourceTableName *string

	// READ-ONLY; Table level error is set if error happens in mirroring for this table
	Error *ErrorResponse
}

TableMirroringStatusResponse - Table mirroring status response.

func (TableMirroringStatusResponse) MarshalJSON 

func (t TableMirroringStatusResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TableMirroringStatusResponse.

func (*TableMirroringStatusResponse) UnmarshalJSON 

func (t *TableMirroringStatusResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TableMirroringStatusResponse.

type TablesMirroringStatusResponse 

type TablesMirroringStatusResponse struct {
	// REQUIRED; A list of table mirroring statuses.
	Data []TableMirroringStatusResponse

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

TablesMirroringStatusResponse - A paginated list of table mirroring statuses.

func (TablesMirroringStatusResponse) MarshalJSON 

func (t TablesMirroringStatusResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TablesMirroringStatusResponse.

func (*TablesMirroringStatusResponse) UnmarshalJSON 

func (t *TablesMirroringStatusResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TablesMirroringStatusResponse.

type UpdateMirroredDatabaseDefinitionRequest 

type UpdateMirroredDatabaseDefinitionRequest struct {
	// REQUIRED; Mirrored database public definition object.
	Definition *Definition
}

UpdateMirroredDatabaseDefinitionRequest - Update mirrored database public definition request payload.

func (UpdateMirroredDatabaseDefinitionRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UpdateMirroredDatabaseDefinitionRequest.

func (*UpdateMirroredDatabaseDefinitionRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateMirroredDatabaseDefinitionRequest.

type UpdateMirroredDatabaseRequest 

type UpdateMirroredDatabaseRequest struct {
	// The mirrored database description. Maximum length is 256 characters.
	Description *string

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

UpdateMirroredDatabaseRequest - Update mirrored database request.

func (UpdateMirroredDatabaseRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UpdateMirroredDatabaseRequest.

func (*UpdateMirroredDatabaseRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateMirroredDatabaseRequest.

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.