dataset

package
v0.20230420.1093529 Latest Latest
Warning

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

 Go to latest Published: Apr 20, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/datashare/2021-08-01/dataset Documentation

The dataset SDK allows for interaction with the Azure Resource Manager Service datashare (API Version 2021-08-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/datashare/2021-08-01/dataset"

Client Initialization

client := dataset.NewDataSetClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataSetClient.Create

ctx := context.TODO()
id := dataset.NewDataSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareValue", "dataSetValue")

payload := dataset.DataSet{
	// ...
}


read, err := client.Create(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DataSetClient.Delete

ctx := context.TODO()
id := dataset.NewDataSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareValue", "dataSetValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: DataSetClient.Get

ctx := context.TODO()
id := dataset.NewDataSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareValue", "dataSetValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DataSetClient.ListByShare

ctx := context.TODO()
id := dataset.NewShareID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareValue")

// alternatively `client.ListByShare(ctx, id, dataset.DefaultListByShareOperationOptions())` can be used to do batched pagination
items, err := client.ListByShareComplete(ctx, id, dataset.DefaultListByShareOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDataSetKind 

func PossibleValuesForDataSetKind() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateDataSetID 

func ValidateDataSetID(input interface{}, key string) (warnings []string, errors []error)

ValidateDataSetID checks that 'input' can be parsed as a Data Set ID

func ValidateShareID 

func ValidateShareID(input interface{}, key string) (warnings []string, errors []error)

ValidateShareID checks that 'input' can be parsed as a Share ID

Types

type ADLSGen1FileDataSet 

type ADLSGen1FileDataSet struct {
	Properties ADLSGen1FileProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (ADLSGen1FileDataSet) MarshalJSON 

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

type ADLSGen1FileProperties 

type ADLSGen1FileProperties struct {
	AccountName    string  `json:"accountName"`
	DataSetId      *string `json:"dataSetId,omitempty"`
	FileName       string  `json:"fileName"`
	FolderPath     string  `json:"folderPath"`
	ResourceGroup  string  `json:"resourceGroup"`
	SubscriptionId string  `json:"subscriptionId"`
}

type ADLSGen1FolderDataSet 

type ADLSGen1FolderDataSet struct {
	Properties ADLSGen1FolderProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (ADLSGen1FolderDataSet) MarshalJSON 

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

type ADLSGen1FolderProperties 

type ADLSGen1FolderProperties struct {
	AccountName    string  `json:"accountName"`
	DataSetId      *string `json:"dataSetId,omitempty"`
	FolderPath     string  `json:"folderPath"`
	ResourceGroup  string  `json:"resourceGroup"`
	SubscriptionId string  `json:"subscriptionId"`
}

type ADLSGen2FileDataSet 

type ADLSGen2FileDataSet struct {
	Properties ADLSGen2FileProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (ADLSGen2FileDataSet) MarshalJSON 

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

type ADLSGen2FileProperties 

type ADLSGen2FileProperties struct {
	DataSetId          *string `json:"dataSetId,omitempty"`
	FilePath           string  `json:"filePath"`
	FileSystem         string  `json:"fileSystem"`
	ResourceGroup      string  `json:"resourceGroup"`
	StorageAccountName string  `json:"storageAccountName"`
	SubscriptionId     string  `json:"subscriptionId"`
}

type ADLSGen2FileSystemDataSet 

type ADLSGen2FileSystemDataSet struct {
	Properties ADLSGen2FileSystemProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (ADLSGen2FileSystemDataSet) MarshalJSON 

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

type ADLSGen2FileSystemProperties 

type ADLSGen2FileSystemProperties struct {
	DataSetId          *string `json:"dataSetId,omitempty"`
	FileSystem         string  `json:"fileSystem"`
	ResourceGroup      string  `json:"resourceGroup"`
	StorageAccountName string  `json:"storageAccountName"`
	SubscriptionId     string  `json:"subscriptionId"`
}

type ADLSGen2FolderDataSet 

type ADLSGen2FolderDataSet struct {
	Properties ADLSGen2FolderProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (ADLSGen2FolderDataSet) MarshalJSON 

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

type ADLSGen2FolderProperties 

type ADLSGen2FolderProperties struct {
	DataSetId          *string `json:"dataSetId,omitempty"`
	FileSystem         string  `json:"fileSystem"`
	FolderPath         string  `json:"folderPath"`
	ResourceGroup      string  `json:"resourceGroup"`
	StorageAccountName string  `json:"storageAccountName"`
	SubscriptionId     string  `json:"subscriptionId"`
}

type BlobContainerDataSet 

type BlobContainerDataSet struct {
	Properties BlobContainerProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (BlobContainerDataSet) MarshalJSON 

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

type BlobContainerProperties 

type BlobContainerProperties struct {
	ContainerName      string  `json:"containerName"`
	DataSetId          *string `json:"dataSetId,omitempty"`
	ResourceGroup      string  `json:"resourceGroup"`
	StorageAccountName string  `json:"storageAccountName"`
	SubscriptionId     string  `json:"subscriptionId"`
}

type BlobDataSet 

type BlobDataSet struct {
	Properties BlobProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (BlobDataSet) MarshalJSON 

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

type BlobFolderDataSet 

type BlobFolderDataSet struct {
	Properties BlobFolderProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (BlobFolderDataSet) MarshalJSON 

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

type BlobFolderProperties 

type BlobFolderProperties struct {
	ContainerName      string  `json:"containerName"`
	DataSetId          *string `json:"dataSetId,omitempty"`
	Prefix             string  `json:"prefix"`
	ResourceGroup      string  `json:"resourceGroup"`
	StorageAccountName string  `json:"storageAccountName"`
	SubscriptionId     string  `json:"subscriptionId"`
}

type BlobProperties 

type BlobProperties struct {
	ContainerName      string  `json:"containerName"`
	DataSetId          *string `json:"dataSetId,omitempty"`
	FilePath           string  `json:"filePath"`
	ResourceGroup      string  `json:"resourceGroup"`
	StorageAccountName string  `json:"storageAccountName"`
	SubscriptionId     string  `json:"subscriptionId"`
}

type CreateOperationResponse 

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataSet
}

type DataSet 

type DataSet interface {
}

type DataSetClient 

type DataSetClient struct {
	Client *resourcemanager.Client
}

func NewDataSetClientWithBaseURI 

func NewDataSetClientWithBaseURI(api environments.Api) (*DataSetClient, error)

func (DataSetClient) Create 

func (c DataSetClient) Create(ctx context.Context, id DataSetId, input DataSet) (result CreateOperationResponse, err error)

Create ...

func (DataSetClient) Delete 

func (c DataSetClient) Delete(ctx context.Context, id DataSetId) (result DeleteOperationResponse, err error)

Delete ...

func (DataSetClient) DeleteThenPoll 

func (c DataSetClient) DeleteThenPoll(ctx context.Context, id DataSetId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DataSetClient) Get 

func (c DataSetClient) Get(ctx context.Context, id DataSetId) (result GetOperationResponse, err error)

Get ...

func (DataSetClient) ListByShare 

func (c DataSetClient) ListByShare(ctx context.Context, id ShareId, options ListByShareOperationOptions) (result ListByShareOperationResponse, err error)

ListByShare ...

func (DataSetClient) ListByShareComplete 

func (c DataSetClient) ListByShareComplete(ctx context.Context, id ShareId, options ListByShareOperationOptions) (ListByShareCompleteResult, error)

ListByShareComplete retrieves all the results into a single object

func (DataSetClient) ListByShareCompleteMatchingPredicate 

func (c DataSetClient) ListByShareCompleteMatchingPredicate(ctx context.Context, id ShareId, options ListByShareOperationOptions, predicate DataSetOperationPredicate) (result ListByShareCompleteResult, err error)

ListByShareCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DataSetId 

type DataSetId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
	ShareName         string
	DataSetName       string
}

DataSetId is a struct representing the Resource ID for a Data Set

func NewDataSetID 

func NewDataSetID(subscriptionId string, resourceGroupName string, accountName string, shareName string, dataSetName string) DataSetId

NewDataSetID returns a new DataSetId struct

func ParseDataSetID 

func ParseDataSetID(input string) (*DataSetId, error)

ParseDataSetID parses 'input' into a DataSetId

func ParseDataSetIDInsensitively 

func ParseDataSetIDInsensitively(input string) (*DataSetId, error)

ParseDataSetIDInsensitively parses 'input' case-insensitively into a DataSetId note: this method should only be used for API response data and not user input

func (DataSetId) ID 

func (id DataSetId) ID() string

ID returns the formatted Data Set ID

func (DataSetId) Segments 

func (id DataSetId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Data Set ID

func (DataSetId) String 

func (id DataSetId) String() string

String returns a human-readable description of this Data Set ID

type DataSetKind 

type DataSetKind string
const (
	DataSetKindAdlsGenOneFile               DataSetKind = "AdlsGen1File"
	DataSetKindAdlsGenOneFolder             DataSetKind = "AdlsGen1Folder"
	DataSetKindAdlsGenTwoFile               DataSetKind = "AdlsGen2File"
	DataSetKindAdlsGenTwoFileSystem         DataSetKind = "AdlsGen2FileSystem"
	DataSetKindAdlsGenTwoFolder             DataSetKind = "AdlsGen2Folder"
	DataSetKindBlob                         DataSetKind = "Blob"
	DataSetKindBlobFolder                   DataSetKind = "BlobFolder"
	DataSetKindContainer                    DataSetKind = "Container"
	DataSetKindKustoCluster                 DataSetKind = "KustoCluster"
	DataSetKindKustoDatabase                DataSetKind = "KustoDatabase"
	DataSetKindKustoTable                   DataSetKind = "KustoTable"
	DataSetKindSqlDBTable                   DataSetKind = "SqlDBTable"
	DataSetKindSqlDWTable                   DataSetKind = "SqlDWTable"
	DataSetKindSynapseWorkspaceSqlPoolTable DataSetKind = "SynapseWorkspaceSqlPoolTable"
)

func (*DataSetKind) UnmarshalJSON added in v0.20230420.1093529 

func (s *DataSetKind) UnmarshalJSON(bytes []byte) error

type DataSetOperationPredicate 

type DataSetOperationPredicate struct {
}

func (DataSetOperationPredicate) Matches 

func (p DataSetOperationPredicate) Matches(input DataSet) bool

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataSet
}

type KustoClusterDataSet 

type KustoClusterDataSet struct {
	Properties KustoClusterDataSetProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (KustoClusterDataSet) MarshalJSON 

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

type KustoClusterDataSetProperties 

type KustoClusterDataSetProperties struct {
	DataSetId              *string            `json:"dataSetId,omitempty"`
	KustoClusterResourceId string             `json:"kustoClusterResourceId"`
	Location               *string            `json:"location,omitempty"`
	ProvisioningState      *ProvisioningState `json:"provisioningState,omitempty"`
}

type KustoDatabaseDataSet 

type KustoDatabaseDataSet struct {
	Properties KustoDatabaseDataSetProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (KustoDatabaseDataSet) MarshalJSON 

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

type KustoDatabaseDataSetProperties 

type KustoDatabaseDataSetProperties struct {
	DataSetId               *string            `json:"dataSetId,omitempty"`
	KustoDatabaseResourceId string             `json:"kustoDatabaseResourceId"`
	Location                *string            `json:"location,omitempty"`
	ProvisioningState       *ProvisioningState `json:"provisioningState,omitempty"`
}

type KustoTableDataSet 

type KustoTableDataSet struct {
	Properties KustoTableDataSetProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (KustoTableDataSet) MarshalJSON 

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

type KustoTableDataSetProperties 

type KustoTableDataSetProperties struct {
	DataSetId                   *string                     `json:"dataSetId,omitempty"`
	KustoDatabaseResourceId     string                      `json:"kustoDatabaseResourceId"`
	Location                    *string                     `json:"location,omitempty"`
	ProvisioningState           *ProvisioningState          `json:"provisioningState,omitempty"`
	TableLevelSharingProperties TableLevelSharingProperties `json:"tableLevelSharingProperties"`
}

type ListByShareCompleteResult 

type ListByShareCompleteResult struct {
	Items []DataSet
}

type ListByShareOperationOptions 

type ListByShareOperationOptions struct {
	Filter  *string
	Orderby *string
}

func DefaultListByShareOperationOptions 

func DefaultListByShareOperationOptions() ListByShareOperationOptions

func (ListByShareOperationOptions) ToHeaders added in v0.20230420.1093529 

func (o ListByShareOperationOptions) ToHeaders() *client.Headers

func (ListByShareOperationOptions) ToOData added in v0.20230420.1093529 

func (o ListByShareOperationOptions) ToOData() *odata.Query

func (ListByShareOperationOptions) ToQuery added in v0.20230420.1093529 

func (o ListByShareOperationOptions) ToQuery() *client.QueryParams

type ListByShareOperationResponse 

type ListByShareOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataSet
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateMoving    ProvisioningState = "Moving"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON added in v0.20230420.1093529 

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type ShareId 

type ShareId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
	ShareName         string
}

ShareId is a struct representing the Resource ID for a Share

func NewShareID 

func NewShareID(subscriptionId string, resourceGroupName string, accountName string, shareName string) ShareId

NewShareID returns a new ShareId struct

func ParseShareID 

func ParseShareID(input string) (*ShareId, error)

ParseShareID parses 'input' into a ShareId

func ParseShareIDInsensitively 

func ParseShareIDInsensitively(input string) (*ShareId, error)

ParseShareIDInsensitively parses 'input' case-insensitively into a ShareId note: this method should only be used for API response data and not user input

func (ShareId) ID 

func (id ShareId) ID() string

ID returns the formatted Share ID

func (ShareId) Segments 

func (id ShareId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Share ID

func (ShareId) String 

func (id ShareId) String() string

String returns a human-readable description of this Share ID

type SqlDBTableDataSet 

type SqlDBTableDataSet struct {
	Properties *SqlDBTableProperties `json:"properties,omitempty"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (SqlDBTableDataSet) MarshalJSON 

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

type SqlDBTableProperties 

type SqlDBTableProperties struct {
	DataSetId           *string `json:"dataSetId,omitempty"`
	DatabaseName        string  `json:"databaseName"`
	SchemaName          string  `json:"schemaName"`
	SqlServerResourceId string  `json:"sqlServerResourceId"`
	TableName           string  `json:"tableName"`
}

type SqlDWTableDataSet 

type SqlDWTableDataSet struct {
	Properties *SqlDWTableProperties `json:"properties,omitempty"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (SqlDWTableDataSet) MarshalJSON 

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

type SqlDWTableProperties 

type SqlDWTableProperties struct {
	DataSetId           *string `json:"dataSetId,omitempty"`
	DataWarehouseName   string  `json:"dataWarehouseName"`
	SchemaName          string  `json:"schemaName"`
	SqlServerResourceId string  `json:"sqlServerResourceId"`
	TableName           string  `json:"tableName"`
}

type SynapseWorkspaceSqlPoolTableDataSet 

type SynapseWorkspaceSqlPoolTableDataSet struct {
	Properties SynapseWorkspaceSqlPoolTableDataSetProperties `json:"properties"`

	// Fields inherited from DataSet
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

func (SynapseWorkspaceSqlPoolTableDataSet) MarshalJSON 

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

type SynapseWorkspaceSqlPoolTableDataSetProperties 

type SynapseWorkspaceSqlPoolTableDataSetProperties struct {
	DataSetId                              *string `json:"dataSetId,omitempty"`
	SynapseWorkspaceSqlPoolTableResourceId string  `json:"synapseWorkspaceSqlPoolTableResourceId"`
}

type TableLevelSharingProperties 

type TableLevelSharingProperties struct {
	ExternalTablesToExclude    *[]string `json:"externalTablesToExclude,omitempty"`
	ExternalTablesToInclude    *[]string `json:"externalTablesToInclude,omitempty"`
	MaterializedViewsToExclude *[]string `json:"materializedViewsToExclude,omitempty"`
	MaterializedViewsToInclude *[]string `json:"materializedViewsToInclude,omitempty"`
	TablesToExclude            *[]string `json:"tablesToExclude,omitempty"`
	TablesToInclude            *[]string `json:"tablesToInclude,omitempty"`
}

Source Files

View all Source files

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.