datasetmapping

package
v0.20231023.1152718 Latest Latest
Warning

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

Go to latest
Published: Oct 23, 2023 License: MPL-2.0 Imports: 10 Imported by: 1

README

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

The datasetmapping 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/datasetmapping"

Client Initialization

client := datasetmapping.NewDataSetMappingClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataSetMappingClient.Create

ctx := context.TODO()
id := datasetmapping.NewDataSetMappingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareSubscriptionValue", "dataSetMappingValue")

payload := datasetmapping.DataSetMapping{
	// ...
}


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: DataSetMappingClient.Delete

ctx := context.TODO()
id := datasetmapping.NewDataSetMappingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareSubscriptionValue", "dataSetMappingValue")

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

Example Usage: DataSetMappingClient.Get

ctx := context.TODO()
id := datasetmapping.NewDataSetMappingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareSubscriptionValue", "dataSetMappingValue")

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: DataSetMappingClient.ListByShareSubscription

ctx := context.TODO()
id := datasetmapping.NewShareSubscriptionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "shareSubscriptionValue")

// alternatively `client.ListByShareSubscription(ctx, id, datasetmapping.DefaultListByShareSubscriptionOperationOptions())` can be used to do batched pagination
items, err := client.ListByShareSubscriptionComplete(ctx, id, datasetmapping.DefaultListByShareSubscriptionOperationOptions())
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 PossibleValuesForDataSetMappingKind

func PossibleValuesForDataSetMappingKind() []string

func PossibleValuesForDataSetMappingStatus

func PossibleValuesForDataSetMappingStatus() []string

func PossibleValuesForOutputType

func PossibleValuesForOutputType() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateDataSetMappingID

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

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

func ValidateShareSubscriptionID

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

ValidateShareSubscriptionID checks that 'input' can be parsed as a Share Subscription ID

Types

type ADLSGen2FileDataSetMapping

