datasetmapping

package
v0.20241023.1122425 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/datashare/2019-11-01/datasetmapping Documentation

The datasetmapping SDK allows for interaction with Azure Resource Manager datashare (API Version 2019-11-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/2019-11-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", "accountName", "shareSubscriptionName", "dataSetMappingName")

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", "accountName", "shareSubscriptionName", "dataSetMappingName")

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", "accountName", "shareSubscriptionName", "dataSetMappingName")

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", "accountName", "shareSubscriptionName")

// 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"`

	Id   *string            `json:"id,omitempty"`
	Kind DataSetMappingKind `json:"kind"`
	Name *string            `json:"name,omitempty"`
	Type *string            `json:"type,omitempty"`
}

func (ADLSGen2FileDataSetMapping) DataSetMapping added in v0.20240920.1135249

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"`

	Id   *string            `json:"id,omitempty"`
	Kind DataSetMappingKind `json:"kind"`
	Name *string            `json:"name,omitempty"`
	Type *string            `json:"type,omitempty"`
}

func (ADLSGen2FileSystemDataSetMapping) DataSetMapping added in v0.20240920.1135249

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"`

	Id   *string            `json:"id,omitempty"`
	Kind DataSetMappingKind `json:"kind"`
	Name *string            `json:"name,omitempty"`
	Type *string            `json:"type,omitempty"`
}

func (ADLSGen2FolderDataSetMapping) DataSetMapping added in v0.20240920.1135249

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 BaseDataSetMappingImpl added in v0.20240920.1135249

type BaseDataSetMappingImpl struct {
	Id   *string            `json:"id,omitempty"`
	Kind DataSetMappingKind `json:"kind"`
	Name *string            `json:"name,omitempty"`
	Type *string            `json:"type,omitempty"`
}

func (BaseDataSetMappingImpl) DataSetMapping added in v0.20240920.1135249

type BlobContainerDataSetMapping

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

	Id   *string            `json:"id,omitempty"`
	Kind DataSetMappingKind `json:"kind"`
	Name *string            `json:"name,omitempty"`
	Type *string            `json:"type,omitempty"`
}

func (BlobContainerDataSetMapping) DataSetMapping added in v0.20240920.1135249

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"`

	Id   *string            `json:"id,omitempty"`
	Kind DataSetMappingKind `json:"kind"`
	Name *string            `json:"name,omitempty"`
	Type *string            `json:"type,omitempty"`
}

func (BlobDataSetMapping) DataSetMapping added in v0.20240920.1135249

func (s BlobDataSetMapping) DataSetMapping() BaseDataSetMappingImpl

func (BlobDataSetMapping) MarshalJSON

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

type BlobFolderDataSetMapping

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

	Id   *string            `json:"id,omitempty"`
	Kind DataSetMappingKind `json:"kind"`
	Name *string            `json:"name,omitempty"`
	Type *string            `json:"type,omitempty"`
}

func (BlobFolderDataSetMapping) DataSetMapping added in v0.20240920.1135249

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
	OData        *odata.OData
	Model        DataSetMapping
}

type DataSetMapping

type DataSetMapping interface {
	DataSetMapping() BaseDataSetMappingImpl
}

func UnmarshalDataSetMappingImplementation added in v0.20240920.1135249

func UnmarshalDataSetMappingImplementation(input []byte) (DataSetMapping, error)

type DataSetMappingClient

type DataSetMappingClient struct {
	Client *resourcemanager.Client
}

func NewDataSetMappingClientWithBaseURI

func NewDataSetMappingClientWithBaseURI(sdkApi sdkEnv.Api) (*DataSetMappingClient, error)

func (DataSetMappingClient) Create

Create ...

func (DataSetMappingClient) Delete

Delete ...

func (DataSetMappingClient) Get

Get ...

func (DataSetMappingClient) ListByShareSubscription

ListByShareSubscription ...

func (DataSetMappingClient) ListByShareSubscriptionComplete

ListByShareSubscriptionComplete retrieves all the results into a single object

func (DataSetMappingClient) ListByShareSubscriptionCompleteMatchingPredicate

ListByShareSubscriptionCompleteMatchingPredicate retrieves all the results and then applies 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) FromParseResult

func (id *DataSetMappingId) FromParseResult(input resourceids.ParseResult) error

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"
	DataSetMappingKindSqlDBTable           DataSetMappingKind = "SqlDBTable"
	DataSetMappingKindSqlDWTable           DataSetMappingKind = "SqlDWTable"
)

func (*DataSetMappingKind) UnmarshalJSON

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

type DataSetMappingOperationPredicate

type DataSetMappingOperationPredicate struct {
}

func (DataSetMappingOperationPredicate) Matches

type DataSetMappingStatus

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

func (*DataSetMappingStatus) UnmarshalJSON

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

type DeleteOperationResponse

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

type GetOperationResponse

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

type KustoClusterDataSetMapping

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

	Id   *string            `json:"id,omitempty"`
	Kind DataSetMappingKind `json:"kind"`
	Name *string            `json:"name,omitempty"`
	Type *string            `json:"type,omitempty"`
}

func (KustoClusterDataSetMapping) DataSetMapping added in v0.20240920.1135249

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"`

	Id   *string            `json:"id,omitempty"`
	Kind DataSetMappingKind `json:"kind"`
	Name *string            `json:"name,omitempty"`
	Type *string            `json:"type,omitempty"`
}

func (KustoDatabaseDataSetMapping) DataSetMapping added in v0.20240920.1135249

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 ListByShareSubscriptionCompleteResult

type ListByShareSubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DataSetMapping
}

type ListByShareSubscriptionCustomPager added in v0.20240628.1153531

type ListByShareSubscriptionCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByShareSubscriptionCustomPager) NextPageLink() *odata.Link

type ListByShareSubscriptionOperationOptions

type ListByShareSubscriptionOperationOptions struct {
	Filter  *string
	Orderby *string
}

func DefaultListByShareSubscriptionOperationOptions

func DefaultListByShareSubscriptionOperationOptions() ListByShareSubscriptionOperationOptions

func (ListByShareSubscriptionOperationOptions) ToHeaders

func (ListByShareSubscriptionOperationOptions) ToOData

func (ListByShareSubscriptionOperationOptions) ToQuery

type ListByShareSubscriptionOperationResponse

type ListByShareSubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataSetMapping
}

type OutputType

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

func (*OutputType) UnmarshalJSON

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

type ProvisioningState

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

func (*ProvisioningState) UnmarshalJSON

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

type RawDataSetMappingImpl

type RawDataSetMappingImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

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).

func (RawDataSetMappingImpl) DataSetMapping added in v0.20240920.1135249

func (s RawDataSetMappingImpl) DataSetMapping() BaseDataSetMappingImpl

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) FromParseResult

func (id *ShareSubscriptionId) FromParseResult(input resourceids.ParseResult) error

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"`

	Id   *string            `json:"id,omitempty"`
	Kind DataSetMappingKind `json:"kind"`
	Name *string            `json:"name,omitempty"`
	Type *string            `json:"type,omitempty"`
}

func (SqlDBTableDataSetMapping) DataSetMapping added in v0.20240920.1135249

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"`

	Id   *string            `json:"id,omitempty"`
	Kind DataSetMappingKind `json:"kind"`
	Name *string            `json:"name,omitempty"`
	Type *string            `json:"type,omitempty"`
}

func (SqlDWTableDataSetMapping) DataSetMapping added in v0.20240920.1135249

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"`
}

Jump to

Keyboard shortcuts

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