type ADLSGen2FileDataSetMapping struct {
	Properties ADLSGen2FileDataSetMappingProperties `json:"properties"`

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

func (ADLSGen2FileDataSetMapping) MarshalJSON

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

type ADLSGen2FileDataSetMappingProperties

type ADLSGen2FileDataSetMappingProperties struct {
	DataSetId            string                `json:"dataSetId"`
	DataSetMappingStatus *DataSetMappingStatus `json:"dataSetMappingStatus,omitempty"`
	FilePath             string                `json:"filePath"`
	FileSystem           string                `json:"fileSystem"`
	OutputType           *OutputType           `json:"outputType,omitempty"`
	ProvisioningState    *ProvisioningState    `json:"provisioningState,omitempty"`
	ResourceGroup        string                `json:"resourceGroup"`
	StorageAccountName   string                `json:"storageAccountName"`
	SubscriptionId       string                `json:"subscriptionId"`
}

type ADLSGen2FileSystemDataSetMapping

type ADLSGen2FileSystemDataSetMapping struct {
	Properties ADLSGen2FileSystemDataSetMappingProperties `json:"properties"`

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

func (ADLSGen2FileSystemDataSetMapping) MarshalJSON

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

type ADLSGen2FileSystemDataSetMappingProperties

type ADLSGen2FileSystemDataSetMappingProperties struct {
	DataSetId            string                `json:"dataSetId"`
	DataSetMappingStatus *DataSetMappingStatus `json:"dataSetMappingStatus,omitempty"`
	FileSystem           string                `json:"fileSystem"`
	ProvisioningState    *ProvisioningState    `json:"provisioningState,omitempty"`
	ResourceGroup        string                `json:"resourceGroup"`
	StorageAccountName   string                `json:"storageAccountName"`
	SubscriptionId       string                `json:"subscriptionId"`
}

type ADLSGen2FolderDataSetMapping

type ADLSGen2FolderDataSetMapping struct {
	Properties ADLSGen2FolderDataSetMappingProperties `json:"properties"`

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

func (ADLSGen2FolderDataSetMapping) MarshalJSON

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

type ADLSGen2FolderDataSetMappingProperties

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

type BlobContainerDataSetMapping

type BlobContainerDataSetMapping struct {
	Properties BlobContainerMappingProperties `json:"properties"`

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

func (BlobContainerDataSetMapping) MarshalJSON

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

type BlobContainerMappingProperties

type BlobContainerMappingProperties struct {
	ContainerName        string                `json:"containerName"`
	DataSetId            string                `json:"dataSetId"`
	DataSetMappingStatus *DataSetMappingStatus `json:"dataSetMappingStatus,omitempty"`
	ProvisioningState    *ProvisioningState    `json:"provisioningState,omitempty"`
	ResourceGroup        string                `json:"resourceGroup"`
	StorageAccountName   string                `json:"storageAccountName"`
	SubscriptionId       string                `json:"subscriptionId"`
}

type BlobDataSetMapping

type BlobDataSetMapping struct {
	Properties BlobMappingProperties `json:"properties"`

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

func (BlobDataSetMapping) MarshalJSON

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

type BlobFolderDataSetMapping

type BlobFolderDataSetMapping struct {
	Properties BlobFolderMappingProperties `json:"properties"`

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

func (BlobFolderDataSetMapping) MarshalJSON

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

type BlobFolderMappingProperties

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

type BlobMappingProperties

type BlobMappingProperties struct {
	ContainerName        string                `json:"containerName"`
	DataSetId            string                `json:"dataSetId"`
	DataSetMappingStatus *DataSetMappingStatus `json:"dataSetMappingStatus,omitempty"`
	FilePath             string                `json:"filePath"`
	OutputType           *OutputType           `json:"outputType,omitempty"`
	ProvisioningState    *ProvisioningState    `json:"provisioningState,omitempty"`
	ResourceGroup        string                `json:"resourceGroup"`
	StorageAccountName   string                `json:"storageAccountName"`
	SubscriptionId       string                `json:"subscriptionId"`
}

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	Model        *DataSetMapping
}

type DataSetMapping

type DataSetMapping interface {
}

type DataSetMappingClient

type DataSetMappingClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewDataSetMappingClientWithBaseURI

func NewDataSetMappingClientWithBaseURI(endpoint string) DataSetMappingClient

func (DataSetMappingClient) Create

Create ...

func (DataSetMappingClient) Delete

Delete ...

func (DataSetMappingClient) Get

Get ...

func (DataSetMappingClient) ListByShareSubscription

ListByShareSubscription ...

func (DataSetMappingClient) ListByShareSubscriptionComplete

ListByShareSubscriptionComplete retrieves all of the results into a single object

func (DataSetMappingClient) ListByShareSubscriptionCompleteMatchingPredicate

ListByShareSubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type DataSetMappingId

type DataSetMappingId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AccountName           string
	ShareSubscriptionName string
	DataSetMappingName    string
}

DataSetMappingId is a struct representing the Resource ID for a Data Set Mapping

func NewDataSetMappingID

func NewDataSetMappingID(subscriptionId string, resourceGroupName string, accountName string, shareSubscriptionName string, dataSetMappingName string) DataSetMappingId

NewDataSetMappingID returns a new DataSetMappingId struct

func ParseDataSetMappingID

func ParseDataSetMappingID(input string) (*DataSetMappingId, error)

ParseDataSetMappingID parses 'input' into a DataSetMappingId

func ParseDataSetMappingIDInsensitively

func ParseDataSetMappingIDInsensitively(input string) (*DataSetMappingId, error)

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

func (DataSetMappingId) ID

func (id DataSetMappingId) ID() string

ID returns the formatted Data Set Mapping ID

func (DataSetMappingId) Segments

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

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

func (DataSetMappingId) String

func (id DataSetMappingId) String() string

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

type DataSetMappingKind

type DataSetMappingKind string
const (
	DataSetMappingKindAdlsGenTwoFile               DataSetMappingKind = "AdlsGen2File"
	DataSetMappingKindAdlsGenTwoFileSystem         DataSetMappingKind = "AdlsGen2FileSystem"
	DataSetMappingKindAdlsGenTwoFolder             DataSetMappingKind = "AdlsGen2Folder"
	DataSetMappingKindBlob                         DataSetMappingKind = "Blob"
	DataSetMappingKindBlobFolder                   DataSetMappingKind = "BlobFolder"
	DataSetMappingKindContainer                    DataSetMappingKind = "Container"
	DataSetMappingKindKustoCluster                 DataSetMappingKind = "KustoCluster"
	DataSetMappingKindKustoDatabase                DataSetMappingKind = "KustoDatabase"
	DataSetMappingKindKustoTable                   DataSetMappingKind = "KustoTable"
	DataSetMappingKindSqlDBTable                   DataSetMappingKind = "SqlDBTable"
	DataSetMappingKindSqlDWTable                   DataSetMappingKind = "SqlDWTable"
	DataSetMappingKindSynapseWorkspaceSqlPoolTable DataSetMappingKind = "SynapseWorkspaceSqlPoolTable"
)

type DataSetMappingOperationPredicate

type DataSetMappingOperationPredicate struct {
}

func (DataSetMappingOperationPredicate) Matches

type DataSetMappingStatus

type DataSetMappingStatus string
const (
	DataSetMappingStatusBroken DataSetMappingStatus = "Broken"
	DataSetMappingStatusOk     DataSetMappingStatus = "Ok"
)

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *DataSetMapping
}

type KustoClusterDataSetMapping

type KustoClusterDataSetMapping struct {
	Properties KustoClusterDataSetMappingProperties `json:"properties"`

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

func (KustoClusterDataSetMapping) MarshalJSON

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

type KustoClusterDataSetMappingProperties

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

type KustoDatabaseDataSetMapping

type KustoDatabaseDataSetMapping struct {
	Properties KustoDatabaseDataSetMappingProperties `json:"properties"`

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

func (KustoDatabaseDataSetMapping) MarshalJSON

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

type KustoDatabaseDataSetMappingProperties

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

type KustoTableDataSetMapping

type KustoTableDataSetMapping struct {
	Properties KustoTableDataSetMappingProperties `json:"properties"`

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

func (KustoTableDataSetMapping) MarshalJSON

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

type KustoTableDataSetMappingProperties

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

type ListByShareSubscriptionCompleteResult

type ListByShareSubscriptionCompleteResult struct {
	Items []DataSetMapping
}

type ListByShareSubscriptionOperationOptions

type ListByShareSubscriptionOperationOptions struct {
	Filter  *string
	Orderby *string
}

func DefaultListByShareSubscriptionOperationOptions

func DefaultListByShareSubscriptionOperationOptions() ListByShareSubscriptionOperationOptions

type ListByShareSubscriptionOperationResponse

type ListByShareSubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]DataSetMapping
	// contains filtered or unexported fields
}

func (ListByShareSubscriptionOperationResponse) HasMore

func (ListByShareSubscriptionOperationResponse) LoadMore

type OutputType

type OutputType string
const (
	OutputTypeCsv     OutputType = "Csv"
	OutputTypeParquet OutputType = "Parquet"
)

type ProvisioningState

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

type RawDataSetMappingImpl added in v0.20230807.1063129

type RawDataSetMappingImpl struct {
	Type   string
	Values map[string]interface{}
}

RawDataSetMappingImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type ShareSubscriptionId

type ShareSubscriptionId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AccountName           string
	ShareSubscriptionName string
}

ShareSubscriptionId is a struct representing the Resource ID for a Share Subscription

func NewShareSubscriptionID

func NewShareSubscriptionID(subscriptionId string, resourceGroupName string, accountName string, shareSubscriptionName string) ShareSubscriptionId

NewShareSubscriptionID returns a new ShareSubscriptionId struct

func ParseShareSubscriptionID

func ParseShareSubscriptionID(input string) (*ShareSubscriptionId, error)

ParseShareSubscriptionID parses 'input' into a ShareSubscriptionId

func ParseShareSubscriptionIDInsensitively

func ParseShareSubscriptionIDInsensitively(input string) (*ShareSubscriptionId, error)

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

func (ShareSubscriptionId) ID

func (id ShareSubscriptionId) ID() string

ID returns the formatted Share Subscription ID

func (ShareSubscriptionId) Segments

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

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

func (ShareSubscriptionId) String

func (id ShareSubscriptionId) String() string

String returns a human-readable description of this Share Subscription ID

type SqlDBTableDataSetMapping

type SqlDBTableDataSetMapping struct {
	Properties SqlDBTableDataSetMappingProperties `json:"properties"`

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

func (SqlDBTableDataSetMapping) MarshalJSON

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

type SqlDBTableDataSetMappingProperties

type SqlDBTableDataSetMappingProperties struct {
	DataSetId            string                `json:"dataSetId"`
	DataSetMappingStatus *DataSetMappingStatus `json:"dataSetMappingStatus,omitempty"`
	DatabaseName         string                `json:"databaseName"`
	ProvisioningState    *ProvisioningState    `json:"provisioningState,omitempty"`
	SchemaName           string                `json:"schemaName"`
	SqlServerResourceId  string                `json:"sqlServerResourceId"`
	TableName            string                `json:"tableName"`
}

type SqlDWTableDataSetMapping

type SqlDWTableDataSetMapping struct {
	Properties SqlDWTableDataSetMappingProperties `json:"properties"`

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

func (SqlDWTableDataSetMapping) MarshalJSON

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

type SqlDWTableDataSetMappingProperties

type SqlDWTableDataSetMappingProperties struct {
	DataSetId            string                `json:"dataSetId"`
	DataSetMappingStatus *DataSetMappingStatus `json:"dataSetMappingStatus,omitempty"`
	DataWarehouseName    string                `json:"dataWarehouseName"`
	ProvisioningState    *ProvisioningState    `json:"provisioningState,omitempty"`
	SchemaName           string                `json:"schemaName"`
	SqlServerResourceId  string                `json:"sqlServerResourceId"`
	TableName            string                `json:"tableName"`
}

type SynapseWorkspaceSqlPoolTableDataSetMapping

type SynapseWorkspaceSqlPoolTableDataSetMapping struct {
	Properties SynapseWorkspaceSqlPoolTableDataSetMappingProperties `json:"properties"`

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

func (SynapseWorkspaceSqlPoolTableDataSetMapping) MarshalJSON

type SynapseWorkspaceSqlPoolTableDataSetMappingProperties

type SynapseWorkspaceSqlPoolTableDataSetMappingProperties struct {
	DataSetId                              string                `json:"dataSetId"`
	DataSetMappingStatus                   *DataSetMappingStatus `json:"dataSetMappingStatus,omitempty"`
	ProvisioningState                      *ProvisioningState    `json:"provisioningState,omitempty"`
	SynapseWorkspaceSqlPoolTableResourceId string                `json:"synapseWorkspaceSqlPoolTableResourceId"`
}

Jump to

Keyboard shortcuts

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