armdatashare

package module
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Nov 23, 2023 License: MIT Imports: 14 Imported by: 1

README

Azure Data Shara Module for Go

PkgGoDev

The armdatashare module provides operations for working with Azure Data Shara.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Data Shara module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Data Shara. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Data Shara module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armdatashare.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armdatashare.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewAccountsClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Data Shara label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ADLSGen1FileDataSet 

type ADLSGen1FileDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// REQUIRED; ADLS Gen 1 file data set properties.
	Properties *ADLSGen1FileProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ADLSGen1FileDataSet - An ADLS Gen 1 file data set.

func (*ADLSGen1FileDataSet) GetDataSet added in v0.2.0 

func (a *ADLSGen1FileDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type ADLSGen1FileDataSet.

func (ADLSGen1FileDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ADLSGen1FileDataSet.

func (*ADLSGen1FileDataSet) UnmarshalJSON 

func (a *ADLSGen1FileDataSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen1FileDataSet.

type ADLSGen1FileProperties 

type ADLSGen1FileProperties struct {
	// REQUIRED; The ADLS account name.
	AccountName *string

	// REQUIRED; The file name in the ADLS account.
	FileName *string

	// REQUIRED; The folder path within the ADLS account.
	FolderPath *string

	// REQUIRED; Resource group of ADLS account.
	ResourceGroup *string

	// REQUIRED; Subscription id of ADLS account.
	SubscriptionID *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string
}

ADLSGen1FileProperties - Properties of the ADLS Gen1 file data set.

func (ADLSGen1FileProperties) MarshalJSON added in v1.1.0 

func (a ADLSGen1FileProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ADLSGen1FileProperties.

func (*ADLSGen1FileProperties) UnmarshalJSON added in v1.1.0 

func (a *ADLSGen1FileProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen1FileProperties.

type ADLSGen1FolderDataSet 

type ADLSGen1FolderDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// REQUIRED; ADLS Gen 1 folder data set properties.
	Properties *ADLSGen1FolderProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ADLSGen1FolderDataSet - An ADLS Gen 1 folder data set.

func (*ADLSGen1FolderDataSet) GetDataSet added in v0.2.0 

func (a *ADLSGen1FolderDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type ADLSGen1FolderDataSet.

func (ADLSGen1FolderDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ADLSGen1FolderDataSet.

func (*ADLSGen1FolderDataSet) UnmarshalJSON 

func (a *ADLSGen1FolderDataSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen1FolderDataSet.

type ADLSGen1FolderProperties 

type ADLSGen1FolderProperties struct {
	// REQUIRED; The ADLS account name.
	AccountName *string

	// REQUIRED; The folder path within the ADLS account.
	FolderPath *string

	// REQUIRED; Resource group of ADLS account.
	ResourceGroup *string

	// REQUIRED; Subscription id of ADLS account.
	SubscriptionID *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string
}

ADLSGen1FolderProperties - Properties of the ADLS Gen1 folder data set.

func (ADLSGen1FolderProperties) MarshalJSON added in v1.1.0 

func (a ADLSGen1FolderProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ADLSGen1FolderProperties.

func (*ADLSGen1FolderProperties) UnmarshalJSON added in v1.1.0 

func (a *ADLSGen1FolderProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen1FolderProperties.

type ADLSGen2FileDataSet 

type ADLSGen2FileDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// REQUIRED; ADLS Gen 2 file data set properties.
	Properties *ADLSGen2FileProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ADLSGen2FileDataSet - An ADLS Gen 2 file data set.

func (*ADLSGen2FileDataSet) GetDataSet added in v0.2.0 

func (a *ADLSGen2FileDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type ADLSGen2FileDataSet.

func (ADLSGen2FileDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FileDataSet.

func (*ADLSGen2FileDataSet) UnmarshalJSON 

func (a *ADLSGen2FileDataSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FileDataSet.

type ADLSGen2FileDataSetMapping 

type ADLSGen2FileDataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// REQUIRED; ADLS Gen2 file data set mapping properties.
	Properties *ADLSGen2FileDataSetMappingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ADLSGen2FileDataSetMapping - An ADLS Gen2 file data set mapping.

func (*ADLSGen2FileDataSetMapping) GetDataSetMapping added in v0.2.0 

func (a *ADLSGen2FileDataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type ADLSGen2FileDataSetMapping.

func (ADLSGen2FileDataSetMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FileDataSetMapping.

func (*ADLSGen2FileDataSetMapping) UnmarshalJSON 

func (a *ADLSGen2FileDataSetMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FileDataSetMapping.

type ADLSGen2FileDataSetMappingProperties 

type ADLSGen2FileDataSetMappingProperties struct {
	// REQUIRED; The id of the source data set.
	DataSetID *string

	// REQUIRED; File path within the file system.
	FilePath *string

	// REQUIRED; File system to which the file belongs.
	FileSystem *string

	// REQUIRED; Resource group of storage account.
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set.
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account.
	SubscriptionID *string

	// Type of output file
	OutputType *OutputType

	// READ-ONLY; Gets the status of the data set mapping.
	DataSetMappingStatus *DataSetMappingStatus

	// READ-ONLY; Provisioning state of the data set mapping.
	ProvisioningState *ProvisioningState
}

ADLSGen2FileDataSetMappingProperties - ADLS Gen 2 file data set mapping property bag.

func (ADLSGen2FileDataSetMappingProperties) MarshalJSON added in v1.1.0 

func (a ADLSGen2FileDataSetMappingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FileDataSetMappingProperties.

func (*ADLSGen2FileDataSetMappingProperties) UnmarshalJSON added in v1.1.0 

func (a *ADLSGen2FileDataSetMappingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FileDataSetMappingProperties.

type ADLSGen2FileProperties 

type ADLSGen2FileProperties struct {
	// REQUIRED; File path within the file system.
	FilePath *string

	// REQUIRED; File system to which the file belongs.
	FileSystem *string

	// REQUIRED; Resource group of storage account
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account
	SubscriptionID *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string
}

ADLSGen2FileProperties - Properties of the ADLS Gen2 file data set.

func (ADLSGen2FileProperties) MarshalJSON added in v1.1.0 

func (a ADLSGen2FileProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FileProperties.

func (*ADLSGen2FileProperties) UnmarshalJSON added in v1.1.0 

func (a *ADLSGen2FileProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FileProperties.

type ADLSGen2FileSystemDataSet 

type ADLSGen2FileSystemDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// REQUIRED; ADLS Gen 2 file system data set properties.
	Properties *ADLSGen2FileSystemProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ADLSGen2FileSystemDataSet - An ADLS Gen 2 file system data set.

func (*ADLSGen2FileSystemDataSet) GetDataSet added in v0.2.0 

func (a *ADLSGen2FileSystemDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type ADLSGen2FileSystemDataSet.

func (ADLSGen2FileSystemDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FileSystemDataSet.

func (*ADLSGen2FileSystemDataSet) UnmarshalJSON 

func (a *ADLSGen2FileSystemDataSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FileSystemDataSet.

type ADLSGen2FileSystemDataSetMapping 

type ADLSGen2FileSystemDataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// REQUIRED; ADLS Gen2 file system data set mapping properties.
	Properties *ADLSGen2FileSystemDataSetMappingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ADLSGen2FileSystemDataSetMapping - An ADLS Gen2 file system data set mapping.

func (*ADLSGen2FileSystemDataSetMapping) GetDataSetMapping added in v0.2.0 

func (a *ADLSGen2FileSystemDataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type ADLSGen2FileSystemDataSetMapping.

func (ADLSGen2FileSystemDataSetMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FileSystemDataSetMapping.

func (*ADLSGen2FileSystemDataSetMapping) UnmarshalJSON 

func (a *ADLSGen2FileSystemDataSetMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FileSystemDataSetMapping.

type ADLSGen2FileSystemDataSetMappingProperties 

type ADLSGen2FileSystemDataSetMappingProperties struct {
	// REQUIRED; The id of the source data set.
	DataSetID *string

	// REQUIRED; The file system name.
	FileSystem *string

	// REQUIRED; Resource group of storage account.
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set.
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account.
	SubscriptionID *string

	// READ-ONLY; Gets the status of the data set mapping.
	DataSetMappingStatus *DataSetMappingStatus

	// READ-ONLY; Provisioning state of the data set mapping.
	ProvisioningState *ProvisioningState
}

ADLSGen2FileSystemDataSetMappingProperties - ADLS Gen 2 file system data set mapping property bag.

func (ADLSGen2FileSystemDataSetMappingProperties) MarshalJSON added in v1.1.0 

func (a ADLSGen2FileSystemDataSetMappingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FileSystemDataSetMappingProperties.

func (*ADLSGen2FileSystemDataSetMappingProperties) UnmarshalJSON added in v1.1.0 

func (a *ADLSGen2FileSystemDataSetMappingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FileSystemDataSetMappingProperties.

type ADLSGen2FileSystemProperties 

type ADLSGen2FileSystemProperties struct {
	// REQUIRED; The file system name.
	FileSystem *string

	// REQUIRED; Resource group of storage account
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account
	SubscriptionID *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string
}

ADLSGen2FileSystemProperties - Properties of the ADLS Gen2 file system data set.

func (ADLSGen2FileSystemProperties) MarshalJSON added in v1.1.0 

func (a ADLSGen2FileSystemProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FileSystemProperties.

func (*ADLSGen2FileSystemProperties) UnmarshalJSON added in v1.1.0 

func (a *ADLSGen2FileSystemProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FileSystemProperties.

type ADLSGen2FolderDataSet 

type ADLSGen2FolderDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// REQUIRED; ADLS Gen 2 folder data set properties.
	Properties *ADLSGen2FolderProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ADLSGen2FolderDataSet - An ADLS Gen 2 folder data set.

func (*ADLSGen2FolderDataSet) GetDataSet added in v0.2.0 

func (a *ADLSGen2FolderDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type ADLSGen2FolderDataSet.

func (ADLSGen2FolderDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FolderDataSet.

func (*ADLSGen2FolderDataSet) UnmarshalJSON 

func (a *ADLSGen2FolderDataSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FolderDataSet.

type ADLSGen2FolderDataSetMapping 

type ADLSGen2FolderDataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// REQUIRED; ADLS Gen2 folder data set mapping properties.
	Properties *ADLSGen2FolderDataSetMappingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ADLSGen2FolderDataSetMapping - An ADLS Gen2 folder data set mapping.

func (*ADLSGen2FolderDataSetMapping) GetDataSetMapping added in v0.2.0 

func (a *ADLSGen2FolderDataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type ADLSGen2FolderDataSetMapping.

func (ADLSGen2FolderDataSetMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FolderDataSetMapping.

func (*ADLSGen2FolderDataSetMapping) UnmarshalJSON 

func (a *ADLSGen2FolderDataSetMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FolderDataSetMapping.

type ADLSGen2FolderDataSetMappingProperties 

type ADLSGen2FolderDataSetMappingProperties struct {
	// REQUIRED; The id of the source data set.
	DataSetID *string

	// REQUIRED; File system to which the folder belongs.
	FileSystem *string

	// REQUIRED; Folder path within the file system.
	FolderPath *string

	// REQUIRED; Resource group of storage account.
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set.
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account.
	SubscriptionID *string

	// READ-ONLY; Gets the status of the data set mapping.
	DataSetMappingStatus *DataSetMappingStatus

	// READ-ONLY; Provisioning state of the data set mapping.
	ProvisioningState *ProvisioningState
}

ADLSGen2FolderDataSetMappingProperties - ADLS Gen 2 folder data set mapping property bag.

func (ADLSGen2FolderDataSetMappingProperties) MarshalJSON added in v1.1.0 

func (a ADLSGen2FolderDataSetMappingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FolderDataSetMappingProperties.

func (*ADLSGen2FolderDataSetMappingProperties) UnmarshalJSON added in v1.1.0 

func (a *ADLSGen2FolderDataSetMappingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FolderDataSetMappingProperties.

type ADLSGen2FolderProperties 

type ADLSGen2FolderProperties struct {
	// REQUIRED; File system to which the folder belongs.
	FileSystem *string

	// REQUIRED; Folder path within the file system.
	FolderPath *string

	// REQUIRED; Resource group of storage account
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account
	SubscriptionID *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string
}

ADLSGen2FolderProperties - Properties of the ADLS Gen2 folder data set.

func (ADLSGen2FolderProperties) MarshalJSON added in v1.1.0 

func (a ADLSGen2FolderProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ADLSGen2FolderProperties.

func (*ADLSGen2FolderProperties) UnmarshalJSON added in v1.1.0 

func (a *ADLSGen2FolderProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ADLSGen2FolderProperties.

type Account 

type Account struct {
	// REQUIRED; Identity Info on the Account
	Identity *Identity

	// Location of the azure resource.
	Location *string

	// Properties on the account
	Properties *AccountProperties

	// Tags on the azure resource.
	Tags map[string]*string

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

Account - An account data transfer object.

func (Account) MarshalJSON 

func (a Account) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Account.

func (*Account) UnmarshalJSON 

func (a *Account) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Account.

type AccountList 

type AccountList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []*Account

	// The Url of next result page.
	NextLink *string
}

AccountList - List response for get Accounts.

func (AccountList) MarshalJSON 

func (a AccountList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountList.

func (*AccountList) UnmarshalJSON added in v1.1.0 

func (a *AccountList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountList.

type AccountProperties 

type AccountProperties struct {
	// READ-ONLY; Time at which the account was created.
	CreatedAt *time.Time

	// READ-ONLY; Provisioning state of the Account
	ProvisioningState *ProvisioningState

	// READ-ONLY; Email of the user who created the resource
	UserEmail *string

	// READ-ONLY; Name of the user who created the resource
	UserName *string
}

AccountProperties - Account property bag.

func (AccountProperties) MarshalJSON 

func (a AccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountProperties.

func (*AccountProperties) UnmarshalJSON 

func (a *AccountProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountProperties.

type AccountUpdateParameters 

type AccountUpdateParameters struct {
	// Tags on the azure resource.
	Tags map[string]*string
}

AccountUpdateParameters - Update parameters for accounts

func (AccountUpdateParameters) MarshalJSON 

func (a AccountUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountUpdateParameters.

func (*AccountUpdateParameters) UnmarshalJSON added in v1.1.0 

func (a *AccountUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountUpdateParameters.

type AccountsClient 

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

AccountsClient contains the methods for the Accounts group. Don't use this type directly, use NewAccountsClient() instead.

func NewAccountsClient 

func NewAccountsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AccountsClient, error)

NewAccountsClient creates a new instance of AccountsClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*AccountsClient) BeginCreate 

func (client *AccountsClient) BeginCreate(ctx context.Context, resourceGroupName string, accountName string, account Account, options *AccountsClientBeginCreateOptions) (*runtime.Poller[AccountsClientCreateResponse], error)

BeginCreate - Create an account If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • account - The account payload.
  • options - AccountsClientBeginCreateOptions contains the optional parameters for the AccountsClient.BeginCreate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Accounts_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginCreate(ctx, "SampleResourceGroup", "Account1", armdatashare.Account{
		Location: to.Ptr("West US 2"),
		Tags: map[string]*string{
			"tag1": to.Ptr("Red"),
			"tag2": to.Ptr("White"),
		},
		Identity: &armdatashare.Identity{
			Type: to.Ptr(armdatashare.TypeSystemAssigned),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armdatashare.Account{
	// 	Name: to.Ptr("Account1"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts"),
	// 	ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1"),
	// 	SystemData: &armdatashare.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armdatashare.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armdatashare.LastModifiedByTypeUser),
	// 	},
	// 	Location: to.Ptr("West US 2"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("Red"),
	// 		"tag2": to.Ptr("White"),
	// 	},
	// 	Identity: &armdatashare.Identity{
	// 		Type: to.Ptr(armdatashare.TypeSystemAssigned),
	// 	},
	// 	Properties: &armdatashare.AccountProperties{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
	// 		UserEmail: to.Ptr("johnsmith@microsoft.com"),
	// 		UserName: to.Ptr("John Smith"),
	// 	},
	// }
}

Output:

func (*AccountsClient) BeginDelete 

func (client *AccountsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, options *AccountsClientBeginDeleteOptions) (*runtime.Poller[AccountsClientDeleteResponse], error)

BeginDelete - DeleteAccount If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • options - AccountsClientBeginDeleteOptions contains the optional parameters for the AccountsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Accounts_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginDelete(ctx, "SampleResourceGroup", "Account1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OperationResponse = armdatashare.OperationResponse{
	// 	Status: to.Ptr(armdatashare.StatusSucceeded),
	// }
}

Output:

func (*AccountsClient) Get 

func (client *AccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string, options *AccountsClientGetOptions) (AccountsClientGetResponse, error)

Get - Get an account If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • options - AccountsClientGetOptions contains the optional parameters for the AccountsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Accounts_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().Get(ctx, "SampleResourceGroup", "Account1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armdatashare.Account{
	// 	Name: to.Ptr("Account1"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts"),
	// 	ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1"),
	// 	SystemData: &armdatashare.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armdatashare.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armdatashare.LastModifiedByTypeUser),
	// 	},
	// 	Location: to.Ptr("West US 2"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("Red"),
	// 		"tag2": to.Ptr("White"),
	// 	},
	// 	Identity: &armdatashare.Identity{
	// 		Type: to.Ptr(armdatashare.TypeSystemAssigned),
	// 	},
	// 	Properties: &armdatashare.AccountProperties{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
	// 		ProvisioningState: to.Ptr(armdatashare.ProvisioningStateSucceeded),
	// 		UserEmail: to.Ptr("johnsmith@microsoft.com"),
	// 		UserName: to.Ptr("John Smith"),
	// 	},
	// }
}

Output:

func (*AccountsClient) NewListByResourceGroupPager added in v0.4.0 

func (client *AccountsClient) NewListByResourceGroupPager(resourceGroupName string, options *AccountsClientListByResourceGroupOptions) *runtime.Pager[AccountsClientListByResourceGroupResponse]

NewListByResourceGroupPager - List Accounts in ResourceGroup

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • options - AccountsClientListByResourceGroupOptions contains the optional parameters for the AccountsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Accounts_ListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAccountsClient().NewListByResourceGroupPager("SampleResourceGroup", &armdatashare.AccountsClientListByResourceGroupOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AccountList = armdatashare.AccountList{
		// 	Value: []*armdatashare.Account{
		// 		{
		// 			Name: to.Ptr("Account1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1"),
		// 			Location: to.Ptr("West US 2"),
		// 			Tags: map[string]*string{
		// 				"tag1": to.Ptr("Red"),
		// 				"tag2": to.Ptr("White"),
		// 			},
		// 			Identity: &armdatashare.Identity{
		// 				Type: to.Ptr(armdatashare.TypeSystemAssigned),
		// 			},
		// 			Properties: &armdatashare.AccountProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 				UserEmail: to.Ptr("johnsmith@microsoft.com"),
		// 				UserName: to.Ptr("John Smith,"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Account2"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account2"),
		// 			Location: to.Ptr("East US 2"),
		// 			Identity: &armdatashare.Identity{
		// 				Type: to.Ptr(armdatashare.TypeSystemAssigned),
		// 			},
		// 			Properties: &armdatashare.AccountProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 				UserEmail: to.Ptr("johnsmith@microsoft.com"),
		// 				UserName: to.Ptr("John Smith,"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*AccountsClient) NewListBySubscriptionPager added in v0.4.0 

func (client *AccountsClient) NewListBySubscriptionPager(options *AccountsClientListBySubscriptionOptions) *runtime.Pager[AccountsClientListBySubscriptionResponse]

NewListBySubscriptionPager - List Accounts in Subscription

Generated from API version 2020-09-01

  • options - AccountsClientListBySubscriptionOptions contains the optional parameters for the AccountsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Accounts_ListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAccountsClient().NewListBySubscriptionPager(&armdatashare.AccountsClientListBySubscriptionOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AccountList = armdatashare.AccountList{
		// 	Value: []*armdatashare.Account{
		// 		{
		// 			Name: to.Ptr("Account1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1"),
		// 			Location: to.Ptr("West US 2"),
		// 			Tags: map[string]*string{
		// 				"tag1": to.Ptr("Red"),
		// 				"tag2": to.Ptr("White"),
		// 			},
		// 			Identity: &armdatashare.Identity{
		// 				Type: to.Ptr(armdatashare.TypeSystemAssigned),
		// 			},
		// 			Properties: &armdatashare.AccountProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 				UserEmail: to.Ptr("johnsmith@microsoft.com"),
		// 				UserName: to.Ptr("John Smith"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Account2"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account2"),
		// 			Location: to.Ptr("East US 2"),
		// 			Identity: &armdatashare.Identity{
		// 				Type: to.Ptr(armdatashare.TypeSystemAssigned),
		// 			},
		// 			Properties: &armdatashare.AccountProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 				UserEmail: to.Ptr("johnsmith@microsoft.com"),
		// 				UserName: to.Ptr("John Smith"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*AccountsClient) Update 

func (client *AccountsClient) Update(ctx context.Context, resourceGroupName string, accountName string, accountUpdateParameters AccountUpdateParameters, options *AccountsClientUpdateOptions) (AccountsClientUpdateResponse, error)

Update - Patch an account If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • accountUpdateParameters - The account update parameters.
  • options - AccountsClientUpdateOptions contains the optional parameters for the AccountsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Accounts_Update.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().Update(ctx, "SampleResourceGroup", "Account1", armdatashare.AccountUpdateParameters{
		Tags: map[string]*string{
			"tag1": to.Ptr("Red"),
			"tag2": to.Ptr("White"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armdatashare.Account{
	// 	Name: to.Ptr("Account1"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts"),
	// 	ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1"),
	// 	SystemData: &armdatashare.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armdatashare.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armdatashare.LastModifiedByTypeUser),
	// 	},
	// 	Location: to.Ptr("West US 2"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("Red"),
	// 		"tag2": to.Ptr("White"),
	// 	},
	// 	Identity: &armdatashare.Identity{
	// 		Type: to.Ptr(armdatashare.TypeSystemAssigned),
	// 	},
	// 	Properties: &armdatashare.AccountProperties{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
	// 		UserEmail: to.Ptr("johnsmith@microsoft.com"),
	// 		UserName: to.Ptr("John Smith"),
	// 	},
	// }
}

Output:

type AccountsClientBeginCreateOptions added in v0.2.0 

type AccountsClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AccountsClientBeginCreateOptions contains the optional parameters for the AccountsClient.BeginCreate method.

type AccountsClientBeginDeleteOptions added in v0.2.0 

type AccountsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AccountsClientBeginDeleteOptions contains the optional parameters for the AccountsClient.BeginDelete method.

type AccountsClientCreateResponse added in v0.2.0 

type AccountsClientCreateResponse struct {
	// An account data transfer object.
	Account
}

AccountsClientCreateResponse contains the response from method AccountsClient.BeginCreate.

type AccountsClientDeleteResponse added in v0.2.0 

type AccountsClientDeleteResponse struct {
	// Response for long running operation
	OperationResponse
}

AccountsClientDeleteResponse contains the response from method AccountsClient.BeginDelete.

type AccountsClientGetOptions added in v0.2.0 

type AccountsClientGetOptions struct {
}

AccountsClientGetOptions contains the optional parameters for the AccountsClient.Get method.

type AccountsClientGetResponse added in v0.2.0 

type AccountsClientGetResponse struct {
	// An account data transfer object.
	Account
}

AccountsClientGetResponse contains the response from method AccountsClient.Get.

type AccountsClientListByResourceGroupOptions added in v0.2.0 

type AccountsClientListByResourceGroupOptions struct {
	// Continuation token
	SkipToken *string
}

AccountsClientListByResourceGroupOptions contains the optional parameters for the AccountsClient.NewListByResourceGroupPager method.

type AccountsClientListByResourceGroupResponse added in v0.2.0 

type AccountsClientListByResourceGroupResponse struct {
	// List response for get Accounts.
	AccountList
}

AccountsClientListByResourceGroupResponse contains the response from method AccountsClient.NewListByResourceGroupPager.

type AccountsClientListBySubscriptionOptions added in v0.2.0 

type AccountsClientListBySubscriptionOptions struct {
	// Continuation token
	SkipToken *string
}

AccountsClientListBySubscriptionOptions contains the optional parameters for the AccountsClient.NewListBySubscriptionPager method.

type AccountsClientListBySubscriptionResponse added in v0.2.0 

type AccountsClientListBySubscriptionResponse struct {
	// List response for get Accounts.
	AccountList
}

AccountsClientListBySubscriptionResponse contains the response from method AccountsClient.NewListBySubscriptionPager.

type AccountsClientUpdateOptions added in v0.2.0 

type AccountsClientUpdateOptions struct {
}

AccountsClientUpdateOptions contains the optional parameters for the AccountsClient.Update method.

type AccountsClientUpdateResponse added in v0.2.0 

type AccountsClientUpdateResponse struct {
	// An account data transfer object.
	Account
}

AccountsClientUpdateResponse contains the response from method AccountsClient.Update.

type BlobContainerDataSet 

type BlobContainerDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// REQUIRED; Blob container data set properties.
	Properties *BlobContainerProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

BlobContainerDataSet - An Azure storage blob container data set.

func (*BlobContainerDataSet) GetDataSet added in v0.2.0 

func (b *BlobContainerDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type BlobContainerDataSet.

func (BlobContainerDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BlobContainerDataSet.

func (*BlobContainerDataSet) UnmarshalJSON 

func (b *BlobContainerDataSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobContainerDataSet.

type BlobContainerDataSetMapping 

type BlobContainerDataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// REQUIRED; Blob container data set mapping properties.
	Properties *BlobContainerMappingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

BlobContainerDataSetMapping - A Blob container data set mapping.

func (*BlobContainerDataSetMapping) GetDataSetMapping added in v0.2.0 

func (b *BlobContainerDataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type BlobContainerDataSetMapping.

func (BlobContainerDataSetMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BlobContainerDataSetMapping.

func (*BlobContainerDataSetMapping) UnmarshalJSON 

func (b *BlobContainerDataSetMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobContainerDataSetMapping.

type BlobContainerMappingProperties 

type BlobContainerMappingProperties struct {
	// REQUIRED; BLOB Container name.
	ContainerName *string

	// REQUIRED; The id of the source data set.
	DataSetID *string

	// REQUIRED; Resource group of storage account.
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set.
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account.
	SubscriptionID *string

	// READ-ONLY; Gets the status of the data set mapping.
	DataSetMappingStatus *DataSetMappingStatus

	// READ-ONLY; Provisioning state of the data set mapping.
	ProvisioningState *ProvisioningState
}

BlobContainerMappingProperties - Azure storage Blob container data set mapping property bag.

func (BlobContainerMappingProperties) MarshalJSON added in v1.1.0 

func (b BlobContainerMappingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BlobContainerMappingProperties.

func (*BlobContainerMappingProperties) UnmarshalJSON added in v1.1.0 

func (b *BlobContainerMappingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobContainerMappingProperties.

type BlobContainerProperties 

type BlobContainerProperties struct {
	// REQUIRED; BLOB Container name.
	ContainerName *string

	// REQUIRED; Resource group of storage account
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account
	SubscriptionID *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string
}

BlobContainerProperties - Properties of the BLOB container data set.

func (BlobContainerProperties) MarshalJSON added in v1.1.0 

func (b BlobContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BlobContainerProperties.

func (*BlobContainerProperties) UnmarshalJSON added in v1.1.0 

func (b *BlobContainerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobContainerProperties.

type BlobDataSet 

type BlobDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// REQUIRED; Blob data set properties.
	Properties *BlobProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

BlobDataSet - An Azure storage blob data set.

func (*BlobDataSet) GetDataSet added in v0.2.0 

func (b *BlobDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type BlobDataSet.

func (BlobDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BlobDataSet.

func (*BlobDataSet) UnmarshalJSON 

func (b *BlobDataSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobDataSet.

type BlobDataSetMapping 

type BlobDataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// REQUIRED; Blob data set mapping properties.
	Properties *BlobMappingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

BlobDataSetMapping - A Blob data set mapping.

func (*BlobDataSetMapping) GetDataSetMapping added in v0.2.0 

func (b *BlobDataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type BlobDataSetMapping.

func (BlobDataSetMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BlobDataSetMapping.

func (*BlobDataSetMapping) UnmarshalJSON 

func (b *BlobDataSetMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobDataSetMapping.

type BlobFolderDataSet 

type BlobFolderDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// REQUIRED; Blob folder data set properties.
	Properties *BlobFolderProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

BlobFolderDataSet - An Azure storage blob folder data set.

func (*BlobFolderDataSet) GetDataSet added in v0.2.0 

func (b *BlobFolderDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type BlobFolderDataSet.

func (BlobFolderDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BlobFolderDataSet.

func (*BlobFolderDataSet) UnmarshalJSON 

func (b *BlobFolderDataSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobFolderDataSet.

type BlobFolderDataSetMapping 

type BlobFolderDataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// REQUIRED; Blob folder data set mapping properties.
	Properties *BlobFolderMappingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

BlobFolderDataSetMapping - A Blob folder data set mapping.

func (*BlobFolderDataSetMapping) GetDataSetMapping added in v0.2.0 

func (b *BlobFolderDataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type BlobFolderDataSetMapping.

func (BlobFolderDataSetMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type BlobFolderDataSetMapping.

func (*BlobFolderDataSetMapping) UnmarshalJSON 

func (b *BlobFolderDataSetMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobFolderDataSetMapping.

type BlobFolderMappingProperties 

type BlobFolderMappingProperties struct {
	// REQUIRED; Container that has the file path.
	ContainerName *string

	// REQUIRED; The id of the source data set.
	DataSetID *string

	// REQUIRED; Prefix for blob folder
	Prefix *string

	// REQUIRED; Resource group of storage account.
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set.
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account.
	SubscriptionID *string

	// READ-ONLY; Gets the status of the data set mapping.
	DataSetMappingStatus *DataSetMappingStatus

	// READ-ONLY; Provisioning state of the data set mapping.
	ProvisioningState *ProvisioningState
}

BlobFolderMappingProperties - Azure storage Blob folder data set mapping property bag.

func (BlobFolderMappingProperties) MarshalJSON added in v1.1.0 

func (b BlobFolderMappingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BlobFolderMappingProperties.

func (*BlobFolderMappingProperties) UnmarshalJSON added in v1.1.0 

func (b *BlobFolderMappingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobFolderMappingProperties.

type BlobFolderProperties 

type BlobFolderProperties struct {
	// REQUIRED; Container that has the file path.
	ContainerName *string

	// REQUIRED; Prefix for blob folder
	Prefix *string

	// REQUIRED; Resource group of storage account
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account
	SubscriptionID *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string
}

BlobFolderProperties - Properties of the blob folder data set.

func (BlobFolderProperties) MarshalJSON added in v1.1.0 

func (b BlobFolderProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BlobFolderProperties.

func (*BlobFolderProperties) UnmarshalJSON added in v1.1.0 

func (b *BlobFolderProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobFolderProperties.

type BlobMappingProperties 

type BlobMappingProperties struct {
	// REQUIRED; Container that has the file path.
	ContainerName *string

	// REQUIRED; The id of the source data set.
	DataSetID *string

	// REQUIRED; File path within the source data set
	FilePath *string

	// REQUIRED; Resource group of storage account.
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set.
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account.
	SubscriptionID *string

	// File output type
	OutputType *OutputType

	// READ-ONLY; Gets the status of the data set mapping.
	DataSetMappingStatus *DataSetMappingStatus

	// READ-ONLY; Provisioning state of the data set mapping.
	ProvisioningState *ProvisioningState
}

BlobMappingProperties - Azure storage Blob data set mapping property bag.

func (BlobMappingProperties) MarshalJSON added in v1.1.0 

func (b BlobMappingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BlobMappingProperties.

func (*BlobMappingProperties) UnmarshalJSON added in v1.1.0 

func (b *BlobMappingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobMappingProperties.

type BlobProperties 

type BlobProperties struct {
	// REQUIRED; Container that has the file path.
	ContainerName *string

	// REQUIRED; File path within the source data set
	FilePath *string

	// REQUIRED; Resource group of storage account
	ResourceGroup *string

	// REQUIRED; Storage account name of the source data set
	StorageAccountName *string

	// REQUIRED; Subscription id of storage account
	SubscriptionID *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string
}

BlobProperties - Properties of the blob data set.

func (BlobProperties) MarshalJSON added in v1.1.0 

func (b BlobProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BlobProperties.

func (*BlobProperties) UnmarshalJSON added in v1.1.0 

func (b *BlobProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BlobProperties.

type ClientFactory added in v1.1.0 

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 added in v1.1.0 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.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.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewAccountsClient added in v1.1.0 

func (c *ClientFactory) NewAccountsClient() *AccountsClient

NewAccountsClient creates a new instance of AccountsClient.

func (*ClientFactory) NewConsumerInvitationsClient added in v1.1.0 

func (c *ClientFactory) NewConsumerInvitationsClient() *ConsumerInvitationsClient

NewConsumerInvitationsClient creates a new instance of ConsumerInvitationsClient.

func (*ClientFactory) NewConsumerSourceDataSetsClient added in v1.1.0 

func (c *ClientFactory) NewConsumerSourceDataSetsClient() *ConsumerSourceDataSetsClient

NewConsumerSourceDataSetsClient creates a new instance of ConsumerSourceDataSetsClient.

func (*ClientFactory) NewDataSetMappingsClient added in v1.1.0 

func (c *ClientFactory) NewDataSetMappingsClient() *DataSetMappingsClient

NewDataSetMappingsClient creates a new instance of DataSetMappingsClient.

func (*ClientFactory) NewDataSetsClient added in v1.1.0 

func (c *ClientFactory) NewDataSetsClient() *DataSetsClient

NewDataSetsClient creates a new instance of DataSetsClient.

func (*ClientFactory) NewEmailRegistrationsClient added in v1.1.0 

func (c *ClientFactory) NewEmailRegistrationsClient() *EmailRegistrationsClient

NewEmailRegistrationsClient creates a new instance of EmailRegistrationsClient.

func (*ClientFactory) NewInvitationsClient added in v1.1.0 

func (c *ClientFactory) NewInvitationsClient() *InvitationsClient

NewInvitationsClient creates a new instance of InvitationsClient.

func (*ClientFactory) NewOperationsClient added in v1.1.0 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewProviderShareSubscriptionsClient added in v1.1.0 

func (c *ClientFactory) NewProviderShareSubscriptionsClient() *ProviderShareSubscriptionsClient

NewProviderShareSubscriptionsClient creates a new instance of ProviderShareSubscriptionsClient.

func (*ClientFactory) NewShareSubscriptionsClient added in v1.1.0 

func (c *ClientFactory) NewShareSubscriptionsClient() *ShareSubscriptionsClient

NewShareSubscriptionsClient creates a new instance of ShareSubscriptionsClient.

func (*ClientFactory) NewSharesClient added in v1.1.0 

func (c *ClientFactory) NewSharesClient() *SharesClient

NewSharesClient creates a new instance of SharesClient.

func (*ClientFactory) NewSynchronizationSettingsClient added in v1.1.0 

func (c *ClientFactory) NewSynchronizationSettingsClient() *SynchronizationSettingsClient

NewSynchronizationSettingsClient creates a new instance of SynchronizationSettingsClient.

func (*ClientFactory) NewTriggersClient added in v1.1.0 

func (c *ClientFactory) NewTriggersClient() *TriggersClient

NewTriggersClient creates a new instance of TriggersClient.

type ConsumerInvitation 

type ConsumerInvitation struct {
	// REQUIRED; Properties on the account
	Properties *ConsumerInvitationProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ConsumerInvitation - A consumer Invitation data transfer object.

func (ConsumerInvitation) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConsumerInvitation.

func (*ConsumerInvitation) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConsumerInvitation.

type ConsumerInvitationList 

type ConsumerInvitationList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []*ConsumerInvitation

	// The Url of next result page.
	NextLink *string
}

ConsumerInvitationList - List response for get InvitationList

func (ConsumerInvitationList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConsumerInvitationList.

func (*ConsumerInvitationList) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConsumerInvitationList.

type ConsumerInvitationProperties 

type ConsumerInvitationProperties struct {
	// REQUIRED; Unique id of the invitation.
	InvitationID *string

	// READ-ONLY; Number of data sets in a share
	DataSetCount *int32

	// READ-ONLY; Description shared when the invitation was created
	Description *string

	// READ-ONLY; The expiration date for the share subscription created by accepting the invitation.
	ExpirationDate *time.Time

	// READ-ONLY; The status of the invitation.
	InvitationStatus *InvitationStatus

	// READ-ONLY; invitation location
	Location *string

	// READ-ONLY; Email of the provider who created the resource
	ProviderEmail *string

	// READ-ONLY; Name of the provider who created the resource
	ProviderName *string

	// READ-ONLY; Tenant name of the provider who created the resource
	ProviderTenantName *string

	// READ-ONLY; The time the recipient responded to the invitation.
	RespondedAt *time.Time

	// READ-ONLY; Gets the time at which the invitation was sent.
	SentAt *time.Time

	// READ-ONLY; Gets the source share Name.
	ShareName *string

	// READ-ONLY; Terms of use shared when the invitation was created
	TermsOfUse *string

	// READ-ONLY; Email of the user who created the resource
	UserEmail *string

	// READ-ONLY; Name of the user who created the resource
	UserName *string
}

ConsumerInvitationProperties - Properties of consumer invitation

func (ConsumerInvitationProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConsumerInvitationProperties.

func (*ConsumerInvitationProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConsumerInvitationProperties.

type ConsumerInvitationsClient 

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

ConsumerInvitationsClient contains the methods for the ConsumerInvitations group. Don't use this type directly, use NewConsumerInvitationsClient() instead.

func NewConsumerInvitationsClient 

func NewConsumerInvitationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ConsumerInvitationsClient, error)

NewConsumerInvitationsClient creates a new instance of ConsumerInvitationsClient with the specified values.

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

func (*ConsumerInvitationsClient) Get 

func (client *ConsumerInvitationsClient) Get(ctx context.Context, location string, invitationID string, options *ConsumerInvitationsClientGetOptions) (ConsumerInvitationsClientGetResponse, error)

Get - Get an invitation If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • location - Location of the invitation
  • invitationID - An invitation id
  • options - ConsumerInvitationsClientGetOptions contains the optional parameters for the ConsumerInvitationsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ConsumerInvitations_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewConsumerInvitationsClient().Get(ctx, "East US 2", "dfbbc788-19eb-4607-a5a1-c74181bfff03", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ConsumerInvitation = armdatashare.ConsumerInvitation{
	// 	Name: to.Ptr("invitation1"),
	// 	Type: to.Ptr("Microsoft.DataShare/locations/consumerInvitations"),
	// 	ID: to.Ptr("providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487"),
	// 	Properties: &armdatashare.ConsumerInvitationProperties{
	// 		Description: to.Ptr("Some share"),
	// 		DataSetCount: to.Ptr[int32](1),
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
	// 		InvitationID: to.Ptr("4256e2cf-0f82-4865-961b-12f83333f487"),
	// 		InvitationStatus: to.Ptr(armdatashare.InvitationStatusAccepted),
	// 		Location: to.Ptr("eastus2"),
	// 		ProviderEmail: to.Ptr("john.smith@microsoft.com"),
	// 		ProviderName: to.Ptr("John Smith"),
	// 		ProviderTenantName: to.Ptr("Microsoft"),
	// 		RespondedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-01-15T02:01:51.895Z"); return t}()),
	// 		SentAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-01-15T01:45:25.622Z"); return t}()),
	// 		ShareName: to.Ptr("share1"),
	// 		TermsOfUse: to.Ptr("Confidential"),
	// 	},
	// }
}

Output:

func (*ConsumerInvitationsClient) NewListInvitationsPager added in v0.4.0 

func (client *ConsumerInvitationsClient) NewListInvitationsPager(options *ConsumerInvitationsClientListInvitationsOptions) *runtime.Pager[ConsumerInvitationsClientListInvitationsResponse]

NewListInvitationsPager - Lists invitations

Generated from API version 2020-09-01

  • options - ConsumerInvitationsClientListInvitationsOptions contains the optional parameters for the ConsumerInvitationsClient.NewListInvitationsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ConsumerInvitations_ListInvitations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewConsumerInvitationsClient().NewListInvitationsPager(&armdatashare.ConsumerInvitationsClientListInvitationsOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ConsumerInvitationList = armdatashare.ConsumerInvitationList{
		// 	Value: []*armdatashare.ConsumerInvitation{
		// 		{
		// 			Name: to.Ptr("invitation1"),
		// 			Type: to.Ptr("Microsoft.DataShare/locations/consumerInvitations"),
		// 			ID: to.Ptr("providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487"),
		// 			Properties: &armdatashare.ConsumerInvitationProperties{
		// 				Description: to.Ptr("Some share"),
		// 				DataSetCount: to.Ptr[int32](1),
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
		// 				InvitationID: to.Ptr("4256e2cf-0f82-4865-961b-12f83333f487"),
		// 				InvitationStatus: to.Ptr(armdatashare.InvitationStatusAccepted),
		// 				Location: to.Ptr("eastus2"),
		// 				ProviderEmail: to.Ptr("john.smith@microsoft.com"),
		// 				ProviderName: to.Ptr("John Smith"),
		// 				ProviderTenantName: to.Ptr("microsoft"),
		// 				RespondedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-01-15T02:01:51.895Z"); return t}()),
		// 				SentAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-01-15T01:45:25.622Z"); return t}()),
		// 				ShareName: to.Ptr("share1"),
		// 				TermsOfUse: to.Ptr("Confidential"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*ConsumerInvitationsClient) RejectInvitation 

func (client *ConsumerInvitationsClient) RejectInvitation(ctx context.Context, location string, invitation ConsumerInvitation, options *ConsumerInvitationsClientRejectInvitationOptions) (ConsumerInvitationsClientRejectInvitationResponse, error)

RejectInvitation - Reject an invitation If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • location - Location of the invitation
  • invitation - An invitation payload
  • options - ConsumerInvitationsClientRejectInvitationOptions contains the optional parameters for the ConsumerInvitationsClient.RejectInvitation method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ConsumerInvitations_RejectInvitation.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewConsumerInvitationsClient().RejectInvitation(ctx, "East US 2", armdatashare.ConsumerInvitation{
		Properties: &armdatashare.ConsumerInvitationProperties{
			InvitationID: to.Ptr("dfbbc788-19eb-4607-a5a1-c74181bfff03"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ConsumerInvitation = armdatashare.ConsumerInvitation{
	// 	Name: to.Ptr("invitation1"),
	// 	Type: to.Ptr("Microsoft.DataShare/locations/consumerInvitations"),
	// 	ID: to.Ptr("providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487"),
	// 	Properties: &armdatashare.ConsumerInvitationProperties{
	// 		Description: to.Ptr("Some share"),
	// 		DataSetCount: to.Ptr[int32](1),
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
	// 		InvitationID: to.Ptr("4256e2cf-0f82-4865-961b-12f83333f487"),
	// 		InvitationStatus: to.Ptr(armdatashare.InvitationStatusRejected),
	// 		Location: to.Ptr("eastus2"),
	// 		ProviderEmail: to.Ptr("john.smith@microsoft.com"),
	// 		ProviderName: to.Ptr("John Smith"),
	// 		ProviderTenantName: to.Ptr("microsoft"),
	// 		RespondedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-01-15T02:01:51.895Z"); return t}()),
	// 		SentAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-01-15T01:45:25.622Z"); return t}()),
	// 		ShareName: to.Ptr("share1"),
	// 		TermsOfUse: to.Ptr("Confidential"),
	// 	},
	// }
}

Output:

type ConsumerInvitationsClientGetOptions added in v0.2.0 

type ConsumerInvitationsClientGetOptions struct {
}

ConsumerInvitationsClientGetOptions contains the optional parameters for the ConsumerInvitationsClient.Get method.

type ConsumerInvitationsClientGetResponse added in v0.2.0 

type ConsumerInvitationsClientGetResponse struct {
	// A consumer Invitation data transfer object.
	ConsumerInvitation
}

ConsumerInvitationsClientGetResponse contains the response from method ConsumerInvitationsClient.Get.

type ConsumerInvitationsClientListInvitationsOptions added in v0.2.0 

type ConsumerInvitationsClientListInvitationsOptions struct {
	// The continuation token
	SkipToken *string
}

ConsumerInvitationsClientListInvitationsOptions contains the optional parameters for the ConsumerInvitationsClient.NewListInvitationsPager method.

type ConsumerInvitationsClientListInvitationsResponse added in v0.2.0 

type ConsumerInvitationsClientListInvitationsResponse struct {
	// List response for get InvitationList
	ConsumerInvitationList
}

ConsumerInvitationsClientListInvitationsResponse contains the response from method ConsumerInvitationsClient.NewListInvitationsPager.

type ConsumerInvitationsClientRejectInvitationOptions added in v0.2.0 

type ConsumerInvitationsClientRejectInvitationOptions struct {
}

ConsumerInvitationsClientRejectInvitationOptions contains the optional parameters for the ConsumerInvitationsClient.RejectInvitation method.

type ConsumerInvitationsClientRejectInvitationResponse added in v0.2.0 

type ConsumerInvitationsClientRejectInvitationResponse struct {
	// A consumer Invitation data transfer object.
	ConsumerInvitation
}

ConsumerInvitationsClientRejectInvitationResponse contains the response from method ConsumerInvitationsClient.RejectInvitation.

type ConsumerSourceDataSet 

type ConsumerSourceDataSet struct {
	// source dataSet properties
	Properties *ConsumerSourceDataSetProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ConsumerSourceDataSet - A consumer side dataSet data transfer object.

func (ConsumerSourceDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConsumerSourceDataSet.

func (*ConsumerSourceDataSet) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConsumerSourceDataSet.

type ConsumerSourceDataSetList 

type ConsumerSourceDataSetList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []*ConsumerSourceDataSet

	// The Url of next result page.
	NextLink *string
}

ConsumerSourceDataSetList - A consumer side list of source dataSets

func (ConsumerSourceDataSetList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConsumerSourceDataSetList.

func (*ConsumerSourceDataSetList) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConsumerSourceDataSetList.

type ConsumerSourceDataSetProperties 

type ConsumerSourceDataSetProperties struct {
	// READ-ONLY; DataSet Id
	DataSetID *string

	// READ-ONLY; Location of the data set.
	DataSetLocation *string

	// READ-ONLY; DataSet name
	DataSetName *string

	// READ-ONLY; DataSet path
	DataSetPath *string

	// READ-ONLY; Type of data set
	DataSetType *DataSetType
}

ConsumerSourceDataSetProperties - Properties of consumer source dataSet

func (ConsumerSourceDataSetProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type ConsumerSourceDataSetProperties.

func (*ConsumerSourceDataSetProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConsumerSourceDataSetProperties.

type ConsumerSourceDataSetsClient 

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

ConsumerSourceDataSetsClient contains the methods for the ConsumerSourceDataSets group. Don't use this type directly, use NewConsumerSourceDataSetsClient() instead.

func NewConsumerSourceDataSetsClient 

func NewConsumerSourceDataSetsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConsumerSourceDataSetsClient, error)

NewConsumerSourceDataSetsClient creates a new instance of ConsumerSourceDataSetsClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ConsumerSourceDataSetsClient) NewListByShareSubscriptionPager added in v0.4.0 

func (client *ConsumerSourceDataSetsClient) NewListByShareSubscriptionPager(resourceGroupName string, accountName string, shareSubscriptionName string, options *ConsumerSourceDataSetsClientListByShareSubscriptionOptions) *runtime.Pager[ConsumerSourceDataSetsClientListByShareSubscriptionResponse]

NewListByShareSubscriptionPager - Get source dataSets of a shareSubscription

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the shareSubscription.
  • options - ConsumerSourceDataSetsClientListByShareSubscriptionOptions contains the optional parameters for the ConsumerSourceDataSetsClient.NewListByShareSubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ConsumerSourceDataSets_ListByShareSubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewConsumerSourceDataSetsClient().NewListByShareSubscriptionPager("SampleResourceGroup", "Account1", "Share1", &armdatashare.ConsumerSourceDataSetsClientListByShareSubscriptionOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ConsumerSourceDataSetList = armdatashare.ConsumerSourceDataSetList{
		// 	Value: []*armdatashare.ConsumerSourceDataSet{
		// 		{
		// 			Name: to.Ptr("invitation1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/sharesubscriptions/consumerSourceDataSets"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/consumerSourceDataSets/4256e2cf-0f82-4865-961b-12f83333f487"),
		// 			Properties: &armdatashare.ConsumerSourceDataSetProperties{
		// 				DataSetID: to.Ptr("0b9d4394-8bb3-49a1-aa4f-4be49cd10375"),
		// 				DataSetName: to.Ptr("input.text"),
		// 				DataSetPath: to.Ptr("cars.text"),
		// 				DataSetType: to.Ptr(armdatashare.DataSetTypeBlob),
		// 			},
		// 	}},
		// }
	}
}

Output:

type ConsumerSourceDataSetsClientListByShareSubscriptionOptions added in v0.2.0 

type ConsumerSourceDataSetsClientListByShareSubscriptionOptions struct {
	// Continuation token
	SkipToken *string
}

ConsumerSourceDataSetsClientListByShareSubscriptionOptions contains the optional parameters for the ConsumerSourceDataSetsClient.NewListByShareSubscriptionPager method.

type ConsumerSourceDataSetsClientListByShareSubscriptionResponse added in v0.2.0 

type ConsumerSourceDataSetsClientListByShareSubscriptionResponse struct {
	// A consumer side list of source dataSets
	ConsumerSourceDataSetList
}

ConsumerSourceDataSetsClientListByShareSubscriptionResponse contains the response from method ConsumerSourceDataSetsClient.NewListByShareSubscriptionPager.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type DataSet 

type DataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

DataSet - A DataSet data transfer object.

func (*DataSet) GetDataSet 

func (d *DataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type DataSet.

func (DataSet) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type DataSet.

func (*DataSet) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataSet.

type DataSetClassification 

type DataSetClassification interface {
	// GetDataSet returns the DataSet content of the underlying type.
	GetDataSet() *DataSet
}

DataSetClassification provides polymorphic access to related types. Call the interface's GetDataSet() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ADLSGen1FileDataSet, *ADLSGen1FolderDataSet, *ADLSGen2FileDataSet, *ADLSGen2FileSystemDataSet, *ADLSGen2FolderDataSet, - *BlobContainerDataSet, *BlobDataSet, *BlobFolderDataSet, *DataSet, *KustoClusterDataSet, *KustoDatabaseDataSet, *SQLDBTableDataSet, - *SQLDWTableDataSet, *SynapseWorkspaceSQLPoolTableDataSet

type DataSetKind 

type DataSetKind string

DataSetKind - Kind of data set. 

const (
	DataSetKindAdlsGen1File                 DataSetKind = "AdlsGen1File"
	DataSetKindAdlsGen1Folder               DataSetKind = "AdlsGen1Folder"
	DataSetKindAdlsGen2File                 DataSetKind = "AdlsGen2File"
	DataSetKindAdlsGen2FileSystem           DataSetKind = "AdlsGen2FileSystem"
	DataSetKindAdlsGen2Folder               DataSetKind = "AdlsGen2Folder"
	DataSetKindBlob                         DataSetKind = "Blob"
	DataSetKindBlobFolder                   DataSetKind = "BlobFolder"
	DataSetKindContainer                    DataSetKind = "Container"
	DataSetKindKustoCluster                 DataSetKind = "KustoCluster"
	DataSetKindKustoDatabase                DataSetKind = "KustoDatabase"
	DataSetKindSQLDBTable                   DataSetKind = "SqlDBTable"
	DataSetKindSQLDWTable                   DataSetKind = "SqlDWTable"
	DataSetKindSynapseWorkspaceSQLPoolTable DataSetKind = "SynapseWorkspaceSqlPoolTable"
)

func PossibleDataSetKindValues 

func PossibleDataSetKindValues() []DataSetKind

PossibleDataSetKindValues returns the possible values for the DataSetKind const type.

type DataSetList 

type DataSetList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []DataSetClassification

	// The Url of next result page.
	NextLink *string
}

DataSetList - List response for get DataSets

func (DataSetList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DataSetList.

func (*DataSetList) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataSetList.

type DataSetMapping 

type DataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

DataSetMapping - A data set mapping data transfer object.

func (*DataSetMapping) GetDataSetMapping 

func (d *DataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type DataSetMapping.

func (DataSetMapping) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type DataSetMapping.

func (*DataSetMapping) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataSetMapping.

type DataSetMappingClassification 

type DataSetMappingClassification interface {
	// GetDataSetMapping returns the DataSetMapping content of the underlying type.
	GetDataSetMapping() *DataSetMapping
}

DataSetMappingClassification provides polymorphic access to related types. Call the interface's GetDataSetMapping() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ADLSGen2FileDataSetMapping, *ADLSGen2FileSystemDataSetMapping, *ADLSGen2FolderDataSetMapping, *BlobContainerDataSetMapping, - *BlobDataSetMapping, *BlobFolderDataSetMapping, *DataSetMapping, *KustoClusterDataSetMapping, *KustoDatabaseDataSetMapping, - *SQLDBTableDataSetMapping, *SQLDWTableDataSetMapping, *SynapseWorkspaceSQLPoolTableDataSetMapping

type DataSetMappingKind 

type DataSetMappingKind string

DataSetMappingKind - Kind of data set mapping. 

const (
	DataSetMappingKindAdlsGen2File                 DataSetMappingKind = "AdlsGen2File"
	DataSetMappingKindAdlsGen2FileSystem           DataSetMappingKind = "AdlsGen2FileSystem"
	DataSetMappingKindAdlsGen2Folder               DataSetMappingKind = "AdlsGen2Folder"
	DataSetMappingKindBlob                         DataSetMappingKind = "Blob"
	DataSetMappingKindBlobFolder                   DataSetMappingKind = "BlobFolder"
	DataSetMappingKindContainer                    DataSetMappingKind = "Container"
	DataSetMappingKindKustoCluster                 DataSetMappingKind = "KustoCluster"
	DataSetMappingKindKustoDatabase                DataSetMappingKind = "KustoDatabase"
	DataSetMappingKindSQLDBTable                   DataSetMappingKind = "SqlDBTable"
	DataSetMappingKindSQLDWTable                   DataSetMappingKind = "SqlDWTable"
	DataSetMappingKindSynapseWorkspaceSQLPoolTable DataSetMappingKind = "SynapseWorkspaceSqlPoolTable"
)

func PossibleDataSetMappingKindValues 

func PossibleDataSetMappingKindValues() []DataSetMappingKind

PossibleDataSetMappingKindValues returns the possible values for the DataSetMappingKind const type.

type DataSetMappingList 

type DataSetMappingList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []DataSetMappingClassification

	// The Url of next result page.
	NextLink *string
}

DataSetMappingList - List response for get DataSetMappings

func (DataSetMappingList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DataSetMappingList.

func (*DataSetMappingList) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataSetMappingList.

type DataSetMappingStatus 

type DataSetMappingStatus string

DataSetMappingStatus - Gets the status of the data set mapping. 

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

func PossibleDataSetMappingStatusValues 

func PossibleDataSetMappingStatusValues() []DataSetMappingStatus

PossibleDataSetMappingStatusValues returns the possible values for the DataSetMappingStatus const type.

type DataSetMappingsClient 

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

DataSetMappingsClient contains the methods for the DataSetMappings group. Don't use this type directly, use NewDataSetMappingsClient() instead.

func NewDataSetMappingsClient 

func NewDataSetMappingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DataSetMappingsClient, error)

NewDataSetMappingsClient creates a new instance of DataSetMappingsClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DataSetMappingsClient) Create 

func (client *DataSetMappingsClient) Create(ctx context.Context, resourceGroupName string, accountName string, shareSubscriptionName string, dataSetMappingName string, dataSetMapping DataSetMappingClassification, options *DataSetMappingsClientCreateOptions) (DataSetMappingsClientCreateResponse, error)

Create - Create a DataSetMapping If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the share subscription which will hold the data set sink.
  • dataSetMappingName - The name of the data set mapping to be created.
  • dataSetMapping - Destination data set configuration details.
  • options - DataSetMappingsClientCreateOptions contains the optional parameters for the DataSetMappingsClient.Create method.
Example (DataSetMappingsCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSetMappings_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetMappingsClient().Create(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", "DatasetMapping1", &armdatashare.BlobDataSetMapping{
		Kind: to.Ptr(armdatashare.DataSetMappingKindBlob),
		Properties: &armdatashare.BlobMappingProperties{
			ContainerName:      to.Ptr("C1"),
			DataSetID:          to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
			FilePath:           to.Ptr("file21"),
			ResourceGroup:      to.Ptr("SampleResourceGroup"),
			StorageAccountName: to.Ptr("storage2"),
			SubscriptionID:     to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetMappingsClientCreateResponse{
	// 	                            DataSetMappingClassification: &armdatashare.BlobDataSetMapping{
	// 		Name: to.Ptr("DatasetMapping1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1"),
	// 		Kind: to.Ptr(armdatashare.DataSetMappingKindBlob),
	// 		Properties: &armdatashare.BlobMappingProperties{
	// 			ContainerName: to.Ptr("C1"),
	// 			DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
	// 			FilePath: to.Ptr("file21"),
	// 			ResourceGroup: to.Ptr("SampleResourceGroup"),
	// 			StorageAccountName: to.Ptr("storage2"),
	// 			SubscriptionID: to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
	// 		},
	// 	},
	// 	                        }
}

Output:
Example (DataSetMappingsSqlDbCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSetMappings_SqlDB_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetMappingsClient().Create(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", "DatasetMapping1", &armdatashare.SQLDBTableDataSetMapping{
		Kind: to.Ptr(armdatashare.DataSetMappingKindSQLDBTable),
		Properties: &armdatashare.SQLDBTableDataSetMappingProperties{
			DataSetID:           to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
			DatabaseName:        to.Ptr("Database1"),
			SchemaName:          to.Ptr("dbo"),
			SQLServerResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1"),
			TableName:           to.Ptr("Table1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetMappingsClientCreateResponse{
	// 	                            DataSetMappingClassification: &armdatashare.SQLDBTableDataSetMapping{
	// 		Name: to.Ptr("DatasetMapping1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1"),
	// 		Kind: to.Ptr(armdatashare.DataSetMappingKindSQLDBTable),
	// 		Properties: &armdatashare.SQLDBTableDataSetMappingProperties{
	// 			DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
	// 			DatabaseName: to.Ptr("Database1"),
	// 			SchemaName: to.Ptr("dbo"),
	// 			SQLServerResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1"),
	// 			TableName: to.Ptr("Table1"),
	// 		},
	// 	},
	// 	                        }
}

Output:
Example (DataSetMappingsSqlDwCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSetMappings_SqlDW_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetMappingsClient().Create(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", "DatasetMapping1", &armdatashare.SQLDWTableDataSetMapping{
		Kind: to.Ptr(armdatashare.DataSetMappingKindSQLDWTable),
		Properties: &armdatashare.SQLDWTableDataSetMappingProperties{
			DataSetID:           to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
			DataWarehouseName:   to.Ptr("DataWarehouse1"),
			SchemaName:          to.Ptr("dbo"),
			SQLServerResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1"),
			TableName:           to.Ptr("Table1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetMappingsClientCreateResponse{
	// 	                            DataSetMappingClassification: &armdatashare.SQLDWTableDataSetMapping{
	// 		Name: to.Ptr("DatasetMapping1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1"),
	// 		Kind: to.Ptr(armdatashare.DataSetMappingKindSQLDWTable),
	// 		Properties: &armdatashare.SQLDWTableDataSetMappingProperties{
	// 			DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
	// 			DataWarehouseName: to.Ptr("DataWarehouse1"),
	// 			SchemaName: to.Ptr("dbo"),
	// 			SQLServerResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1"),
	// 			TableName: to.Ptr("Table1"),
	// 		},
	// 	},
	// 	                        }
}

Output:
Example (DataSetMappingsSqlDwDataSetToAdlsGen2FileCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSetMappings_SqlDWDataSetToAdlsGen2File_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetMappingsClient().Create(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", "DatasetMapping1", &armdatashare.ADLSGen2FileDataSetMapping{
		Kind: to.Ptr(armdatashare.DataSetMappingKindAdlsGen2File),
		Properties: &armdatashare.ADLSGen2FileDataSetMappingProperties{
			DataSetID:          to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
			FilePath:           to.Ptr("file21"),
			FileSystem:         to.Ptr("fileSystem"),
			OutputType:         to.Ptr(armdatashare.OutputTypeCSV),
			ResourceGroup:      to.Ptr("SampleResourceGroup"),
			StorageAccountName: to.Ptr("storage2"),
			SubscriptionID:     to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetMappingsClientCreateResponse{
	// 	                            DataSetMappingClassification: &armdatashare.ADLSGen2FileDataSetMapping{
	// 		Name: to.Ptr("DatasetMapping1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1"),
	// 		Kind: to.Ptr(armdatashare.DataSetMappingKindAdlsGen2File),
	// 		Properties: &armdatashare.ADLSGen2FileDataSetMappingProperties{
	// 			DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
	// 			FilePath: to.Ptr("file21"),
	// 			FileSystem: to.Ptr("fileSystem"),
	// 			OutputType: to.Ptr(armdatashare.OutputTypeCSV),
	// 			ResourceGroup: to.Ptr("SampleResourceGroup"),
	// 			StorageAccountName: to.Ptr("storage2"),
	// 			SubscriptionID: to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
	// 		},
	// 	},
	// 	                        }
}

Output:
Example (DataSetMappingsSynapseWorkspaceSqlPoolTableCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSetMappings_SynapseWorkspaceSqlPoolTable_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetMappingsClient().Create(ctx, "SampleResourceGroup", "consumerAccount", "ShareSubscription1", "datasetMappingName1", &armdatashare.SynapseWorkspaceSQLPoolTableDataSetMapping{
		Kind: to.Ptr(armdatashare.DataSetMappingKindSynapseWorkspaceSQLPoolTable),
		Properties: &armdatashare.SynapseWorkspaceSQLPoolTableDataSetMappingProperties{
			DataSetID:                              to.Ptr("3dc64e49-1fc3-4186-b3dc-d388c4d3076a"),
			SynapseWorkspaceSQLPoolTableResourceID: to.Ptr("/subscriptions/0f3dcfc3-18f8-4099-b381-8353e19d43a7/resourceGroups/SampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/sqlPools/ExampleSqlPool/schemas/dbo/tables/table1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetMappingsClientCreateResponse{
	// 	                            DataSetMappingClassification: &armdatashare.SynapseWorkspaceSQLPoolTableDataSetMapping{
	// 		Name: to.Ptr("datasetMappingName"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings"),
	// 		ID: to.Ptr("/subscriptions/4e745bb7-c420-479b-b0d6-a0f92d48a227/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/consumerAccount/shareSubscriptions/ShareSubscription1/dataSetMappings/datasetMappingName1"),
	// 		Kind: to.Ptr(armdatashare.DataSetMappingKindSynapseWorkspaceSQLPoolTable),
	// 		Properties: &armdatashare.SynapseWorkspaceSQLPoolTableDataSetMappingProperties{
	// 			DataSetID: to.Ptr("3dc64e49-1fc3-4186-b3dc-d388c4d3076a"),
	// 			DataSetMappingStatus: to.Ptr(armdatashare.DataSetMappingStatusOk),
	// 			ProvisioningState: to.Ptr(armdatashare.ProvisioningStateSucceeded),
	// 			SynapseWorkspaceSQLPoolTableResourceID: to.Ptr("/subscriptions/0f3dcfc3-18f8-4099-b381-8353e19d43a7/resourceGroups/SampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/sqlPools/ExampleSqlPool/schemas/dbo/tables/table1"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*DataSetMappingsClient) Delete 

func (client *DataSetMappingsClient) Delete(ctx context.Context, resourceGroupName string, accountName string, shareSubscriptionName string, dataSetMappingName string, options *DataSetMappingsClientDeleteOptions) (DataSetMappingsClientDeleteResponse, error)

Delete - Delete a DataSetMapping in a shareSubscription If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the shareSubscription.
  • dataSetMappingName - The name of the dataSetMapping.
  • options - DataSetMappingsClientDeleteOptions contains the optional parameters for the DataSetMappingsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSetMappings_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewDataSetMappingsClient().Delete(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", "DatasetMapping1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*DataSetMappingsClient) Get 

func (client *DataSetMappingsClient) Get(ctx context.Context, resourceGroupName string, accountName string, shareSubscriptionName string, dataSetMappingName string, options *DataSetMappingsClientGetOptions) (DataSetMappingsClientGetResponse, error)

Get - Get a DataSetMapping in a shareSubscription If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the shareSubscription.
  • dataSetMappingName - The name of the dataSetMapping.
  • options - DataSetMappingsClientGetOptions contains the optional parameters for the DataSetMappingsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSetMappings_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetMappingsClient().Get(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", "DatasetMapping1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetMappingsClientGetResponse{
	// 	                            DataSetMappingClassification: &armdatashare.BlobDataSetMapping{
	// 		Name: to.Ptr("DatasetMapping1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1"),
	// 		Kind: to.Ptr(armdatashare.DataSetMappingKindBlob),
	// 		Properties: &armdatashare.BlobMappingProperties{
	// 			ContainerName: to.Ptr("C1"),
	// 			DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
	// 			FilePath: to.Ptr("file21"),
	// 			ResourceGroup: to.Ptr("SampleResourceGroup"),
	// 			StorageAccountName: to.Ptr("storage2"),
	// 			SubscriptionID: to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*DataSetMappingsClient) NewListByShareSubscriptionPager added in v0.4.0 

func (client *DataSetMappingsClient) NewListByShareSubscriptionPager(resourceGroupName string, accountName string, shareSubscriptionName string, options *DataSetMappingsClientListByShareSubscriptionOptions) *runtime.Pager[DataSetMappingsClientListByShareSubscriptionResponse]

NewListByShareSubscriptionPager - List DataSetMappings in a share subscription

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the share subscription.
  • options - DataSetMappingsClientListByShareSubscriptionOptions contains the optional parameters for the DataSetMappingsClient.NewListByShareSubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSetMappings_ListByShareSubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDataSetMappingsClient().NewListByShareSubscriptionPager("SampleResourceGroup", "Account1", "ShareSubscription1", &armdatashare.DataSetMappingsClientListByShareSubscriptionOptions{SkipToken: nil,
		Filter:  nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DataSetMappingList = armdatashare.DataSetMappingList{
		// 	Value: []armdatashare.DataSetMappingClassification{
		// 		&armdatashare.BlobDataSetMapping{
		// 			Name: to.Ptr("DatasetMapping1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1"),
		// 			Kind: to.Ptr(armdatashare.DataSetMappingKindBlob),
		// 			Properties: &armdatashare.BlobMappingProperties{
		// 				ContainerName: to.Ptr("C1"),
		// 				DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
		// 				FilePath: to.Ptr("file21"),
		// 				ResourceGroup: to.Ptr("SampleResourceGroup"),
		// 				StorageAccountName: to.Ptr("storage2"),
		// 				SubscriptionID: to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
		// 			},
		// 		},
		// 		&armdatashare.BlobDataSetMapping{
		// 			Name: to.Ptr("DatasetMapping1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1"),
		// 			Kind: to.Ptr(armdatashare.DataSetMappingKindBlob),
		// 			Properties: &armdatashare.BlobMappingProperties{
		// 				ContainerName: to.Ptr("C1"),
		// 				DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d227"),
		// 				FilePath: to.Ptr("file21"),
		// 				ResourceGroup: to.Ptr("SampleResourceGroup"),
		// 				StorageAccountName: to.Ptr("storage2"),
		// 				SubscriptionID: to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type DataSetMappingsClientCreateOptions added in v0.2.0 

type DataSetMappingsClientCreateOptions struct {
}

DataSetMappingsClientCreateOptions contains the optional parameters for the DataSetMappingsClient.Create method.

type DataSetMappingsClientCreateResponse added in v0.2.0 

type DataSetMappingsClientCreateResponse struct {
	// A data set mapping data transfer object.
	DataSetMappingClassification
}

DataSetMappingsClientCreateResponse contains the response from method DataSetMappingsClient.Create.

func (*DataSetMappingsClientCreateResponse) UnmarshalJSON added in v0.3.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataSetMappingsClientCreateResponse.

type DataSetMappingsClientDeleteOptions added in v0.2.0 

type DataSetMappingsClientDeleteOptions struct {
}

DataSetMappingsClientDeleteOptions contains the optional parameters for the DataSetMappingsClient.Delete method.

type DataSetMappingsClientDeleteResponse added in v0.2.0 

type DataSetMappingsClientDeleteResponse struct {
}

DataSetMappingsClientDeleteResponse contains the response from method DataSetMappingsClient.Delete.

type DataSetMappingsClientGetOptions added in v0.2.0 

type DataSetMappingsClientGetOptions struct {
}

DataSetMappingsClientGetOptions contains the optional parameters for the DataSetMappingsClient.Get method.

type DataSetMappingsClientGetResponse added in v0.2.0 

type DataSetMappingsClientGetResponse struct {
	// A data set mapping data transfer object.
	DataSetMappingClassification
}

DataSetMappingsClientGetResponse contains the response from method DataSetMappingsClient.Get.

func (*DataSetMappingsClientGetResponse) UnmarshalJSON added in v0.3.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataSetMappingsClientGetResponse.

type DataSetMappingsClientListByShareSubscriptionOptions added in v0.2.0 

type DataSetMappingsClientListByShareSubscriptionOptions struct {
	// Filters the results using OData syntax.
	Filter *string

	// Sorts the results using OData syntax.
	Orderby *string

	// Continuation token
	SkipToken *string
}

DataSetMappingsClientListByShareSubscriptionOptions contains the optional parameters for the DataSetMappingsClient.NewListByShareSubscriptionPager method.

type DataSetMappingsClientListByShareSubscriptionResponse added in v0.2.0 

type DataSetMappingsClientListByShareSubscriptionResponse struct {
	// List response for get DataSetMappings
	DataSetMappingList
}

DataSetMappingsClientListByShareSubscriptionResponse contains the response from method DataSetMappingsClient.NewListByShareSubscriptionPager.

type DataSetType 

type DataSetType string

DataSetType - Type of data set 

const (
	DataSetTypeAdlsGen1File                 DataSetType = "AdlsGen1File"
	DataSetTypeAdlsGen1Folder               DataSetType = "AdlsGen1Folder"
	DataSetTypeAdlsGen2File                 DataSetType = "AdlsGen2File"
	DataSetTypeAdlsGen2FileSystem           DataSetType = "AdlsGen2FileSystem"
	DataSetTypeAdlsGen2Folder               DataSetType = "AdlsGen2Folder"
	DataSetTypeBlob                         DataSetType = "Blob"
	DataSetTypeBlobFolder                   DataSetType = "BlobFolder"
	DataSetTypeContainer                    DataSetType = "Container"
	DataSetTypeKustoCluster                 DataSetType = "KustoCluster"
	DataSetTypeKustoDatabase                DataSetType = "KustoDatabase"
	DataSetTypeSQLDBTable                   DataSetType = "SqlDBTable"
	DataSetTypeSQLDWTable                   DataSetType = "SqlDWTable"
	DataSetTypeSynapseWorkspaceSQLPoolTable DataSetType = "SynapseWorkspaceSqlPoolTable"
)

func PossibleDataSetTypeValues 

func PossibleDataSetTypeValues() []DataSetType

PossibleDataSetTypeValues returns the possible values for the DataSetType const type.

type DataSetsClient 

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

DataSetsClient contains the methods for the DataSets group. Don't use this type directly, use NewDataSetsClient() instead.

func NewDataSetsClient 

func NewDataSetsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DataSetsClient, error)

NewDataSetsClient creates a new instance of DataSetsClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DataSetsClient) BeginDelete 

func (client *DataSetsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, shareName string, dataSetName string, options *DataSetsClientBeginDeleteOptions) (*runtime.Poller[DataSetsClientDeleteResponse], error)

BeginDelete - Delete a DataSet in a share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • dataSetName - The name of the dataSet.
  • options - DataSetsClientBeginDeleteOptions contains the optional parameters for the DataSetsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSets_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDataSetsClient().BeginDelete(ctx, "SampleResourceGroup", "Account1", "Share1", "Dataset1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*DataSetsClient) Create 

func (client *DataSetsClient) Create(ctx context.Context, resourceGroupName string, accountName string, shareName string, dataSetName string, dataSet DataSetClassification, options *DataSetsClientCreateOptions) (DataSetsClientCreateResponse, error)

Create - Create a DataSet If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share to add the data set to.
  • dataSetName - The name of the dataSet.
  • dataSet - The new data set information.
  • options - DataSetsClientCreateOptions contains the optional parameters for the DataSetsClient.Create method.
Example (DataSetsCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSets_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetsClient().Create(ctx, "SampleResourceGroup", "Account1", "Share1", "Dataset1", &armdatashare.BlobDataSet{
		Kind: to.Ptr(armdatashare.DataSetKindBlob),
		Properties: &armdatashare.BlobProperties{
			ContainerName:      to.Ptr("C1"),
			FilePath:           to.Ptr("file21"),
			ResourceGroup:      to.Ptr("SampleResourceGroup"),
			StorageAccountName: to.Ptr("storage2"),
			SubscriptionID:     to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetsClientCreateResponse{
	// 	                            DataSetClassification: &armdatashare.BlobDataSet{
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shares/dataSets"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1"),
	// 		Kind: to.Ptr(armdatashare.DataSetKindBlob),
	// 		Properties: &armdatashare.BlobProperties{
	// 			ContainerName: to.Ptr("C1"),
	// 			DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
	// 			FilePath: to.Ptr("inputpath"),
	// 			ResourceGroup: to.Ptr("SampleResourceGroup"),
	// 			StorageAccountName: to.Ptr("adspipelinemetadatatable"),
	// 			SubscriptionID: to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
	// 		},
	// 	},
	// 	                        }
}

Output:
Example (DataSetsKustoClusterCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSets_KustoCluster_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetsClient().Create(ctx, "SampleResourceGroup", "Account1", "Share1", "Dataset1", &armdatashare.KustoClusterDataSet{
		Kind: to.Ptr(armdatashare.DataSetKindKustoCluster),
		Properties: &armdatashare.KustoClusterDataSetProperties{
			KustoClusterResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetsClientCreateResponse{
	// 	                            DataSetClassification: &armdatashare.KustoClusterDataSet{
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shares/dataSets"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1"),
	// 		Kind: to.Ptr(armdatashare.DataSetKindKustoCluster),
	// 		Properties: &armdatashare.KustoClusterDataSetProperties{
	// 			DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
	// 			KustoClusterResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1"),
	// 			Location: to.Ptr("West US 2"),
	// 		},
	// 	},
	// 	                        }
}

Output:
Example (DataSetsKustoDatabaseCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSets_KustoDatabase_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetsClient().Create(ctx, "SampleResourceGroup", "Account1", "Share1", "Dataset1", &armdatashare.KustoDatabaseDataSet{
		Kind: to.Ptr(armdatashare.DataSetKindKustoDatabase),
		Properties: &armdatashare.KustoDatabaseDataSetProperties{
			KustoDatabaseResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1/databases/Database1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetsClientCreateResponse{
	// 	                            DataSetClassification: &armdatashare.KustoDatabaseDataSet{
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shares/dataSets"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1"),
	// 		Kind: to.Ptr(armdatashare.DataSetKindKustoDatabase),
	// 		Properties: &armdatashare.KustoDatabaseDataSetProperties{
	// 			DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
	// 			KustoDatabaseResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1/databases/Database1"),
	// 			Location: to.Ptr("West US 2"),
	// 		},
	// 	},
	// 	                        }
}

Output:
Example (DataSetsSqlDbTableCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSets_SqlDBTable_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetsClient().Create(ctx, "SampleResourceGroup", "Account1", "Share1", "Dataset1", &armdatashare.SQLDBTableDataSet{
		Kind: to.Ptr(armdatashare.DataSetKindSQLDBTable),
		Properties: &armdatashare.SQLDBTableProperties{
			DatabaseName:        to.Ptr("SqlDB1"),
			SchemaName:          to.Ptr("dbo"),
			SQLServerResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1"),
			TableName:           to.Ptr("Table1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetsClientCreateResponse{
	// 	                            DataSetClassification: &armdatashare.SQLDBTableDataSet{
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shares/dataSets"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1"),
	// 		Kind: to.Ptr(armdatashare.DataSetKindSQLDBTable),
	// 		Properties: &armdatashare.SQLDBTableProperties{
	// 			DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
	// 			DatabaseName: to.Ptr("SqlDB1"),
	// 			SchemaName: to.Ptr("dbo"),
	// 			SQLServerResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1"),
	// 			TableName: to.Ptr("Table1"),
	// 		},
	// 	},
	// 	                        }
}

Output:
Example (DataSetsSqlDwTableCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSets_SqlDWTable_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetsClient().Create(ctx, "SampleResourceGroup", "Account1", "Share1", "Dataset1", &armdatashare.SQLDWTableDataSet{
		Kind: to.Ptr(armdatashare.DataSetKindSQLDWTable),
		Properties: &armdatashare.SQLDWTableProperties{
			DataWarehouseName:   to.Ptr("DataWarehouse1"),
			SchemaName:          to.Ptr("dbo"),
			SQLServerResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1"),
			TableName:           to.Ptr("Table1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetsClientCreateResponse{
	// 	                            DataSetClassification: &armdatashare.SQLDWTableDataSet{
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shares/dataSets"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1"),
	// 		Kind: to.Ptr(armdatashare.DataSetKindSQLDWTable),
	// 		Properties: &armdatashare.SQLDWTableProperties{
	// 			DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
	// 			DataWarehouseName: to.Ptr("DataWarehouse1"),
	// 			SchemaName: to.Ptr("dbo"),
	// 			SQLServerResourceID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1"),
	// 			TableName: to.Ptr("Table1"),
	// 		},
	// 	},
	// 	                        }
}

Output:
Example (DataSetsSynapseWorkspaceSqlPoolTableCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSets_SynapseWorkspaceSqlPoolTable_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetsClient().Create(ctx, "SampleResourceGroup", "sourceAccount", "share1", "dataset1", &armdatashare.SynapseWorkspaceSQLPoolTableDataSet{
		Kind: to.Ptr(armdatashare.DataSetKindSynapseWorkspaceSQLPoolTable),
		Properties: &armdatashare.SynapseWorkspaceSQLPoolTableDataSetProperties{
			SynapseWorkspaceSQLPoolTableResourceID: to.Ptr("/subscriptions/0f3dcfc3-18f8-4099-b381-8353e19d43a7/resourceGroups/SampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/sqlPools/ExampleSqlPool/schemas/dbo/tables/table1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetsClientCreateResponse{
	// 	                            DataSetClassification: &armdatashare.SynapseWorkspaceSQLPoolTableDataSet{
	// 		Name: to.Ptr("dataset1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shares/dataSets"),
	// 		ID: to.Ptr("/subscriptions/0f3dcfc3-18f8-4099-b381-8353e19d43a7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/sourceAccount/shares/share1/dataSets/dataset1"),
	// 		Kind: to.Ptr(armdatashare.DataSetKindSynapseWorkspaceSQLPoolTable),
	// 		Properties: &armdatashare.SynapseWorkspaceSQLPoolTableDataSetProperties{
	// 			SynapseWorkspaceSQLPoolTableResourceID: to.Ptr("/subscriptions/0f3dcfc3-18f8-4099-b381-8353e19d43a7/resourceGroups/SampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/sqlPools/ExampleSqlPool/schemas/dbo/tables/table1"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*DataSetsClient) Get 

func (client *DataSetsClient) Get(ctx context.Context, resourceGroupName string, accountName string, shareName string, dataSetName string, options *DataSetsClientGetOptions) (DataSetsClientGetResponse, error)

Get - Get a DataSet in a share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • dataSetName - The name of the dataSet.
  • options - DataSetsClientGetOptions contains the optional parameters for the DataSetsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSets_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetsClient().Get(ctx, "SampleResourceGroup", "Account1", "Share1", "Dataset1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetsClientGetResponse{
	// 	                            DataSetClassification: &armdatashare.BlobDataSet{
	// 		Name: to.Ptr("Dataset1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shares/dataSets"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1"),
	// 		Kind: to.Ptr(armdatashare.DataSetKindBlob),
	// 		Properties: &armdatashare.BlobProperties{
	// 			ContainerName: to.Ptr("C1"),
	// 			FilePath: to.Ptr("file21"),
	// 			ResourceGroup: to.Ptr("SampleResourceGroup"),
	// 			StorageAccountName: to.Ptr("storage2"),
	// 			SubscriptionID: to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*DataSetsClient) NewListBySharePager added in v0.4.0 

func (client *DataSetsClient) NewListBySharePager(resourceGroupName string, accountName string, shareName string, options *DataSetsClientListByShareOptions) *runtime.Pager[DataSetsClientListByShareResponse]

NewListBySharePager - List DataSets in a share

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • options - DataSetsClientListByShareOptions contains the optional parameters for the DataSetsClient.NewListBySharePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSets_ListByShare.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDataSetsClient().NewListBySharePager("SampleResourceGroup", "Account1", "Share1", &armdatashare.DataSetsClientListByShareOptions{SkipToken: nil,
		Filter:  nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DataSetList = armdatashare.DataSetList{
		// 	Value: []armdatashare.DataSetClassification{
		// 		&armdatashare.BlobDataSet{
		// 			Name: to.Ptr("Dataset1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/shares/dataSets"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1"),
		// 			Kind: to.Ptr(armdatashare.DataSetKindBlob),
		// 			Properties: &armdatashare.BlobProperties{
		// 				ContainerName: to.Ptr("C1"),
		// 				FilePath: to.Ptr("file22"),
		// 				ResourceGroup: to.Ptr("SampleResourceGroup"),
		// 				StorageAccountName: to.Ptr("storage1"),
		// 				SubscriptionID: to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
		// 			},
		// 		},
		// 		&armdatashare.BlobDataSet{
		// 			Name: to.Ptr("Dataset1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/shares/dataSets"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset2"),
		// 			Kind: to.Ptr(armdatashare.DataSetKindBlob),
		// 			Properties: &armdatashare.BlobProperties{
		// 				ContainerName: to.Ptr("C1"),
		// 				FilePath: to.Ptr("file21"),
		// 				ResourceGroup: to.Ptr("SampleResourceGroup"),
		// 				StorageAccountName: to.Ptr("storage2"),
		// 				SubscriptionID: to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type DataSetsClientBeginDeleteOptions added in v0.2.0 

type DataSetsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DataSetsClientBeginDeleteOptions contains the optional parameters for the DataSetsClient.BeginDelete method.

type DataSetsClientCreateOptions added in v0.2.0 

type DataSetsClientCreateOptions struct {
}

DataSetsClientCreateOptions contains the optional parameters for the DataSetsClient.Create method.

type DataSetsClientCreateResponse added in v0.2.0 

type DataSetsClientCreateResponse struct {
	// A DataSet data transfer object.
	DataSetClassification
}

DataSetsClientCreateResponse contains the response from method DataSetsClient.Create.

func (*DataSetsClientCreateResponse) UnmarshalJSON added in v0.3.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataSetsClientCreateResponse.

type DataSetsClientDeleteResponse added in v0.2.0 

type DataSetsClientDeleteResponse struct {
}

DataSetsClientDeleteResponse contains the response from method DataSetsClient.BeginDelete.

type DataSetsClientGetOptions added in v0.2.0 

type DataSetsClientGetOptions struct {
}

DataSetsClientGetOptions contains the optional parameters for the DataSetsClient.Get method.

type DataSetsClientGetResponse added in v0.2.0 

type DataSetsClientGetResponse struct {
	// A DataSet data transfer object.
	DataSetClassification
}

DataSetsClientGetResponse contains the response from method DataSetsClient.Get.

func (*DataSetsClientGetResponse) UnmarshalJSON added in v0.3.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataSetsClientGetResponse.

type DataSetsClientListByShareOptions added in v0.2.0 

type DataSetsClientListByShareOptions struct {
	// Filters the results using OData syntax.
	Filter *string

	// Sorts the results using OData syntax.
	Orderby *string

	// continuation token
	SkipToken *string
}

DataSetsClientListByShareOptions contains the optional parameters for the DataSetsClient.NewListBySharePager method.

type DataSetsClientListByShareResponse added in v0.2.0 

type DataSetsClientListByShareResponse struct {
	// List response for get DataSets
	DataSetList
}

DataSetsClientListByShareResponse contains the response from method DataSetsClient.NewListBySharePager.

type DefaultDto 

type DefaultDto struct {
	// Location of the azure resource.
	Location *string

	// Tags on the azure resource.
	Tags map[string]*string

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

DefaultDto - Base data transfer object implementation for default resources.

func (DefaultDto) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DefaultDto.

func (*DefaultDto) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultDto.

type DimensionProperties 

type DimensionProperties struct {
	// localized display name of the dimension to customer
	DisplayName *string

	// dimension name
	Name *string
}

DimensionProperties - properties for dimension

func (DimensionProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type DimensionProperties.

func (*DimensionProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DimensionProperties.

type EmailRegistration 

type EmailRegistration struct {
	// Activation code for the registration
	ActivationCode *string

	// READ-ONLY; Date of the activation expiration
	ActivationExpirationDate *time.Time

	// READ-ONLY; The email to register
	Email *string

	// READ-ONLY; Registration status
	RegistrationStatus *RegistrationStatus

	// READ-ONLY; The tenant to register
	TenantID *string
}

EmailRegistration - Dto for tenant domain registration

func (EmailRegistration) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EmailRegistration.

func (*EmailRegistration) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EmailRegistration.

type EmailRegistrationsClient 

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

EmailRegistrationsClient contains the methods for the EmailRegistrations group. Don't use this type directly, use NewEmailRegistrationsClient() instead.

func NewEmailRegistrationsClient 

func NewEmailRegistrationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*EmailRegistrationsClient, error)

NewEmailRegistrationsClient creates a new instance of EmailRegistrationsClient with the specified values.

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

func (*EmailRegistrationsClient) ActivateEmail 

func (client *EmailRegistrationsClient) ActivateEmail(ctx context.Context, location string, emailRegistration EmailRegistration, options *EmailRegistrationsClientActivateEmailOptions) (EmailRegistrationsClientActivateEmailResponse, error)

ActivateEmail - Activate the email registration for the current tenant If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • location - Location of the activation.
  • emailRegistration - The payload for tenant domain activation.
  • options - EmailRegistrationsClientActivateEmailOptions contains the optional parameters for the EmailRegistrationsClient.ActivateEmail method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/EmailRegistrations_ActivateEmail.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEmailRegistrationsClient().ActivateEmail(ctx, "East US 2", armdatashare.EmailRegistration{
		ActivationCode: to.Ptr("djsfhakj2lekowd3wepfklpwe9lpflcd"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.EmailRegistration = armdatashare.EmailRegistration{
	// 	ActivationExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-08-12T16:44:53.688Z"); return t}()),
	// 	Email: to.Ptr("receiver@microsoft.com"),
	// 	RegistrationStatus: to.Ptr(armdatashare.RegistrationStatusActivated),
	// 	TenantID: to.Ptr("9f532315-b048-4374-8de1-14734d9b7f77"),
	// }
}

Output:

func (*EmailRegistrationsClient) RegisterEmail 

func (client *EmailRegistrationsClient) RegisterEmail(ctx context.Context, location string, options *EmailRegistrationsClientRegisterEmailOptions) (EmailRegistrationsClientRegisterEmailResponse, error)

RegisterEmail - Register an email for the current tenant If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • location - Location of the registration
  • options - EmailRegistrationsClientRegisterEmailOptions contains the optional parameters for the EmailRegistrationsClient.RegisterEmail method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/EmailRegistrations_RegisterEmail.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEmailRegistrationsClient().RegisterEmail(ctx, "East US 2", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.EmailRegistration = armdatashare.EmailRegistration{
	// 	ActivationExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-08-12T16:44:53.688Z"); return t}()),
	// 	Email: to.Ptr("receiver@microsoft.com"),
	// 	RegistrationStatus: to.Ptr(armdatashare.RegistrationStatusActivationPending),
	// 	TenantID: to.Ptr("9f532315-b048-4374-8de1-14734d9b7f77"),
	// }
}

Output:

type EmailRegistrationsClientActivateEmailOptions added in v0.2.0 

type EmailRegistrationsClientActivateEmailOptions struct {
}

EmailRegistrationsClientActivateEmailOptions contains the optional parameters for the EmailRegistrationsClient.ActivateEmail method.

type EmailRegistrationsClientActivateEmailResponse added in v0.2.0 

type EmailRegistrationsClientActivateEmailResponse struct {
	// Dto for tenant domain registration
	EmailRegistration
}

EmailRegistrationsClientActivateEmailResponse contains the response from method EmailRegistrationsClient.ActivateEmail.

type EmailRegistrationsClientRegisterEmailOptions added in v0.2.0 

type EmailRegistrationsClientRegisterEmailOptions struct {
}

EmailRegistrationsClientRegisterEmailOptions contains the optional parameters for the EmailRegistrationsClient.RegisterEmail method.

type EmailRegistrationsClientRegisterEmailResponse added in v0.2.0 

type EmailRegistrationsClientRegisterEmailResponse struct {
	// Dto for tenant domain registration
	EmailRegistration
}

EmailRegistrationsClientRegisterEmailResponse contains the response from method EmailRegistrationsClient.RegisterEmail.

type Error added in v0.2.0 

type Error struct {
	// REQUIRED; The data share error body
	Error *ErrorInfo
}

Error - The data share error model.

func (Error) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type Error.

func (*Error) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Error.

type ErrorInfo added in v0.2.0 

type ErrorInfo struct {
	// REQUIRED; Code of the error
	Code *string

	// REQUIRED; Message of the error
	Message *string

	// Nested details of the error model
	Details []*ErrorInfo

	// Target of the error
	Target *string
}

ErrorInfo - The data share error body model.

func (ErrorInfo) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ErrorInfo.

func (*ErrorInfo) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorInfo.

type Identity 

type Identity struct {
	// Identity Type
	Type *Type

	// READ-ONLY; service principal Id
	PrincipalID *string

	// READ-ONLY; Tenant Id
	TenantID *string
}

Identity of resource

func (Identity) MarshalJSON added in v1.1.0 

func (i Identity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Identity.

func (*Identity) UnmarshalJSON added in v1.1.0 

func (i *Identity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Identity.

type Invitation 

type Invitation struct {
	// Properties on the Invitation
	Properties *InvitationProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

Invitation - A Invitation data transfer object.

func (Invitation) MarshalJSON 

func (i Invitation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Invitation.

func (*Invitation) UnmarshalJSON 

func (i *Invitation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Invitation.

type InvitationList 

type InvitationList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []*Invitation

	// The Url of next result page.
	NextLink *string
}

InvitationList - List response for get InvitationList

func (InvitationList) MarshalJSON 

func (i InvitationList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InvitationList.

func (*InvitationList) UnmarshalJSON added in v1.1.0 

func (i *InvitationList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InvitationList.

type InvitationProperties 

type InvitationProperties struct {
	// The expiration date for the invitation and share subscription.
	ExpirationDate *time.Time

	// The target Azure AD Id. Can't be combined with email.
	TargetActiveDirectoryID *string

	// The email the invitation is directed to.
	TargetEmail *string

	// The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This
	// enables sending invitations to specific users or applications in an AD tenant.
	TargetObjectID *string

	// READ-ONLY; unique invitation id
	InvitationID *string

	// READ-ONLY; The status of the invitation.
	InvitationStatus *InvitationStatus

	// READ-ONLY; The time the recipient responded to the invitation.
	RespondedAt *time.Time

	// READ-ONLY; Gets the time at which the invitation was sent.
	SentAt *time.Time

	// READ-ONLY; Email of the user who created the resource
	UserEmail *string

	// READ-ONLY; Name of the user who created the resource
	UserName *string
}

InvitationProperties - Invitation property bag.

func (InvitationProperties) MarshalJSON 

func (i InvitationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InvitationProperties.

func (*InvitationProperties) UnmarshalJSON 

func (i *InvitationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InvitationProperties.

type InvitationStatus 

type InvitationStatus string

InvitationStatus - The status of the invitation. 

const (
	InvitationStatusAccepted  InvitationStatus = "Accepted"
	InvitationStatusPending   InvitationStatus = "Pending"
	InvitationStatusRejected  InvitationStatus = "Rejected"
	InvitationStatusWithdrawn InvitationStatus = "Withdrawn"
)

func PossibleInvitationStatusValues 

func PossibleInvitationStatusValues() []InvitationStatus

PossibleInvitationStatusValues returns the possible values for the InvitationStatus const type.

type InvitationsClient 

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

InvitationsClient contains the methods for the Invitations group. Don't use this type directly, use NewInvitationsClient() instead.

func NewInvitationsClient 

func NewInvitationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*InvitationsClient, error)

NewInvitationsClient creates a new instance of InvitationsClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*InvitationsClient) Create 

func (client *InvitationsClient) Create(ctx context.Context, resourceGroupName string, accountName string, shareName string, invitationName string, invitation Invitation, options *InvitationsClientCreateOptions) (InvitationsClientCreateResponse, error)

Create - Create an invitation If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share to send the invitation for.
  • invitationName - The name of the invitation.
  • invitation - Invitation details.
  • options - InvitationsClientCreateOptions contains the optional parameters for the InvitationsClient.Create method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Invitations_Create.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInvitationsClient().Create(ctx, "SampleResourceGroup", "Account1", "Share1", "Invitation1", armdatashare.Invitation{
		Properties: &armdatashare.InvitationProperties{
			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t }()),
			TargetEmail:    to.Ptr("receiver@microsoft.com"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Invitation = armdatashare.Invitation{
	// 	Name: to.Ptr("Invitation1"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts/shares/invitations"),
	// 	ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/invitations/Invitation1"),
	// 	Properties: &armdatashare.InvitationProperties{
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
	// 		InvitationStatus: to.Ptr(armdatashare.InvitationStatusPending),
	// 		SentAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-26T22:33:24.578Z"); return t}()),
	// 		TargetEmail: to.Ptr("receiver@microsoft.com"),
	// 		UserEmail: to.Ptr("johnsmith@microsoft.com"),
	// 		UserName: to.Ptr("John Smith"),
	// 	},
	// }
}

Output:

func (*InvitationsClient) Delete 

func (client *InvitationsClient) Delete(ctx context.Context, resourceGroupName string, accountName string, shareName string, invitationName string, options *InvitationsClientDeleteOptions) (InvitationsClientDeleteResponse, error)

Delete - Delete an invitation in a share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • invitationName - The name of the invitation.
  • options - InvitationsClientDeleteOptions contains the optional parameters for the InvitationsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Invitations_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewInvitationsClient().Delete(ctx, "SampleResourceGroup", "Account1", "Share1", "Invitation1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*InvitationsClient) Get 

func (client *InvitationsClient) Get(ctx context.Context, resourceGroupName string, accountName string, shareName string, invitationName string, options *InvitationsClientGetOptions) (InvitationsClientGetResponse, error)

Get - Get an invitation in a share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • invitationName - The name of the invitation.
  • options - InvitationsClientGetOptions contains the optional parameters for the InvitationsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Invitations_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInvitationsClient().Get(ctx, "SampleResourceGroup", "Account1", "Share1", "Invitation1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Invitation = armdatashare.Invitation{
	// 	Name: to.Ptr("Invitation1"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts/shares/invitations"),
	// 	ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/invitations/Invitation1"),
	// 	Properties: &armdatashare.InvitationProperties{
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
	// 		InvitationStatus: to.Ptr(armdatashare.InvitationStatusPending),
	// 		SentAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-26T22:33:24.578Z"); return t}()),
	// 		TargetEmail: to.Ptr("receiver@microsoft.com"),
	// 		UserEmail: to.Ptr("johnsmith@microsoft.com"),
	// 		UserName: to.Ptr("John Smith"),
	// 	},
	// }
}

Output:

func (*InvitationsClient) NewListBySharePager added in v0.4.0 

func (client *InvitationsClient) NewListBySharePager(resourceGroupName string, accountName string, shareName string, options *InvitationsClientListByShareOptions) *runtime.Pager[InvitationsClientListByShareResponse]

NewListBySharePager - List invitations in a share

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • options - InvitationsClientListByShareOptions contains the optional parameters for the InvitationsClient.NewListBySharePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Invitations_ListByShare.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewInvitationsClient().NewListBySharePager("SampleResourceGroup", "Account1", "Share1", &armdatashare.InvitationsClientListByShareOptions{SkipToken: nil,
		Filter:  nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.InvitationList = armdatashare.InvitationList{
		// 	Value: []*armdatashare.Invitation{
		// 		{
		// 			Name: to.Ptr("ancd"),
		// 			Type: to.Ptr("Microsoft.DataShare/Invitation"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/account1/shares/share1/invitations/ancd"),
		// 			Properties: &armdatashare.InvitationProperties{
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
		// 				InvitationStatus: to.Ptr(armdatashare.InvitationStatusAccepted),
		// 				SentAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-26T22:33:24.578Z"); return t}()),
		// 				TargetEmail: to.Ptr("johnsmith@microsoft.com"),
		// 				UserEmail: to.Ptr("johnsmith@microsoft.com"),
		// 				UserName: to.Ptr("John Smith"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type InvitationsClientCreateOptions added in v0.2.0 

type InvitationsClientCreateOptions struct {
}

InvitationsClientCreateOptions contains the optional parameters for the InvitationsClient.Create method.

type InvitationsClientCreateResponse added in v0.2.0 

type InvitationsClientCreateResponse struct {
	// A Invitation data transfer object.
	Invitation
}

InvitationsClientCreateResponse contains the response from method InvitationsClient.Create.

type InvitationsClientDeleteOptions added in v0.2.0 

type InvitationsClientDeleteOptions struct {
}

InvitationsClientDeleteOptions contains the optional parameters for the InvitationsClient.Delete method.

type InvitationsClientDeleteResponse added in v0.2.0 

type InvitationsClientDeleteResponse struct {
}

InvitationsClientDeleteResponse contains the response from method InvitationsClient.Delete.

type InvitationsClientGetOptions added in v0.2.0 

type InvitationsClientGetOptions struct {
}

InvitationsClientGetOptions contains the optional parameters for the InvitationsClient.Get method.

type InvitationsClientGetResponse added in v0.2.0 

type InvitationsClientGetResponse struct {
	// A Invitation data transfer object.
	Invitation
}

InvitationsClientGetResponse contains the response from method InvitationsClient.Get.

type InvitationsClientListByShareOptions added in v0.2.0 

type InvitationsClientListByShareOptions struct {
	// Filters the results using OData syntax.
	Filter *string

	// Sorts the results using OData syntax.
	Orderby *string

	// The continuation token
	SkipToken *string
}

InvitationsClientListByShareOptions contains the optional parameters for the InvitationsClient.NewListBySharePager method.

type InvitationsClientListByShareResponse added in v0.2.0 

type InvitationsClientListByShareResponse struct {
	// List response for get InvitationList
	InvitationList
}

InvitationsClientListByShareResponse contains the response from method InvitationsClient.NewListBySharePager.

type KustoClusterDataSet 

type KustoClusterDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// REQUIRED; Kusto cluster data set properties.
	Properties *KustoClusterDataSetProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

KustoClusterDataSet - A kusto cluster data set.

func (*KustoClusterDataSet) GetDataSet added in v0.2.0 

func (k *KustoClusterDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type KustoClusterDataSet.

func (KustoClusterDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KustoClusterDataSet.

func (*KustoClusterDataSet) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KustoClusterDataSet.

type KustoClusterDataSetMapping 

type KustoClusterDataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// REQUIRED; Kusto cluster data set mapping properties.
	Properties *KustoClusterDataSetMappingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

KustoClusterDataSetMapping - A Kusto cluster data set mapping

func (*KustoClusterDataSetMapping) GetDataSetMapping added in v0.2.0 

func (k *KustoClusterDataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type KustoClusterDataSetMapping.

func (KustoClusterDataSetMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KustoClusterDataSetMapping.

func (*KustoClusterDataSetMapping) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KustoClusterDataSetMapping.

type KustoClusterDataSetMappingProperties 

type KustoClusterDataSetMappingProperties struct {
	// REQUIRED; The id of the source data set.
	DataSetID *string

	// REQUIRED; Resource id of the sink kusto cluster.
	KustoClusterResourceID *string

	// READ-ONLY; Gets the status of the data set mapping.
	DataSetMappingStatus *DataSetMappingStatus

	// READ-ONLY; Location of the sink kusto cluster.
	Location *string

	// READ-ONLY; Provisioning state of the data set mapping.
	ProvisioningState *ProvisioningState
}

KustoClusterDataSetMappingProperties - Properties of the Kusto cluster data set mapping

func (KustoClusterDataSetMappingProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type KustoClusterDataSetMappingProperties.

func (*KustoClusterDataSetMappingProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KustoClusterDataSetMappingProperties.

type KustoClusterDataSetProperties 

type KustoClusterDataSetProperties struct {
	// REQUIRED; Resource id of the kusto cluster.
	KustoClusterResourceID *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string

	// READ-ONLY; Location of the kusto cluster.
	Location *string

	// READ-ONLY; Provisioning state of the kusto cluster data set.
	ProvisioningState *ProvisioningState
}

KustoClusterDataSetProperties - Properties of the kusto cluster data set.

func (KustoClusterDataSetProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type KustoClusterDataSetProperties.

func (*KustoClusterDataSetProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KustoClusterDataSetProperties.

type KustoDatabaseDataSet 

type KustoDatabaseDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// REQUIRED; Kusto database data set properties.
	Properties *KustoDatabaseDataSetProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

KustoDatabaseDataSet - A kusto database data set.

func (*KustoDatabaseDataSet) GetDataSet added in v0.2.0 

func (k *KustoDatabaseDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type KustoDatabaseDataSet.

func (KustoDatabaseDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KustoDatabaseDataSet.

func (*KustoDatabaseDataSet) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KustoDatabaseDataSet.

type KustoDatabaseDataSetMapping 

type KustoDatabaseDataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// REQUIRED; Kusto database data set mapping properties.
	Properties *KustoDatabaseDataSetMappingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

KustoDatabaseDataSetMapping - A Kusto database data set mapping

func (*KustoDatabaseDataSetMapping) GetDataSetMapping added in v0.2.0 

func (k *KustoDatabaseDataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type KustoDatabaseDataSetMapping.

func (KustoDatabaseDataSetMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KustoDatabaseDataSetMapping.

func (*KustoDatabaseDataSetMapping) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KustoDatabaseDataSetMapping.

type KustoDatabaseDataSetMappingProperties 

type KustoDatabaseDataSetMappingProperties struct {
	// REQUIRED; The id of the source data set.
	DataSetID *string

	// REQUIRED; Resource id of the sink kusto cluster.
	KustoClusterResourceID *string

	// READ-ONLY; Gets the status of the data set mapping.
	DataSetMappingStatus *DataSetMappingStatus

	// READ-ONLY; Location of the sink kusto cluster.
	Location *string

	// READ-ONLY; Provisioning state of the data set mapping.
	ProvisioningState *ProvisioningState
}

KustoDatabaseDataSetMappingProperties - Properties of the Kusto database data set mapping

func (KustoDatabaseDataSetMappingProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type KustoDatabaseDataSetMappingProperties.

func (*KustoDatabaseDataSetMappingProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KustoDatabaseDataSetMappingProperties.

type KustoDatabaseDataSetProperties 

type KustoDatabaseDataSetProperties struct {
	// REQUIRED; Resource id of the kusto database.
	KustoDatabaseResourceID *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string

	// READ-ONLY; Location of the kusto cluster.
	Location *string

	// READ-ONLY; Provisioning state of the kusto database data set.
	ProvisioningState *ProvisioningState
}

KustoDatabaseDataSetProperties - Properties of the kusto database data set.

func (KustoDatabaseDataSetProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type KustoDatabaseDataSetProperties.

func (*KustoDatabaseDataSetProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KustoDatabaseDataSetProperties.

type LastModifiedByType 

type LastModifiedByType string

LastModifiedByType - The type of identity that last modified the resource. 

const (
	LastModifiedByTypeApplication     LastModifiedByType = "Application"
	LastModifiedByTypeKey             LastModifiedByType = "Key"
	LastModifiedByTypeManagedIdentity LastModifiedByType = "ManagedIdentity"
	LastModifiedByTypeUser            LastModifiedByType = "User"
)

func PossibleLastModifiedByTypeValues 

func PossibleLastModifiedByTypeValues() []LastModifiedByType

PossibleLastModifiedByTypeValues returns the possible values for the LastModifiedByType const type.

type OperationList 

type OperationList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []*OperationModel

	// The Url of next result page.
	NextLink *string
}

OperationList - List response for get operations.

func (OperationList) MarshalJSON 

func (o OperationList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationList.

func (*OperationList) UnmarshalJSON added in v1.1.0 

func (o *OperationList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationList.

type OperationMetaLogSpecification 

type OperationMetaLogSpecification struct {
	// blob duration of the log
	BlobDuration *string

	// localized name of the log category
	DisplayName *string

	// name of the log category
	Name *string
}

OperationMetaLogSpecification - log specifications for operation api

func (OperationMetaLogSpecification) MarshalJSON added in v1.1.0 

func (o OperationMetaLogSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaLogSpecification.

func (*OperationMetaLogSpecification) UnmarshalJSON added in v1.1.0 

func (o *OperationMetaLogSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaLogSpecification.

type OperationMetaMetricSpecification 

type OperationMetaMetricSpecification struct {
	// aggregation type of metric
	AggregationType *string

	// properties for dimension
	Dimensions []*DimensionProperties

	// description of the metric
	DisplayDescription *string

	// localized name of the metric
	DisplayName *string

	// enable regional mdm account
	EnableRegionalMdmAccount *string

	// fill gap with zero
	FillGapWithZero *bool

	// internal metric name
	InternalMetricName *string

	// name of the metric
	Name *string

	// dimension name use to replace resource id if specified
	ResourceIDDimensionNameOverride *string

	// supported aggregation types
	SupportedAggregationTypes []*string

	// supported time grain types
	SupportedTimeGrainTypes []*string

	// units for the metric
	Unit *string
}

OperationMetaMetricSpecification - metric specifications for the operation

func (OperationMetaMetricSpecification) MarshalJSON 

func (o OperationMetaMetricSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaMetricSpecification.

func (*OperationMetaMetricSpecification) UnmarshalJSON added in v1.1.0 

func (o *OperationMetaMetricSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaMetricSpecification.

type OperationMetaPropertyInfo 

type OperationMetaPropertyInfo struct {
	// meta service specification
	ServiceSpecification *OperationMetaServiceSpecification
}

OperationMetaPropertyInfo - properties on meta info

func (OperationMetaPropertyInfo) MarshalJSON added in v1.1.0 

func (o OperationMetaPropertyInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaPropertyInfo.

func (*OperationMetaPropertyInfo) UnmarshalJSON added in v1.1.0 

func (o *OperationMetaPropertyInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaPropertyInfo.

type OperationMetaServiceSpecification 

type OperationMetaServiceSpecification struct {
	// log specifications for the operation
	LogSpecifications []*OperationMetaLogSpecification

	// metric specifications for the operation
	MetricSpecifications []*OperationMetaMetricSpecification
}

OperationMetaServiceSpecification - The operation meta service specification

func (OperationMetaServiceSpecification) MarshalJSON 

func (o OperationMetaServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaServiceSpecification.

func (*OperationMetaServiceSpecification) UnmarshalJSON added in v1.1.0 

func (o *OperationMetaServiceSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaServiceSpecification.

type OperationModel 

type OperationModel struct {
	// Properties on the operation
	Display *OperationModelProperties

	// Operation name for display purposes
	Name *string

	// origin of the operation
	Origin *string

	// properties for the operation meta info
	Properties *OperationMetaPropertyInfo
}

OperationModel - The response model for get operations

func (OperationModel) MarshalJSON added in v1.1.0 

func (o OperationModel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationModel.

func (*OperationModel) UnmarshalJSON added in v1.1.0 

func (o *OperationModel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationModel.

type OperationModelProperties 

type OperationModelProperties struct {
	// Description of the operation for display purposes
	Description *string

	// Name of the operation for display purposes
	Operation *string

	// Name of the provider for display purposes
	Provider *string

	// Name of the resource type for display purposes
	Resource *string
}

OperationModelProperties - Properties on operations

func (OperationModelProperties) MarshalJSON added in v1.1.0 

func (o OperationModelProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationModelProperties.

func (*OperationModelProperties) UnmarshalJSON added in v1.1.0 

func (o *OperationModelProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationModelProperties.

type OperationResponse 

type OperationResponse struct {
	// REQUIRED; Operation state of the long running operation.
	Status *Status

	// start time
	EndTime *time.Time

	// The error property when status is failed.
	Error *ErrorInfo

	// start time
	StartTime *time.Time
}

OperationResponse - Response for long running operation

func (OperationResponse) MarshalJSON 

func (o OperationResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResponse.

func (*OperationResponse) UnmarshalJSON 

func (o *OperationResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResponse.

type OperationsClient 

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

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

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

func (*OperationsClient) NewListPager added in v0.4.0 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - List of available operations

Generated from API version 2020-09-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Operations_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewOperationsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OperationList = armdatashare.OperationList{
		// 	Value: []*armdatashare.OperationModel{
		// 		{
		// 			Name: to.Ptr("Microsoft.DataShare/operations/read"),
		// 			Display: &armdatashare.OperationModelProperties{
		// 				Description: to.Ptr("Reads all available operations in Data Share Resource Provider."),
		// 				Operation: to.Ptr("Read all operations"),
		// 				Provider: to.Ptr("Microsoft Data Share"),
		// 				Resource: to.Ptr("Data Share Resource Provider"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataShare/register/action"),
		// 			Display: &armdatashare.OperationModelProperties{
		// 				Description: to.Ptr("Register the subscription for the Data Share Resource Provider."),
		// 				Operation: to.Ptr("Register Data Share Resource Provider"),
		// 				Provider: to.Ptr("Microsoft Data Share"),
		// 				Resource: to.Ptr("Data Share Resource Provider"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DataShare/unregister/action"),
		// 			Display: &armdatashare.OperationModelProperties{
		// 				Description: to.Ptr("Unregister the subscription for the Data Share Resource Provider."),
		// 				Operation: to.Ptr("Unregister Data Share Resource Provider"),
		// 				Provider: to.Ptr("Microsoft Data Share"),
		// 				Resource: to.Ptr("Data Share Resource Provider"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse added in v0.2.0 

type OperationsClientListResponse struct {
	// List response for get operations.
	OperationList
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type OutputType 

type OutputType string

OutputType - Type of output file 

const (
	OutputTypeCSV     OutputType = "Csv"
	OutputTypeParquet OutputType = "Parquet"
)

func PossibleOutputTypeValues 

func PossibleOutputTypeValues() []OutputType

PossibleOutputTypeValues returns the possible values for the OutputType const type.

type ProviderShareSubscription 

type ProviderShareSubscription struct {
	// properties of providerShareSubscription
	Properties *ProviderShareSubscriptionProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ProviderShareSubscription - A provider side share subscription data transfer object.

func (ProviderShareSubscription) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ProviderShareSubscription.

func (*ProviderShareSubscription) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderShareSubscription.

type ProviderShareSubscriptionList 

type ProviderShareSubscriptionList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []*ProviderShareSubscription

	// The Url of next result page.
	NextLink *string
}

ProviderShareSubscriptionList - List response for get ShareSubscription.

func (ProviderShareSubscriptionList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ProviderShareSubscriptionList.

func (*ProviderShareSubscriptionList) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderShareSubscriptionList.

type ProviderShareSubscriptionProperties 

type ProviderShareSubscriptionProperties struct {
	// Expiration date of the share subscription in UTC format
	ExpirationDate *time.Time

	// READ-ONLY; Email of the consumer who created the share subscription
	ConsumerEmail *string

	// READ-ONLY; Name of the consumer who created the share subscription
	ConsumerName *string

	// READ-ONLY; Tenant name of the consumer who created the share subscription
	ConsumerTenantName *string

	// READ-ONLY; created at
	CreatedAt *time.Time

	// READ-ONLY; Email of the provider who created the share
	ProviderEmail *string

	// READ-ONLY; Name of the provider who created the share
	ProviderName *string

	// READ-ONLY; share Subscription Object Id
	ShareSubscriptionObjectID *string

	// READ-ONLY; Gets the status of share subscription
	ShareSubscriptionStatus *ShareSubscriptionStatus

	// READ-ONLY; Shared at
	SharedAt *time.Time
}

ProviderShareSubscriptionProperties - Provider share subscription properties

func (ProviderShareSubscriptionProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ProviderShareSubscriptionProperties.

func (*ProviderShareSubscriptionProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderShareSubscriptionProperties.

type ProviderShareSubscriptionsClient 

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

ProviderShareSubscriptionsClient contains the methods for the ProviderShareSubscriptions group. Don't use this type directly, use NewProviderShareSubscriptionsClient() instead.

func NewProviderShareSubscriptionsClient 

func NewProviderShareSubscriptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ProviderShareSubscriptionsClient, error)

NewProviderShareSubscriptionsClient creates a new instance of ProviderShareSubscriptionsClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ProviderShareSubscriptionsClient) Adjust 

func (client *ProviderShareSubscriptionsClient) Adjust(ctx context.Context, resourceGroupName string, accountName string, shareName string, providerShareSubscriptionID string, providerShareSubscription ProviderShareSubscription, options *ProviderShareSubscriptionsClientAdjustOptions) (ProviderShareSubscriptionsClientAdjustResponse, error)

Adjust - Adjust a share subscription's expiration date in a provider share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • providerShareSubscriptionID - To locate shareSubscription
  • providerShareSubscription - The provider share subscription
  • options - ProviderShareSubscriptionsClientAdjustOptions contains the optional parameters for the ProviderShareSubscriptionsClient.Adjust method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ProviderShareSubscriptions_Adjust.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProviderShareSubscriptionsClient().Adjust(ctx, "SampleResourceGroup", "Account1", "Share1", "4256e2cf-0f82-4865-961b-12f83333f487", armdatashare.ProviderShareSubscription{
		Properties: &armdatashare.ProviderShareSubscriptionProperties{
			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-26T22:33:24.578Z"); return t }()),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProviderShareSubscription = armdatashare.ProviderShareSubscription{
	// 	Name: to.Ptr("4256e2cf-0f82-4865-961b-12f83333f487"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts/shares/providerShareSubscriptions"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487"),
	// 	Properties: &armdatashare.ProviderShareSubscriptionProperties{
	// 		ConsumerEmail: to.Ptr("john.smith@microsoft.com"),
	// 		ConsumerName: to.Ptr("John Smith"),
	// 		ConsumerTenantName: to.Ptr("Microsoft"),
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-18T08:45:40.900Z"); return t}()),
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-26T22:33:24.578Z"); return t}()),
	// 		ProviderEmail: to.Ptr("john.smith@microsoft.com"),
	// 		ProviderName: to.Ptr("John Smith"),
	// 		ShareSubscriptionObjectID: to.Ptr("1ce51340-19be-4ef2-9450-0ea0b1324cbb"),
	// 		ShareSubscriptionStatus: to.Ptr(armdatashare.ShareSubscriptionStatusActive),
	// 		SharedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-19T08:45:40.900Z"); return t}()),
	// 	},
	// }
}

Output:

func (*ProviderShareSubscriptionsClient) BeginRevoke 

func (client *ProviderShareSubscriptionsClient) BeginRevoke(ctx context.Context, resourceGroupName string, accountName string, shareName string, providerShareSubscriptionID string, options *ProviderShareSubscriptionsClientBeginRevokeOptions) (*runtime.Poller[ProviderShareSubscriptionsClientRevokeResponse], error)

BeginRevoke - Revoke share subscription in a provider share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • providerShareSubscriptionID - To locate shareSubscription
  • options - ProviderShareSubscriptionsClientBeginRevokeOptions contains the optional parameters for the ProviderShareSubscriptionsClient.BeginRevoke method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ProviderShareSubscriptions_Revoke.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewProviderShareSubscriptionsClient().BeginRevoke(ctx, "SampleResourceGroup", "Account1", "Share1", "4256e2cf-0f82-4865-961b-12f83333f487", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProviderShareSubscription = armdatashare.ProviderShareSubscription{
	// 	Name: to.Ptr("4256e2cf-0f82-4865-961b-12f83333f487"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts/shares/providerShareSubscriptions"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487"),
	// 	Properties: &armdatashare.ProviderShareSubscriptionProperties{
	// 		ConsumerEmail: to.Ptr("john.smith@microsoft.com"),
	// 		ConsumerName: to.Ptr("John Smith"),
	// 		ConsumerTenantName: to.Ptr("Microsoft"),
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-13T08:52:42.622Z"); return t}()),
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
	// 		ProviderEmail: to.Ptr("john.smith@microsoft.com"),
	// 		ProviderName: to.Ptr("John Smith"),
	// 		ShareSubscriptionStatus: to.Ptr(armdatashare.ShareSubscriptionStatusRevoked),
	// 		SharedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-13T08:45:40.900Z"); return t}()),
	// 	},
	// }
}

Output:

func (*ProviderShareSubscriptionsClient) GetByShare 

func (client *ProviderShareSubscriptionsClient) GetByShare(ctx context.Context, resourceGroupName string, accountName string, shareName string, providerShareSubscriptionID string, options *ProviderShareSubscriptionsClientGetByShareOptions) (ProviderShareSubscriptionsClientGetByShareResponse, error)

GetByShare - Get share subscription in a provider share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • providerShareSubscriptionID - To locate shareSubscription
  • options - ProviderShareSubscriptionsClientGetByShareOptions contains the optional parameters for the ProviderShareSubscriptionsClient.GetByShare method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ProviderShareSubscriptions_GetByShare.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProviderShareSubscriptionsClient().GetByShare(ctx, "SampleResourceGroup", "Account1", "Share1", "4256e2cf-0f82-4865-961b-12f83333f487", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProviderShareSubscription = armdatashare.ProviderShareSubscription{
	// 	Name: to.Ptr("4256e2cf-0f82-4865-961b-12f83333f487"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts/shares/providerShareSubscriptions"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487"),
	// 	Properties: &armdatashare.ProviderShareSubscriptionProperties{
	// 		ConsumerEmail: to.Ptr("john.smith@microsoft.com"),
	// 		ConsumerName: to.Ptr("John Smith"),
	// 		ConsumerTenantName: to.Ptr("Microsoft"),
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-13T08:52:42.622Z"); return t}()),
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
	// 		ProviderEmail: to.Ptr("john.smith@microsoft.com"),
	// 		ProviderName: to.Ptr("John Smith"),
	// 		ShareSubscriptionStatus: to.Ptr(armdatashare.ShareSubscriptionStatusActive),
	// 		SharedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-13T08:45:40.900Z"); return t}()),
	// 	},
	// }
}

Output:

func (*ProviderShareSubscriptionsClient) NewListBySharePager added in v0.4.0 

func (client *ProviderShareSubscriptionsClient) NewListBySharePager(resourceGroupName string, accountName string, shareName string, options *ProviderShareSubscriptionsClientListByShareOptions) *runtime.Pager[ProviderShareSubscriptionsClientListByShareResponse]

NewListBySharePager - List share subscriptions in a provider share

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • options - ProviderShareSubscriptionsClientListByShareOptions contains the optional parameters for the ProviderShareSubscriptionsClient.NewListBySharePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ProviderShareSubscriptions_ListByShare.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewProviderShareSubscriptionsClient().NewListBySharePager("SampleResourceGroup", "Account1", "Share1", &armdatashare.ProviderShareSubscriptionsClientListByShareOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ProviderShareSubscriptionList = armdatashare.ProviderShareSubscriptionList{
		// 	Value: []*armdatashare.ProviderShareSubscription{
		// 		{
		// 			Name: to.Ptr("4256e2cf-0f82-4865-961b-12f83333f487"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/shares/providerShareSubscriptions"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487"),
		// 			Properties: &armdatashare.ProviderShareSubscriptionProperties{
		// 				ConsumerEmail: to.Ptr("john.smith@microsoft.com"),
		// 				ConsumerName: to.Ptr("John Smith"),
		// 				ConsumerTenantName: to.Ptr("Microsoft"),
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-13T08:52:42.622Z"); return t}()),
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
		// 				ProviderEmail: to.Ptr("john.smith@microsoft.com"),
		// 				ProviderName: to.Ptr("John Smith"),
		// 				ShareSubscriptionStatus: to.Ptr(armdatashare.ShareSubscriptionStatusActive),
		// 				SharedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-13T08:45:40.900Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*ProviderShareSubscriptionsClient) Reinstate 

func (client *ProviderShareSubscriptionsClient) Reinstate(ctx context.Context, resourceGroupName string, accountName string, shareName string, providerShareSubscriptionID string, providerShareSubscription ProviderShareSubscription, options *ProviderShareSubscriptionsClientReinstateOptions) (ProviderShareSubscriptionsClientReinstateResponse, error)

Reinstate - Reinstate share subscription in a provider share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • providerShareSubscriptionID - To locate shareSubscription
  • providerShareSubscription - The provider share subscription
  • options - ProviderShareSubscriptionsClientReinstateOptions contains the optional parameters for the ProviderShareSubscriptionsClient.Reinstate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ProviderShareSubscriptions_Reinstate.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProviderShareSubscriptionsClient().Reinstate(ctx, "SampleResourceGroup", "Account1", "Share1", "4256e2cf-0f82-4865-961b-12f83333f487", armdatashare.ProviderShareSubscription{
		Properties: &armdatashare.ProviderShareSubscriptionProperties{
			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-26T22:33:24.578Z"); return t }()),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProviderShareSubscription = armdatashare.ProviderShareSubscription{
	// 	Name: to.Ptr("4256e2cf-0f82-4865-961b-12f83333f487"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts/shares/providerShareSubscriptions"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487"),
	// 	Properties: &armdatashare.ProviderShareSubscriptionProperties{
	// 		ConsumerEmail: to.Ptr("john.smith@microsoft.com"),
	// 		ConsumerName: to.Ptr("John Smith"),
	// 		ConsumerTenantName: to.Ptr("Microsoft"),
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-13T08:52:42.622Z"); return t}()),
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
	// 		ProviderEmail: to.Ptr("john.smith@microsoft.com"),
	// 		ProviderName: to.Ptr("John Smith"),
	// 		ShareSubscriptionObjectID: to.Ptr("1ce51340-19be-4ef2-9450-0ea0b1324cbb"),
	// 		ShareSubscriptionStatus: to.Ptr(armdatashare.ShareSubscriptionStatusActive),
	// 		SharedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-13T08:45:40.900Z"); return t}()),
	// 	},
	// }
}

Output:

type ProviderShareSubscriptionsClientAdjustOptions added in v0.2.0 

type ProviderShareSubscriptionsClientAdjustOptions struct {
}

ProviderShareSubscriptionsClientAdjustOptions contains the optional parameters for the ProviderShareSubscriptionsClient.Adjust method.

type ProviderShareSubscriptionsClientAdjustResponse added in v0.2.0 

type ProviderShareSubscriptionsClientAdjustResponse struct {
	// A provider side share subscription data transfer object.
	ProviderShareSubscription
}

ProviderShareSubscriptionsClientAdjustResponse contains the response from method ProviderShareSubscriptionsClient.Adjust.

type ProviderShareSubscriptionsClientBeginRevokeOptions added in v0.2.0 

type ProviderShareSubscriptionsClientBeginRevokeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ProviderShareSubscriptionsClientBeginRevokeOptions contains the optional parameters for the ProviderShareSubscriptionsClient.BeginRevoke method.

type ProviderShareSubscriptionsClientGetByShareOptions added in v0.2.0 

type ProviderShareSubscriptionsClientGetByShareOptions struct {
}

ProviderShareSubscriptionsClientGetByShareOptions contains the optional parameters for the ProviderShareSubscriptionsClient.GetByShare method.

type ProviderShareSubscriptionsClientGetByShareResponse added in v0.2.0 

type ProviderShareSubscriptionsClientGetByShareResponse struct {
	// A provider side share subscription data transfer object.
	ProviderShareSubscription
}

ProviderShareSubscriptionsClientGetByShareResponse contains the response from method ProviderShareSubscriptionsClient.GetByShare.

type ProviderShareSubscriptionsClientListByShareOptions added in v0.2.0 

type ProviderShareSubscriptionsClientListByShareOptions struct {
	// Continuation Token
	SkipToken *string
}

ProviderShareSubscriptionsClientListByShareOptions contains the optional parameters for the ProviderShareSubscriptionsClient.NewListBySharePager method.

type ProviderShareSubscriptionsClientListByShareResponse added in v0.2.0 

type ProviderShareSubscriptionsClientListByShareResponse struct {
	// List response for get ShareSubscription.
	ProviderShareSubscriptionList
}

ProviderShareSubscriptionsClientListByShareResponse contains the response from method ProviderShareSubscriptionsClient.NewListBySharePager.

type ProviderShareSubscriptionsClientReinstateOptions added in v0.2.0 

type ProviderShareSubscriptionsClientReinstateOptions struct {
}

ProviderShareSubscriptionsClientReinstateOptions contains the optional parameters for the ProviderShareSubscriptionsClient.Reinstate method.

type ProviderShareSubscriptionsClientReinstateResponse added in v0.2.0 

type ProviderShareSubscriptionsClientReinstateResponse struct {
	// A provider side share subscription data transfer object.
	ProviderShareSubscription
}

ProviderShareSubscriptionsClientReinstateResponse contains the response from method ProviderShareSubscriptionsClient.Reinstate.

type ProviderShareSubscriptionsClientRevokeResponse added in v0.2.0 

type ProviderShareSubscriptionsClientRevokeResponse struct {
	// A provider side share subscription data transfer object.
	ProviderShareSubscription
}

ProviderShareSubscriptionsClientRevokeResponse contains the response from method ProviderShareSubscriptionsClient.BeginRevoke.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Provisioning state of the Account 

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

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyDto 

type ProxyDto struct {
	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ProxyDto - Base data transfer object implementation for proxy resources.

func (ProxyDto) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ProxyDto.

func (*ProxyDto) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyDto.

type RecurrenceInterval 

type RecurrenceInterval string

RecurrenceInterval - Recurrence Interval 

const (
	RecurrenceIntervalDay  RecurrenceInterval = "Day"
	RecurrenceIntervalHour RecurrenceInterval = "Hour"
)

func PossibleRecurrenceIntervalValues 

func PossibleRecurrenceIntervalValues() []RecurrenceInterval

PossibleRecurrenceIntervalValues returns the possible values for the RecurrenceInterval const type.

type RegistrationStatus 

type RegistrationStatus string

RegistrationStatus - Registration status 

const (
	RegistrationStatusActivated                   RegistrationStatus = "Activated"
	RegistrationStatusActivationAttemptsExhausted RegistrationStatus = "ActivationAttemptsExhausted"
	RegistrationStatusActivationPending           RegistrationStatus = "ActivationPending"
)

func PossibleRegistrationStatusValues 

func PossibleRegistrationStatusValues() []RegistrationStatus

PossibleRegistrationStatusValues returns the possible values for the RegistrationStatus const type.

type SQLDBTableDataSet 

type SQLDBTableDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// SQL DB table data set properties.
	Properties *SQLDBTableProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

SQLDBTableDataSet - A SQL DB table data set.

func (*SQLDBTableDataSet) GetDataSet added in v0.2.0 

func (s *SQLDBTableDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type SQLDBTableDataSet.

func (SQLDBTableDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SQLDBTableDataSet.

func (*SQLDBTableDataSet) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDBTableDataSet.

type SQLDBTableDataSetMapping 

type SQLDBTableDataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// REQUIRED; Sql DB data set mapping properties.
	Properties *SQLDBTableDataSetMappingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

SQLDBTableDataSetMapping - A SQL DB Table data set mapping.

func (*SQLDBTableDataSetMapping) GetDataSetMapping added in v0.2.0 

func (s *SQLDBTableDataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type SQLDBTableDataSetMapping.

func (SQLDBTableDataSetMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SQLDBTableDataSetMapping.

func (*SQLDBTableDataSetMapping) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDBTableDataSetMapping.

type SQLDBTableDataSetMappingProperties 

type SQLDBTableDataSetMappingProperties struct {
	// REQUIRED; The id of the source data set.
	DataSetID *string

	// REQUIRED; DatabaseName name of the sink data set
	DatabaseName *string

	// REQUIRED; Resource id of SQL server
	SQLServerResourceID *string

	// REQUIRED; Schema of the table. Default value is dbo.
	SchemaName *string

	// REQUIRED; SQL DB table name.
	TableName *string

	// READ-ONLY; Gets the status of the data set mapping.
	DataSetMappingStatus *DataSetMappingStatus

	// READ-ONLY; Provisioning state of the data set mapping.
	ProvisioningState *ProvisioningState
}

SQLDBTableDataSetMappingProperties - Properties of the SQL DB table data set mapping.

func (SQLDBTableDataSetMappingProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type SQLDBTableDataSetMappingProperties.

func (*SQLDBTableDataSetMappingProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDBTableDataSetMappingProperties.

type SQLDBTableProperties 

type SQLDBTableProperties struct {
	// REQUIRED; Database name of the source data set
	DatabaseName *string

	// REQUIRED; Resource id of SQL server
	SQLServerResourceID *string

	// REQUIRED; Schema of the table. Default value is dbo.
	SchemaName *string

	// REQUIRED; SQL DB table name.
	TableName *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string
}

SQLDBTableProperties - Properties of the SQL DB table data set.

func (SQLDBTableProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type SQLDBTableProperties.

func (*SQLDBTableProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDBTableProperties.

type SQLDWTableDataSet 

type SQLDWTableDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// SQL DW table data set properties.
	Properties *SQLDWTableProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

SQLDWTableDataSet - A SQL DW table data set.

func (*SQLDWTableDataSet) GetDataSet added in v0.2.0 

func (s *SQLDWTableDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type SQLDWTableDataSet.

func (SQLDWTableDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SQLDWTableDataSet.

func (*SQLDWTableDataSet) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDWTableDataSet.

type SQLDWTableDataSetMapping 

type SQLDWTableDataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// REQUIRED; Sql DW data set mapping properties.
	Properties *SQLDWTableDataSetMappingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

SQLDWTableDataSetMapping - A SQL DW Table data set mapping.

func (*SQLDWTableDataSetMapping) GetDataSetMapping added in v0.2.0 

func (s *SQLDWTableDataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type SQLDWTableDataSetMapping.

func (SQLDWTableDataSetMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SQLDWTableDataSetMapping.

func (*SQLDWTableDataSetMapping) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDWTableDataSetMapping.

type SQLDWTableDataSetMappingProperties 

type SQLDWTableDataSetMappingProperties struct {
	// REQUIRED; The id of the source data set.
	DataSetID *string

	// REQUIRED; DataWarehouse name of the source data set
	DataWarehouseName *string

	// REQUIRED; Resource id of SQL server
	SQLServerResourceID *string

	// REQUIRED; Schema of the table. Default value is dbo.
	SchemaName *string

	// REQUIRED; SQL DW table name.
	TableName *string

	// READ-ONLY; Gets the status of the data set mapping.
	DataSetMappingStatus *DataSetMappingStatus

	// READ-ONLY; Provisioning state of the data set mapping.
	ProvisioningState *ProvisioningState
}

SQLDWTableDataSetMappingProperties - Properties of the SQL DW table data set mapping.

func (SQLDWTableDataSetMappingProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type SQLDWTableDataSetMappingProperties.

func (*SQLDWTableDataSetMappingProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDWTableDataSetMappingProperties.

type SQLDWTableProperties 

type SQLDWTableProperties struct {
	// REQUIRED; DataWarehouse name of the source data set
	DataWarehouseName *string

	// REQUIRED; Resource id of SQL server
	SQLServerResourceID *string

	// REQUIRED; Schema of the table. Default value is dbo.
	SchemaName *string

	// REQUIRED; SQL DW table name.
	TableName *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string
}

SQLDWTableProperties - Properties of the SQL DW table data set.

func (SQLDWTableProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type SQLDWTableProperties.

func (*SQLDWTableProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDWTableProperties.

type ScheduledSourceShareSynchronizationSettingProperties 

type ScheduledSourceShareSynchronizationSettingProperties struct {
	// Recurrence Interval
	RecurrenceInterval *RecurrenceInterval

	// Synchronization time
	SynchronizationTime *time.Time
}

ScheduledSourceShareSynchronizationSettingProperties - A Scheduled source synchronization setting data transfer object.

func (ScheduledSourceShareSynchronizationSettingProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScheduledSourceShareSynchronizationSettingProperties.

func (*ScheduledSourceShareSynchronizationSettingProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduledSourceShareSynchronizationSettingProperties.

type ScheduledSourceSynchronizationSetting 

type ScheduledSourceSynchronizationSetting struct {
	// REQUIRED; Kind of synchronization setting on share.
	Kind *SourceShareSynchronizationSettingKind

	// Properties of scheduled synchronization
	Properties *ScheduledSourceShareSynchronizationSettingProperties
}

ScheduledSourceSynchronizationSetting - A type of synchronization setting based on schedule

func (*ScheduledSourceSynchronizationSetting) GetSourceShareSynchronizationSetting added in v0.2.0 

func (s *ScheduledSourceSynchronizationSetting) GetSourceShareSynchronizationSetting() *SourceShareSynchronizationSetting

GetSourceShareSynchronizationSetting implements the SourceShareSynchronizationSettingClassification interface for type ScheduledSourceSynchronizationSetting.

func (ScheduledSourceSynchronizationSetting) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScheduledSourceSynchronizationSetting.

func (*ScheduledSourceSynchronizationSetting) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduledSourceSynchronizationSetting.

type ScheduledSynchronizationSetting 

type ScheduledSynchronizationSetting struct {
	// REQUIRED; Kind of synchronization setting.
	Kind *SynchronizationSettingKind

	// REQUIRED; Properties of scheduled synchronization
	Properties *ScheduledSynchronizationSettingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ScheduledSynchronizationSetting - A type of synchronization setting based on schedule

func (*ScheduledSynchronizationSetting) GetSynchronizationSetting added in v0.2.0 

func (s *ScheduledSynchronizationSetting) GetSynchronizationSetting() *SynchronizationSetting

GetSynchronizationSetting implements the SynchronizationSettingClassification interface for type ScheduledSynchronizationSetting.

func (ScheduledSynchronizationSetting) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScheduledSynchronizationSetting.

func (*ScheduledSynchronizationSetting) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduledSynchronizationSetting.

type ScheduledSynchronizationSettingProperties 

type ScheduledSynchronizationSettingProperties struct {
	// REQUIRED; Recurrence Interval
	RecurrenceInterval *RecurrenceInterval

	// REQUIRED; Synchronization time
	SynchronizationTime *time.Time

	// READ-ONLY; Time at which the synchronization setting was created.
	CreatedAt *time.Time

	// READ-ONLY; Gets or sets the provisioning state
	ProvisioningState *ProvisioningState

	// READ-ONLY; Name of the user who created the synchronization setting.
	UserName *string
}

ScheduledSynchronizationSettingProperties - A Scheduled synchronization setting data transfer object.

func (ScheduledSynchronizationSettingProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScheduledSynchronizationSettingProperties.

func (*ScheduledSynchronizationSettingProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduledSynchronizationSettingProperties.

type ScheduledTrigger 

type ScheduledTrigger struct {
	// REQUIRED; Kind of synchronization on trigger.
	Kind *TriggerKind

	// REQUIRED; Properties of scheduled synchronization
	Properties *ScheduledTriggerProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ScheduledTrigger - A type of trigger based on schedule

func (*ScheduledTrigger) GetTrigger added in v0.2.0 

func (s *ScheduledTrigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type ScheduledTrigger.

func (ScheduledTrigger) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScheduledTrigger.

func (*ScheduledTrigger) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduledTrigger.

type ScheduledTriggerProperties 

type ScheduledTriggerProperties struct {
	// REQUIRED; Recurrence Interval
	RecurrenceInterval *RecurrenceInterval

	// REQUIRED; Synchronization time
	SynchronizationTime *time.Time

	// Synchronization mode
	SynchronizationMode *SynchronizationMode

	// READ-ONLY; Time at which the trigger was created.
	CreatedAt *time.Time

	// READ-ONLY; Gets the provisioning state
	ProvisioningState *ProvisioningState

	// READ-ONLY; Gets the trigger state
	TriggerStatus *TriggerStatus

	// READ-ONLY; Name of the user who created the trigger.
	UserName *string
}

ScheduledTriggerProperties - A Scheduled trigger data transfer object.

func (ScheduledTriggerProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ScheduledTriggerProperties.

func (*ScheduledTriggerProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduledTriggerProperties.

type Share 

type Share struct {
	// Properties on the share
	Properties *ShareProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

Share - A share data transfer object.

func (Share) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Share.

func (*Share) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Share.

type ShareKind 

type ShareKind string

ShareKind - Share kind. 

const (
	ShareKindCopyBased ShareKind = "CopyBased"
	ShareKindInPlace   ShareKind = "InPlace"
)

func PossibleShareKindValues 

func PossibleShareKindValues() []ShareKind

PossibleShareKindValues returns the possible values for the ShareKind const type.

type ShareList 

type ShareList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []*Share

	// The Url of next result page.
	NextLink *string
}

ShareList - List response for get Shares.

func (ShareList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareList.

func (*ShareList) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ShareList.

type ShareProperties 

type ShareProperties struct {
	// Share description.
	Description *string

	// Share kind.
	ShareKind *ShareKind

	// Share terms.
	Terms *string

	// READ-ONLY; Time at which the share was created.
	CreatedAt *time.Time

	// READ-ONLY; Gets or sets the provisioning state
	ProvisioningState *ProvisioningState

	// READ-ONLY; Email of the user who created the resource
	UserEmail *string

	// READ-ONLY; Name of the user who created the resource
	UserName *string
}

ShareProperties - Share property bag.

func (ShareProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareProperties.

func (*ShareProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ShareProperties.

type ShareSubscription 

type ShareSubscription struct {
	// REQUIRED; Properties on the share subscription
	Properties *ShareSubscriptionProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

ShareSubscription - A share subscription data transfer object.

func (ShareSubscription) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareSubscription.

func (*ShareSubscription) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ShareSubscription.

type ShareSubscriptionList 

type ShareSubscriptionList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []*ShareSubscription

	// The Url of next result page.
	NextLink *string
}

ShareSubscriptionList - List response for get ShareSubscription.

func (ShareSubscriptionList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareSubscriptionList.

func (*ShareSubscriptionList) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ShareSubscriptionList.

type ShareSubscriptionProperties 

type ShareSubscriptionProperties struct {
	// REQUIRED; The invitation id.
	InvitationID *string

	// REQUIRED; Source share location.
	SourceShareLocation *string

	// The expiration date of the share subscription.
	ExpirationDate *time.Time

	// READ-ONLY; Time at which the share subscription was created.
	CreatedAt *time.Time

	// READ-ONLY; Email of the provider who created the resource
	ProviderEmail *string

	// READ-ONLY; Name of the provider who created the resource
	ProviderName *string

	// READ-ONLY; Tenant name of the provider who created the resource
	ProviderTenantName *string

	// READ-ONLY; Provisioning state of the share subscription
	ProvisioningState *ProvisioningState

	// READ-ONLY; Description of share
	ShareDescription *string

	// READ-ONLY; Kind of share
	ShareKind *ShareKind

	// READ-ONLY; Name of the share
	ShareName *string

	// READ-ONLY; Gets the current status of share subscription.
	ShareSubscriptionStatus *ShareSubscriptionStatus

	// READ-ONLY; Terms of a share
	ShareTerms *string

	// READ-ONLY; Email of the user who created the resource
	UserEmail *string

	// READ-ONLY; Name of the user who created the resource
	UserName *string
}

ShareSubscriptionProperties - Share subscription property bag.

func (ShareSubscriptionProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareSubscriptionProperties.

func (*ShareSubscriptionProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ShareSubscriptionProperties.

type ShareSubscriptionStatus 

type ShareSubscriptionStatus string

ShareSubscriptionStatus - Gets the status of share subscription 

const (
	ShareSubscriptionStatusActive        ShareSubscriptionStatus = "Active"
	ShareSubscriptionStatusRevoked       ShareSubscriptionStatus = "Revoked"
	ShareSubscriptionStatusRevoking      ShareSubscriptionStatus = "Revoking"
	ShareSubscriptionStatusSourceDeleted ShareSubscriptionStatus = "SourceDeleted"
)

func PossibleShareSubscriptionStatusValues 

func PossibleShareSubscriptionStatusValues() []ShareSubscriptionStatus

PossibleShareSubscriptionStatusValues returns the possible values for the ShareSubscriptionStatus const type.

type ShareSubscriptionSynchronization 

type ShareSubscriptionSynchronization struct {
	// REQUIRED; Synchronization id
	SynchronizationID *string

	// READ-ONLY; Synchronization duration
	DurationMs *int32

	// READ-ONLY; End time of synchronization
	EndTime *time.Time

	// READ-ONLY; message of Synchronization
	Message *string

	// READ-ONLY; start time of synchronization
	StartTime *time.Time

	// READ-ONLY; Raw Status
	Status *string

	// READ-ONLY; Synchronization Mode
	SynchronizationMode *SynchronizationMode
}

ShareSubscriptionSynchronization - A ShareSubscriptionSynchronization data transfer object.

func (ShareSubscriptionSynchronization) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareSubscriptionSynchronization.

func (*ShareSubscriptionSynchronization) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ShareSubscriptionSynchronization.

type ShareSubscriptionSynchronizationList 

type ShareSubscriptionSynchronizationList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []*ShareSubscriptionSynchronization

	// The Url of next result page.
	NextLink *string
}

ShareSubscriptionSynchronizationList - A consumer side list of share subscription synchronizations

func (ShareSubscriptionSynchronizationList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareSubscriptionSynchronizationList.

func (*ShareSubscriptionSynchronizationList) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ShareSubscriptionSynchronizationList.

type ShareSubscriptionsClient 

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

ShareSubscriptionsClient contains the methods for the ShareSubscriptions group. Don't use this type directly, use NewShareSubscriptionsClient() instead.

func NewShareSubscriptionsClient 

func NewShareSubscriptionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ShareSubscriptionsClient, error)

NewShareSubscriptionsClient creates a new instance of ShareSubscriptionsClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ShareSubscriptionsClient) BeginCancelSynchronization 

func (client *ShareSubscriptionsClient) BeginCancelSynchronization(ctx context.Context, resourceGroupName string, accountName string, shareSubscriptionName string, shareSubscriptionSynchronization ShareSubscriptionSynchronization, options *ShareSubscriptionsClientBeginCancelSynchronizationOptions) (*runtime.Poller[ShareSubscriptionsClientCancelSynchronizationResponse], error)

BeginCancelSynchronization - Request to cancel a synchronization. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the shareSubscription.
  • shareSubscriptionSynchronization - Share Subscription Synchronization payload.
  • options - ShareSubscriptionsClientBeginCancelSynchronizationOptions contains the optional parameters for the ShareSubscriptionsClient.BeginCancelSynchronization method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ShareSubscriptions_CancelSynchronization.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewShareSubscriptionsClient().BeginCancelSynchronization(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", armdatashare.ShareSubscriptionSynchronization{
		SynchronizationID: to.Ptr("7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ShareSubscriptionSynchronization = armdatashare.ShareSubscriptionSynchronization{
	// 	StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-06-30T02:37:48.497Z"); return t}()),
	// 	Status: to.Ptr("Cancelled"),
	// 	SynchronizationID: to.Ptr("343c4772-ad68-41aa-91b9-bab1c92f9c27"),
	// }
}

Output:

func (*ShareSubscriptionsClient) BeginDelete 

func (client *ShareSubscriptionsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, shareSubscriptionName string, options *ShareSubscriptionsClientBeginDeleteOptions) (*runtime.Poller[ShareSubscriptionsClientDeleteResponse], error)

BeginDelete - Delete a shareSubscription in an account If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the shareSubscription.
  • options - ShareSubscriptionsClientBeginDeleteOptions contains the optional parameters for the ShareSubscriptionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ShareSubscriptions_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewShareSubscriptionsClient().BeginDelete(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OperationResponse = armdatashare.OperationResponse{
	// 	Status: to.Ptr(armdatashare.StatusSucceeded),
	// }
}

Output:

func (*ShareSubscriptionsClient) BeginSynchronize 

func (client *ShareSubscriptionsClient) BeginSynchronize(ctx context.Context, resourceGroupName string, accountName string, shareSubscriptionName string, synchronize Synchronize, options *ShareSubscriptionsClientBeginSynchronizeOptions) (*runtime.Poller[ShareSubscriptionsClientSynchronizeResponse], error)

BeginSynchronize - Initiate a copy If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of share subscription
  • synchronize - Synchronize payload
  • options - ShareSubscriptionsClientBeginSynchronizeOptions contains the optional parameters for the ShareSubscriptionsClient.BeginSynchronize method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ShareSubscriptions_Synchronize.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewShareSubscriptionsClient().BeginSynchronize(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", armdatashare.Synchronize{
		SynchronizationMode: to.Ptr(armdatashare.SynchronizationModeIncremental),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ShareSubscriptionSynchronization = armdatashare.ShareSubscriptionSynchronization{
	// 	StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-06-30T02:37:48.497Z"); return t}()),
	// 	Status: to.Ptr("Succeeded"),
	// 	SynchronizationID: to.Ptr("343c4772-ad68-41aa-91b9-bab1c92f9c27"),
	// }
}

Output:

func (*ShareSubscriptionsClient) Create 

func (client *ShareSubscriptionsClient) Create(ctx context.Context, resourceGroupName string, accountName string, shareSubscriptionName string, shareSubscription ShareSubscription, options *ShareSubscriptionsClientCreateOptions) (ShareSubscriptionsClientCreateResponse, error)

Create - Create a shareSubscription in an account If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the shareSubscription.
  • shareSubscription - create parameters for shareSubscription
  • options - ShareSubscriptionsClientCreateOptions contains the optional parameters for the ShareSubscriptionsClient.Create method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ShareSubscriptions_Create.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewShareSubscriptionsClient().Create(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", armdatashare.ShareSubscription{
		Properties: &armdatashare.ShareSubscriptionProperties{
			ExpirationDate:      to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t }()),
			InvitationID:        to.Ptr("12345678-1234-1234-12345678abd"),
			SourceShareLocation: to.Ptr("eastus2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ShareSubscription = armdatashare.ShareSubscription{
	// 	Name: to.Ptr("ShareSubscription1"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions"),
	// 	ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1"),
	// 	Properties: &armdatashare.ShareSubscriptionProperties{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-01-17T22:32:36.818Z"); return t}()),
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
	// 		InvitationID: to.Ptr("4256e2cf-0f82-4865-961b-12f83333f487"),
	// 		ProviderEmail: to.Ptr("jack.rose@microsoft.com"),
	// 		ProviderName: to.Ptr("Jack Rose"),
	// 		ProviderTenantName: to.Ptr("Microsoft"),
	// 		ShareDescription: to.Ptr("Some share"),
	// 		ShareKind: to.Ptr(armdatashare.ShareKindCopyBased),
	// 		ShareName: to.Ptr("share1"),
	// 		ShareSubscriptionStatus: to.Ptr(armdatashare.ShareSubscriptionStatusActive),
	// 		ShareTerms: to.Ptr("Confidential"),
	// 		SourceShareLocation: to.Ptr("eastus2"),
	// 		UserEmail: to.Ptr("john.smith@microsoft.com"),
	// 		UserName: to.Ptr("John Smith"),
	// 	},
	// }
}

Output:

func (*ShareSubscriptionsClient) Get 

func (client *ShareSubscriptionsClient) Get(ctx context.Context, resourceGroupName string, accountName string, shareSubscriptionName string, options *ShareSubscriptionsClientGetOptions) (ShareSubscriptionsClientGetResponse, error)

Get - Get a shareSubscription in an account If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the shareSubscription.
  • options - ShareSubscriptionsClientGetOptions contains the optional parameters for the ShareSubscriptionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ShareSubscriptions_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewShareSubscriptionsClient().Get(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ShareSubscription = armdatashare.ShareSubscription{
	// 	Name: to.Ptr("ShareSubscription1"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions"),
	// 	ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1"),
	// 	Properties: &armdatashare.ShareSubscriptionProperties{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-01-17T22:32:36.818Z"); return t}()),
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
	// 		InvitationID: to.Ptr("4256e2cf-0f82-4865-961b-12f83333f487"),
	// 		ProviderEmail: to.Ptr("jack.rose@microsoft.com"),
	// 		ProviderName: to.Ptr("Jack Rose"),
	// 		ProviderTenantName: to.Ptr("ShareSenderCompanyName"),
	// 		ProvisioningState: to.Ptr(armdatashare.ProvisioningStateSucceeded),
	// 		ShareDescription: to.Ptr("Some share"),
	// 		ShareKind: to.Ptr(armdatashare.ShareKindCopyBased),
	// 		ShareName: to.Ptr("share1"),
	// 		ShareSubscriptionStatus: to.Ptr(armdatashare.ShareSubscriptionStatusActive),
	// 		ShareTerms: to.Ptr("Confidential"),
	// 		SourceShareLocation: to.Ptr("eastus2"),
	// 		UserEmail: to.Ptr("john.smith@microsoft.com"),
	// 		UserName: to.Ptr("John Smith"),
	// 	},
	// }
}

Output:

func (*ShareSubscriptionsClient) NewListByAccountPager added in v0.4.0 

func (client *ShareSubscriptionsClient) NewListByAccountPager(resourceGroupName string, accountName string, options *ShareSubscriptionsClientListByAccountOptions) *runtime.Pager[ShareSubscriptionsClientListByAccountResponse]

NewListByAccountPager - List share subscriptions in an account

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • options - ShareSubscriptionsClientListByAccountOptions contains the optional parameters for the ShareSubscriptionsClient.NewListByAccountPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ShareSubscriptions_ListByAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewShareSubscriptionsClient().NewListByAccountPager("SampleResourceGroup", "Account1", &armdatashare.ShareSubscriptionsClientListByAccountOptions{SkipToken: nil,
		Filter:  nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ShareSubscriptionList = armdatashare.ShareSubscriptionList{
		// 	Value: []*armdatashare.ShareSubscription{
		// 		{
		// 			Name: to.Ptr("ShareSubscription1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1"),
		// 			Properties: &armdatashare.ShareSubscriptionProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T06:15:15.681Z"); return t}()),
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
		// 				InvitationID: to.Ptr("12345678-1234-1234-12345678abd"),
		// 				ProviderEmail: to.Ptr("jack.rose@microsoft.com"),
		// 				ProviderName: to.Ptr("Jack Rose"),
		// 				ProviderTenantName: to.Ptr("Microsoft"),
		// 				ShareDescription: to.Ptr("Some share"),
		// 				ShareKind: to.Ptr(armdatashare.ShareKindCopyBased),
		// 				ShareName: to.Ptr("share1"),
		// 				ShareSubscriptionStatus: to.Ptr(armdatashare.ShareSubscriptionStatusActive),
		// 				ShareTerms: to.Ptr("Confidential"),
		// 				SourceShareLocation: to.Ptr("eastus2"),
		// 				UserEmail: to.Ptr("john.smith@microsoft.com"),
		// 				UserName: to.Ptr("johnsmith@microsoft.com"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("ShareSubscription1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1"),
		// 			Properties: &armdatashare.ShareSubscriptionProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-17T22:32:36.818Z"); return t}()),
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-26T22:33:24.578Z"); return t}()),
		// 				InvitationID: to.Ptr("4256e2cf-0f82-4865-961b-12f83333f487"),
		// 				ProviderEmail: to.Ptr("jack.rose@microsoft.com"),
		// 				ProviderName: to.Ptr("Jack Rose"),
		// 				ProviderTenantName: to.Ptr("Microsoft"),
		// 				ShareDescription: to.Ptr("Some share"),
		// 				ShareKind: to.Ptr(armdatashare.ShareKindCopyBased),
		// 				ShareName: to.Ptr("share1"),
		// 				ShareSubscriptionStatus: to.Ptr(armdatashare.ShareSubscriptionStatusActive),
		// 				ShareTerms: to.Ptr("Confidential"),
		// 				SourceShareLocation: to.Ptr("eastus2"),
		// 				UserEmail: to.Ptr("john.smith@microsoft.com"),
		// 				UserName: to.Ptr("John Smith"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*ShareSubscriptionsClient) NewListSourceShareSynchronizationSettingsPager added in v0.4.0 

func (client *ShareSubscriptionsClient) NewListSourceShareSynchronizationSettingsPager(resourceGroupName string, accountName string, shareSubscriptionName string, options *ShareSubscriptionsClientListSourceShareSynchronizationSettingsOptions) *runtime.Pager[ShareSubscriptionsClientListSourceShareSynchronizationSettingsResponse]

NewListSourceShareSynchronizationSettingsPager - Get synchronization settings set on a share

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the shareSubscription.
  • options - ShareSubscriptionsClientListSourceShareSynchronizationSettingsOptions contains the optional parameters for the ShareSubscriptionsClient.NewListSourceShareSynchronizationSettingsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ShareSubscriptions_ListSourceShareSynchronizationSettings.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewShareSubscriptionsClient().NewListSourceShareSynchronizationSettingsPager("SampleResourceGroup", "Account1", "ShareSub1", &armdatashare.ShareSubscriptionsClientListSourceShareSynchronizationSettingsOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SourceShareSynchronizationSettingList = armdatashare.SourceShareSynchronizationSettingList{
		// 	Value: []armdatashare.SourceShareSynchronizationSettingClassification{
		// 		&armdatashare.ScheduledSourceSynchronizationSetting{
		// 			Kind: to.Ptr(armdatashare.SourceShareSynchronizationSettingKindScheduleBased),
		// 			Properties: &armdatashare.ScheduledSourceShareSynchronizationSettingProperties{
		// 				RecurrenceInterval: to.Ptr(armdatashare.RecurrenceIntervalHour),
		// 				SynchronizationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-15T19:45:58.000Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*ShareSubscriptionsClient) NewListSynchronizationDetailsPager added in v0.4.0 

func (client *ShareSubscriptionsClient) NewListSynchronizationDetailsPager(resourceGroupName string, accountName string, shareSubscriptionName string, shareSubscriptionSynchronization ShareSubscriptionSynchronization, options *ShareSubscriptionsClientListSynchronizationDetailsOptions) *runtime.Pager[ShareSubscriptionsClientListSynchronizationDetailsResponse]

NewListSynchronizationDetailsPager - List synchronization details

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the share subscription.
  • shareSubscriptionSynchronization - Share Subscription Synchronization payload.
  • options - ShareSubscriptionsClientListSynchronizationDetailsOptions contains the optional parameters for the ShareSubscriptionsClient.NewListSynchronizationDetailsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ShareSubscriptions_ListSynchronizationDetails.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewShareSubscriptionsClient().NewListSynchronizationDetailsPager("SampleResourceGroup", "Account1", "ShareSub1", armdatashare.ShareSubscriptionSynchronization{
		SynchronizationID: to.Ptr("7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"),
	}, &armdatashare.ShareSubscriptionsClientListSynchronizationDetailsOptions{SkipToken: nil,
		Filter:  nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SynchronizationDetailsList = armdatashare.SynchronizationDetailsList{
		// 	Value: []*armdatashare.SynchronizationDetails{
		// 		{
		// 			Name: to.Ptr("datasetmapping1"),
		// 			DataSetID: to.Ptr("7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"),
		// 			DataSetType: to.Ptr(armdatashare.DataSetTypeBlob),
		// 			DurationMs: to.Ptr[int32](2000),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 			Status: to.Ptr("Completed"),
		// 	}},
		// }
	}
}

Output:

func (*ShareSubscriptionsClient) NewListSynchronizationsPager added in v0.4.0 

func (client *ShareSubscriptionsClient) NewListSynchronizationsPager(resourceGroupName string, accountName string, shareSubscriptionName string, options *ShareSubscriptionsClientListSynchronizationsOptions) *runtime.Pager[ShareSubscriptionsClientListSynchronizationsResponse]

NewListSynchronizationsPager - List synchronizations of a share subscription

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the share subscription.
  • options - ShareSubscriptionsClientListSynchronizationsOptions contains the optional parameters for the ShareSubscriptionsClient.NewListSynchronizationsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/ShareSubscriptions_ListSynchronizations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewShareSubscriptionsClient().NewListSynchronizationsPager("SampleResourceGroup", "Account1", "ShareSub1", &armdatashare.ShareSubscriptionsClientListSynchronizationsOptions{SkipToken: nil,
		Filter:  nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ShareSubscriptionSynchronizationList = armdatashare.ShareSubscriptionSynchronizationList{
		// 	Value: []*armdatashare.ShareSubscriptionSynchronization{
		// 		{
		// 			DurationMs: to.Ptr[int32](2000),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 			Message: to.Ptr("nda"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 			Status: to.Ptr("Completed"),
		// 			SynchronizationID: to.Ptr("runId"),
		// 			SynchronizationMode: to.Ptr(armdatashare.SynchronizationModeIncremental),
		// 	}},
		// }
	}
}

Output:

type ShareSubscriptionsClientBeginCancelSynchronizationOptions added in v0.2.0 

type ShareSubscriptionsClientBeginCancelSynchronizationOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ShareSubscriptionsClientBeginCancelSynchronizationOptions contains the optional parameters for the ShareSubscriptionsClient.BeginCancelSynchronization method.

type ShareSubscriptionsClientBeginDeleteOptions added in v0.2.0 

type ShareSubscriptionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ShareSubscriptionsClientBeginDeleteOptions contains the optional parameters for the ShareSubscriptionsClient.BeginDelete method.

type ShareSubscriptionsClientBeginSynchronizeOptions added in v0.2.0 

type ShareSubscriptionsClientBeginSynchronizeOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ShareSubscriptionsClientBeginSynchronizeOptions contains the optional parameters for the ShareSubscriptionsClient.BeginSynchronize method.

type ShareSubscriptionsClientCancelSynchronizationResponse added in v0.2.0 

type ShareSubscriptionsClientCancelSynchronizationResponse struct {
	// A ShareSubscriptionSynchronization data transfer object.
	ShareSubscriptionSynchronization
}

ShareSubscriptionsClientCancelSynchronizationResponse contains the response from method ShareSubscriptionsClient.BeginCancelSynchronization.

type ShareSubscriptionsClientCreateOptions added in v0.2.0 

type ShareSubscriptionsClientCreateOptions struct {
}

ShareSubscriptionsClientCreateOptions contains the optional parameters for the ShareSubscriptionsClient.Create method.

type ShareSubscriptionsClientCreateResponse added in v0.2.0 

type ShareSubscriptionsClientCreateResponse struct {
	// A share subscription data transfer object.
	ShareSubscription
}

ShareSubscriptionsClientCreateResponse contains the response from method ShareSubscriptionsClient.Create.

type ShareSubscriptionsClientDeleteResponse added in v0.2.0 

type ShareSubscriptionsClientDeleteResponse struct {
	// Response for long running operation
	OperationResponse
}

ShareSubscriptionsClientDeleteResponse contains the response from method ShareSubscriptionsClient.BeginDelete.

type ShareSubscriptionsClientGetOptions added in v0.2.0 

type ShareSubscriptionsClientGetOptions struct {
}

ShareSubscriptionsClientGetOptions contains the optional parameters for the ShareSubscriptionsClient.Get method.

type ShareSubscriptionsClientGetResponse added in v0.2.0 

type ShareSubscriptionsClientGetResponse struct {
	// A share subscription data transfer object.
	ShareSubscription
}

ShareSubscriptionsClientGetResponse contains the response from method ShareSubscriptionsClient.Get.

type ShareSubscriptionsClientListByAccountOptions added in v0.2.0 

type ShareSubscriptionsClientListByAccountOptions struct {
	// Filters the results using OData syntax.
	Filter *string

	// Sorts the results using OData syntax.
	Orderby *string

	// Continuation Token
	SkipToken *string
}

ShareSubscriptionsClientListByAccountOptions contains the optional parameters for the ShareSubscriptionsClient.NewListByAccountPager method.

type ShareSubscriptionsClientListByAccountResponse added in v0.2.0 

type ShareSubscriptionsClientListByAccountResponse struct {
	// List response for get ShareSubscription.
	ShareSubscriptionList
}

ShareSubscriptionsClientListByAccountResponse contains the response from method ShareSubscriptionsClient.NewListByAccountPager.

type ShareSubscriptionsClientListSourceShareSynchronizationSettingsOptions added in v0.2.0 

type ShareSubscriptionsClientListSourceShareSynchronizationSettingsOptions struct {
	// Continuation token
	SkipToken *string
}

ShareSubscriptionsClientListSourceShareSynchronizationSettingsOptions contains the optional parameters for the ShareSubscriptionsClient.NewListSourceShareSynchronizationSettingsPager method.

type ShareSubscriptionsClientListSourceShareSynchronizationSettingsResponse added in v0.2.0 

type ShareSubscriptionsClientListSourceShareSynchronizationSettingsResponse struct {
	// List response for get source share Synchronization settings
	SourceShareSynchronizationSettingList
}

ShareSubscriptionsClientListSourceShareSynchronizationSettingsResponse contains the response from method ShareSubscriptionsClient.NewListSourceShareSynchronizationSettingsPager.

type ShareSubscriptionsClientListSynchronizationDetailsOptions added in v0.2.0 

type ShareSubscriptionsClientListSynchronizationDetailsOptions struct {
	// Filters the results using OData syntax.
	Filter *string

	// Sorts the results using OData syntax.
	Orderby *string

	// Continuation token
	SkipToken *string
}

ShareSubscriptionsClientListSynchronizationDetailsOptions contains the optional parameters for the ShareSubscriptionsClient.NewListSynchronizationDetailsPager method.

type ShareSubscriptionsClientListSynchronizationDetailsResponse added in v0.2.0 

type ShareSubscriptionsClientListSynchronizationDetailsResponse struct {
	// details of synchronization
	SynchronizationDetailsList
}

ShareSubscriptionsClientListSynchronizationDetailsResponse contains the response from method ShareSubscriptionsClient.NewListSynchronizationDetailsPager.

type ShareSubscriptionsClientListSynchronizationsOptions added in v0.2.0 

type ShareSubscriptionsClientListSynchronizationsOptions struct {
	// Filters the results using OData syntax.
	Filter *string

	// Sorts the results using OData syntax.
	Orderby *string

	// Continuation token
	SkipToken *string
}

ShareSubscriptionsClientListSynchronizationsOptions contains the optional parameters for the ShareSubscriptionsClient.NewListSynchronizationsPager method.

type ShareSubscriptionsClientListSynchronizationsResponse added in v0.2.0 

type ShareSubscriptionsClientListSynchronizationsResponse struct {
	// A consumer side list of share subscription synchronizations
	ShareSubscriptionSynchronizationList
}

ShareSubscriptionsClientListSynchronizationsResponse contains the response from method ShareSubscriptionsClient.NewListSynchronizationsPager.

type ShareSubscriptionsClientSynchronizeResponse added in v0.2.0 

type ShareSubscriptionsClientSynchronizeResponse struct {
	// A ShareSubscriptionSynchronization data transfer object.
	ShareSubscriptionSynchronization
}

ShareSubscriptionsClientSynchronizeResponse contains the response from method ShareSubscriptionsClient.BeginSynchronize.

type ShareSynchronization 

type ShareSynchronization struct {
	// Email of the user who created the synchronization
	ConsumerEmail *string

	// Name of the user who created the synchronization
	ConsumerName *string

	// Tenant name of the consumer who created the synchronization
	ConsumerTenantName *string

	// synchronization duration
	DurationMs *int32

	// End time of synchronization
	EndTime *time.Time

	// message of synchronization
	Message *string

	// start time of synchronization
	StartTime *time.Time

	// Raw Status
	Status *string

	// Synchronization id
	SynchronizationID *string

	// READ-ONLY; Synchronization mode
	SynchronizationMode *SynchronizationMode
}

ShareSynchronization - A ShareSynchronization data transfer object.

func (ShareSynchronization) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareSynchronization.

func (*ShareSynchronization) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ShareSynchronization.

type ShareSynchronizationList 

type ShareSynchronizationList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []*ShareSynchronization

	// The Url of next result page.
	NextLink *string
}

ShareSynchronizationList - List response for get ShareSynchronization.

func (ShareSynchronizationList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ShareSynchronizationList.

func (*ShareSynchronizationList) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ShareSynchronizationList.

type SharesClient 

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

SharesClient contains the methods for the Shares group. Don't use this type directly, use NewSharesClient() instead.

func NewSharesClient 

func NewSharesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SharesClient, error)

NewSharesClient creates a new instance of SharesClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SharesClient) BeginDelete 

func (client *SharesClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, shareName string, options *SharesClientBeginDeleteOptions) (*runtime.Poller[SharesClientDeleteResponse], error)

BeginDelete - Delete a share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • options - SharesClientBeginDeleteOptions contains the optional parameters for the SharesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Shares_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSharesClient().BeginDelete(ctx, "SampleResourceGroup", "Account1", "Share1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OperationResponse = armdatashare.OperationResponse{
	// 	Status: to.Ptr(armdatashare.StatusSucceeded),
	// }
}

Output:

func (*SharesClient) Create 

func (client *SharesClient) Create(ctx context.Context, resourceGroupName string, accountName string, shareName string, share Share, options *SharesClientCreateOptions) (SharesClientCreateResponse, error)

Create - Create a share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • share - The share payload
  • options - SharesClientCreateOptions contains the optional parameters for the SharesClient.Create method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Shares_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSharesClient().Create(ctx, "SampleResourceGroup", "Account1", "Share1", armdatashare.Share{
		Properties: &armdatashare.ShareProperties{
			Description: to.Ptr("share description"),
			ShareKind:   to.Ptr(armdatashare.ShareKindCopyBased),
			Terms:       to.Ptr("Confidential"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Share = armdatashare.Share{
	// 	Name: to.Ptr("Share1"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts/shares"),
	// 	ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1"),
	// 	Properties: &armdatashare.ShareProperties{
	// 		Description: to.Ptr("share description"),
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T06:15:15.681Z"); return t}()),
	// 		ShareKind: to.Ptr(armdatashare.ShareKindCopyBased),
	// 		Terms: to.Ptr("Confidential"),
	// 		UserEmail: to.Ptr("johnsmith@microsoft.com"),
	// 		UserName: to.Ptr("John Smith"),
	// 	},
	// }
}

Output:

func (*SharesClient) Get 

func (client *SharesClient) Get(ctx context.Context, resourceGroupName string, accountName string, shareName string, options *SharesClientGetOptions) (SharesClientGetResponse, error)

Get - Get a share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share to retrieve.
  • options - SharesClientGetOptions contains the optional parameters for the SharesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Shares_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSharesClient().Get(ctx, "SampleResourceGroup", "Account1", "Share1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Share = armdatashare.Share{
	// 	Name: to.Ptr("Share1"),
	// 	Type: to.Ptr("Microsoft.DataShare/accounts/shares"),
	// 	ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1"),
	// 	Properties: &armdatashare.ShareProperties{
	// 		Description: to.Ptr("share description"),
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T06:15:15.681Z"); return t}()),
	// 		ShareKind: to.Ptr(armdatashare.ShareKindCopyBased),
	// 		Terms: to.Ptr("Confidential"),
	// 		UserEmail: to.Ptr("johnsmith@microsoft.com"),
	// 		UserName: to.Ptr("John Smith"),
	// 	},
	// }
}

Output:

func (*SharesClient) NewListByAccountPager added in v0.4.0 

func (client *SharesClient) NewListByAccountPager(resourceGroupName string, accountName string, options *SharesClientListByAccountOptions) *runtime.Pager[SharesClientListByAccountResponse]

NewListByAccountPager - List shares in an account

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • options - SharesClientListByAccountOptions contains the optional parameters for the SharesClient.NewListByAccountPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Shares_ListByAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSharesClient().NewListByAccountPager("SampleResourceGroup", "Account1", &armdatashare.SharesClientListByAccountOptions{SkipToken: nil,
		Filter:  nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ShareList = armdatashare.ShareList{
		// 	Value: []*armdatashare.Share{
		// 		{
		// 			Name: to.Ptr("Share1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/shares"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1"),
		// 			Properties: &armdatashare.ShareProperties{
		// 				Description: to.Ptr("share description"),
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T06:15:15.681Z"); return t}()),
		// 				ShareKind: to.Ptr(armdatashare.ShareKindCopyBased),
		// 				Terms: to.Ptr("Confidential"),
		// 				UserEmail: to.Ptr("johnsmith@microsoft.com"),
		// 				UserName: to.Ptr("John Smith"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Share1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/shares"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1"),
		// 			Properties: &armdatashare.ShareProperties{
		// 				Description: to.Ptr("share description"),
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-14T06:15:15.681Z"); return t}()),
		// 				ShareKind: to.Ptr(armdatashare.ShareKindCopyBased),
		// 				Terms: to.Ptr("Confidential"),
		// 				UserEmail: to.Ptr("johnsmith@microsoft.com"),
		// 				UserName: to.Ptr("John Smith"),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*SharesClient) NewListSynchronizationDetailsPager added in v0.4.0 

func (client *SharesClient) NewListSynchronizationDetailsPager(resourceGroupName string, accountName string, shareName string, shareSynchronization ShareSynchronization, options *SharesClientListSynchronizationDetailsOptions) *runtime.Pager[SharesClientListSynchronizationDetailsResponse]

NewListSynchronizationDetailsPager - List synchronization details

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • shareSynchronization - Share Synchronization payload.
  • options - SharesClientListSynchronizationDetailsOptions contains the optional parameters for the SharesClient.NewListSynchronizationDetailsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Shares_ListSynchronizationDetails.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSharesClient().NewListSynchronizationDetailsPager("SampleResourceGroup", "Account1", "Share1", armdatashare.ShareSynchronization{
		SynchronizationID: to.Ptr("7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"),
	}, &armdatashare.SharesClientListSynchronizationDetailsOptions{SkipToken: nil,
		Filter:  nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SynchronizationDetailsList = armdatashare.SynchronizationDetailsList{
		// 	Value: []*armdatashare.SynchronizationDetails{
		// 		{
		// 			Name: to.Ptr("dataset1"),
		// 			DataSetID: to.Ptr("7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"),
		// 			DataSetType: to.Ptr(armdatashare.DataSetTypeBlob),
		// 			DurationMs: to.Ptr[int32](2000),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 			Status: to.Ptr("Completed"),
		// 	}},
		// }
	}
}

Output:

func (*SharesClient) NewListSynchronizationsPager added in v0.4.0 

func (client *SharesClient) NewListSynchronizationsPager(resourceGroupName string, accountName string, shareName string, options *SharesClientListSynchronizationsOptions) *runtime.Pager[SharesClientListSynchronizationsResponse]

NewListSynchronizationsPager - List synchronizations of a share

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • options - SharesClientListSynchronizationsOptions contains the optional parameters for the SharesClient.NewListSynchronizationsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Shares_ListSynchronizations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSharesClient().NewListSynchronizationsPager("SampleResourceGroup", "Account1", "Share1", &armdatashare.SharesClientListSynchronizationsOptions{SkipToken: nil,
		Filter:  nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ShareSynchronizationList = armdatashare.ShareSynchronizationList{
		// 	Value: []*armdatashare.ShareSynchronization{
		// 		{
		// 			ConsumerName: to.Ptr("abc@yahoo.com"),
		// 			ConsumerTenantName: to.Ptr("nda"),
		// 			DurationMs: to.Ptr[int32](2000),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 			Message: to.Ptr("nda"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 			Status: to.Ptr("Completed"),
		// 			SynchronizationID: to.Ptr("runId"),
		// 			SynchronizationMode: to.Ptr(armdatashare.SynchronizationModeIncremental),
		// 	}},
		// }
	}
}

Output:

type SharesClientBeginDeleteOptions added in v0.2.0 

type SharesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SharesClientBeginDeleteOptions contains the optional parameters for the SharesClient.BeginDelete method.

type SharesClientCreateOptions added in v0.2.0 

type SharesClientCreateOptions struct {
}

SharesClientCreateOptions contains the optional parameters for the SharesClient.Create method.

type SharesClientCreateResponse added in v0.2.0 

type SharesClientCreateResponse struct {
	// A share data transfer object.
	Share
}

SharesClientCreateResponse contains the response from method SharesClient.Create.

type SharesClientDeleteResponse added in v0.2.0 

type SharesClientDeleteResponse struct {
	// Response for long running operation
	OperationResponse
}

SharesClientDeleteResponse contains the response from method SharesClient.BeginDelete.

type SharesClientGetOptions added in v0.2.0 

type SharesClientGetOptions struct {
}

SharesClientGetOptions contains the optional parameters for the SharesClient.Get method.

type SharesClientGetResponse added in v0.2.0 

type SharesClientGetResponse struct {
	// A share data transfer object.
	Share
}

SharesClientGetResponse contains the response from method SharesClient.Get.

type SharesClientListByAccountOptions added in v0.2.0 

type SharesClientListByAccountOptions struct {
	// Filters the results using OData syntax.
	Filter *string

	// Sorts the results using OData syntax.
	Orderby *string

	// Continuation Token
	SkipToken *string
}

SharesClientListByAccountOptions contains the optional parameters for the SharesClient.NewListByAccountPager method.

type SharesClientListByAccountResponse added in v0.2.0 

type SharesClientListByAccountResponse struct {
	// List response for get Shares.
	ShareList
}

SharesClientListByAccountResponse contains the response from method SharesClient.NewListByAccountPager.

type SharesClientListSynchronizationDetailsOptions added in v0.2.0 

type SharesClientListSynchronizationDetailsOptions struct {
	// Filters the results using OData syntax.
	Filter *string

	// Sorts the results using OData syntax.
	Orderby *string

	// Continuation token
	SkipToken *string
}

SharesClientListSynchronizationDetailsOptions contains the optional parameters for the SharesClient.NewListSynchronizationDetailsPager method.

type SharesClientListSynchronizationDetailsResponse added in v0.2.0 

type SharesClientListSynchronizationDetailsResponse struct {
	// details of synchronization
	SynchronizationDetailsList
}

SharesClientListSynchronizationDetailsResponse contains the response from method SharesClient.NewListSynchronizationDetailsPager.

type SharesClientListSynchronizationsOptions added in v0.2.0 

type SharesClientListSynchronizationsOptions struct {
	// Filters the results using OData syntax.
	Filter *string

	// Sorts the results using OData syntax.
	Orderby *string

	// Continuation token
	SkipToken *string
}

SharesClientListSynchronizationsOptions contains the optional parameters for the SharesClient.NewListSynchronizationsPager method.

type SharesClientListSynchronizationsResponse added in v0.2.0 

type SharesClientListSynchronizationsResponse struct {
	// List response for get ShareSynchronization.
	ShareSynchronizationList
}

SharesClientListSynchronizationsResponse contains the response from method SharesClient.NewListSynchronizationsPager.

type SourceShareSynchronizationSetting 

type SourceShareSynchronizationSetting struct {
	// REQUIRED; Kind of synchronization setting on share.
	Kind *SourceShareSynchronizationSettingKind
}

SourceShareSynchronizationSetting - A view of synchronization setting added by the provider

func (*SourceShareSynchronizationSetting) GetSourceShareSynchronizationSetting 

func (s *SourceShareSynchronizationSetting) GetSourceShareSynchronizationSetting() *SourceShareSynchronizationSetting

GetSourceShareSynchronizationSetting implements the SourceShareSynchronizationSettingClassification interface for type SourceShareSynchronizationSetting.

func (SourceShareSynchronizationSetting) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type SourceShareSynchronizationSetting.

func (*SourceShareSynchronizationSetting) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SourceShareSynchronizationSetting.

type SourceShareSynchronizationSettingClassification 

type SourceShareSynchronizationSettingClassification interface {
	// GetSourceShareSynchronizationSetting returns the SourceShareSynchronizationSetting content of the underlying type.
	GetSourceShareSynchronizationSetting() *SourceShareSynchronizationSetting
}

SourceShareSynchronizationSettingClassification provides polymorphic access to related types. Call the interface's GetSourceShareSynchronizationSetting() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ScheduledSourceSynchronizationSetting, *SourceShareSynchronizationSetting

type SourceShareSynchronizationSettingKind 

type SourceShareSynchronizationSettingKind string

SourceShareSynchronizationSettingKind - Kind of synchronization setting on share. 

const (
	SourceShareSynchronizationSettingKindScheduleBased SourceShareSynchronizationSettingKind = "ScheduleBased"
)

func PossibleSourceShareSynchronizationSettingKindValues 

func PossibleSourceShareSynchronizationSettingKindValues() []SourceShareSynchronizationSettingKind

PossibleSourceShareSynchronizationSettingKindValues returns the possible values for the SourceShareSynchronizationSettingKind const type.

type SourceShareSynchronizationSettingList 

type SourceShareSynchronizationSettingList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []SourceShareSynchronizationSettingClassification

	// The Url of next result page.
	NextLink *string
}

SourceShareSynchronizationSettingList - List response for get source share Synchronization settings

func (SourceShareSynchronizationSettingList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SourceShareSynchronizationSettingList.

func (*SourceShareSynchronizationSettingList) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SourceShareSynchronizationSettingList.

type Status 

type Status string

Status - Operation state of the long running operation. 

const (
	StatusAccepted         Status = "Accepted"
	StatusCanceled         Status = "Canceled"
	StatusFailed           Status = "Failed"
	StatusInProgress       Status = "InProgress"
	StatusSucceeded        Status = "Succeeded"
	StatusTransientFailure Status = "TransientFailure"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns the possible values for the Status const type.

type SynapseWorkspaceSQLPoolTableDataSet 

type SynapseWorkspaceSQLPoolTableDataSet struct {
	// REQUIRED; Kind of data set.
	Kind *DataSetKind

	// REQUIRED; Synapse Workspace Sql Pool Table data set properties.
	Properties *SynapseWorkspaceSQLPoolTableDataSetProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

SynapseWorkspaceSQLPoolTableDataSet - A Synapse Workspace Sql Pool Table data set.

func (*SynapseWorkspaceSQLPoolTableDataSet) GetDataSet added in v0.2.0 

func (s *SynapseWorkspaceSQLPoolTableDataSet) GetDataSet() *DataSet

GetDataSet implements the DataSetClassification interface for type SynapseWorkspaceSQLPoolTableDataSet.

func (SynapseWorkspaceSQLPoolTableDataSet) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SynapseWorkspaceSQLPoolTableDataSet.

func (*SynapseWorkspaceSQLPoolTableDataSet) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SynapseWorkspaceSQLPoolTableDataSet.

type SynapseWorkspaceSQLPoolTableDataSetMapping 

type SynapseWorkspaceSQLPoolTableDataSetMapping struct {
	// REQUIRED; Kind of data set mapping.
	Kind *DataSetMappingKind

	// REQUIRED; A Synapse Workspace Sql Pool Table data set mapping properties.
	Properties *SynapseWorkspaceSQLPoolTableDataSetMappingProperties

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

SynapseWorkspaceSQLPoolTableDataSetMapping - A Synapse Workspace Sql Pool Table data set mapping

func (*SynapseWorkspaceSQLPoolTableDataSetMapping) GetDataSetMapping added in v0.2.0 

func (s *SynapseWorkspaceSQLPoolTableDataSetMapping) GetDataSetMapping() *DataSetMapping

GetDataSetMapping implements the DataSetMappingClassification interface for type SynapseWorkspaceSQLPoolTableDataSetMapping.

func (SynapseWorkspaceSQLPoolTableDataSetMapping) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SynapseWorkspaceSQLPoolTableDataSetMapping.

func (*SynapseWorkspaceSQLPoolTableDataSetMapping) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SynapseWorkspaceSQLPoolTableDataSetMapping.

type SynapseWorkspaceSQLPoolTableDataSetMappingProperties 

type SynapseWorkspaceSQLPoolTableDataSetMappingProperties struct {
	// REQUIRED; The id of the source data set.
	DataSetID *string

	// REQUIRED; Resource id of the Synapse Workspace SQL Pool Table
	SynapseWorkspaceSQLPoolTableResourceID *string

	// READ-ONLY; Gets the status of the data set mapping.
	DataSetMappingStatus *DataSetMappingStatus

	// READ-ONLY; Provisioning state of the data set mapping.
	ProvisioningState *ProvisioningState
}

SynapseWorkspaceSQLPoolTableDataSetMappingProperties - Properties of the Synapse Workspace SQL Pool Table data set mapping

func (SynapseWorkspaceSQLPoolTableDataSetMappingProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type SynapseWorkspaceSQLPoolTableDataSetMappingProperties.

func (*SynapseWorkspaceSQLPoolTableDataSetMappingProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SynapseWorkspaceSQLPoolTableDataSetMappingProperties.

type SynapseWorkspaceSQLPoolTableDataSetProperties 

type SynapseWorkspaceSQLPoolTableDataSetProperties struct {
	// REQUIRED; Resource id of the Synapse Workspace SQL Pool Table
	SynapseWorkspaceSQLPoolTableResourceID *string

	// READ-ONLY; Unique id for identifying a data set resource
	DataSetID *string
}

SynapseWorkspaceSQLPoolTableDataSetProperties - Properties of the Synapse Workspace SQL Pool Table data set.

func (SynapseWorkspaceSQLPoolTableDataSetProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type SynapseWorkspaceSQLPoolTableDataSetProperties.

func (*SynapseWorkspaceSQLPoolTableDataSetProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SynapseWorkspaceSQLPoolTableDataSetProperties.

type SynchronizationDetails 

type SynchronizationDetails struct {
	// READ-ONLY; Id of data set
	DataSetID *string

	// READ-ONLY; Type of the data set
	DataSetType *DataSetType

	// READ-ONLY; Duration of data set level copy
	DurationMs *int32

	// READ-ONLY; End time of data set level copy
	EndTime *time.Time

	// READ-ONLY; The number of files read from the source data set
	FilesRead *int64

	// READ-ONLY; The number of files written into the sink data set
	FilesWritten *int64

	// READ-ONLY; Error message if any
	Message *string

	// READ-ONLY; Name of the data set
	Name *string

	// READ-ONLY; The number of files copied into the sink data set
	RowsCopied *int64

	// READ-ONLY; The number of rows read from the source data set.
	RowsRead *int64

	// READ-ONLY; The size of the data read from the source data set in bytes
	SizeRead *int64

	// READ-ONLY; The size of the data written into the sink data set in bytes
	SizeWritten *int64

	// READ-ONLY; Start time of data set level copy
	StartTime *time.Time

	// READ-ONLY; Raw Status
	Status *string

	// READ-ONLY; The vCore units consumed for the data set synchronization
	VCore *int64
}

SynchronizationDetails - Synchronization details at data set level

func (SynchronizationDetails) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SynchronizationDetails.

func (*SynchronizationDetails) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SynchronizationDetails.

type SynchronizationDetailsList 

type SynchronizationDetailsList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []*SynchronizationDetails

	// The Url of next result page.
	NextLink *string
}

SynchronizationDetailsList - details of synchronization

func (SynchronizationDetailsList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SynchronizationDetailsList.

func (*SynchronizationDetailsList) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SynchronizationDetailsList.

type SynchronizationMode 

type SynchronizationMode string

SynchronizationMode - Synchronization mode 

const (
	SynchronizationModeFullSync    SynchronizationMode = "FullSync"
	SynchronizationModeIncremental SynchronizationMode = "Incremental"
)

func PossibleSynchronizationModeValues 

func PossibleSynchronizationModeValues() []SynchronizationMode

PossibleSynchronizationModeValues returns the possible values for the SynchronizationMode const type.

type SynchronizationSetting 

type SynchronizationSetting struct {
	// REQUIRED; Kind of synchronization setting.
	Kind *SynchronizationSettingKind

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

SynchronizationSetting - A Synchronization Setting data transfer object.

func (*SynchronizationSetting) GetSynchronizationSetting 

func (s *SynchronizationSetting) GetSynchronizationSetting() *SynchronizationSetting

GetSynchronizationSetting implements the SynchronizationSettingClassification interface for type SynchronizationSetting.

func (SynchronizationSetting) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type SynchronizationSetting.

func (*SynchronizationSetting) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SynchronizationSetting.

type SynchronizationSettingClassification 

type SynchronizationSettingClassification interface {
	// GetSynchronizationSetting returns the SynchronizationSetting content of the underlying type.
	GetSynchronizationSetting() *SynchronizationSetting
}

SynchronizationSettingClassification provides polymorphic access to related types. Call the interface's GetSynchronizationSetting() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ScheduledSynchronizationSetting, *SynchronizationSetting

type SynchronizationSettingKind 

type SynchronizationSettingKind string

SynchronizationSettingKind - Kind of synchronization setting. 

const (
	SynchronizationSettingKindScheduleBased SynchronizationSettingKind = "ScheduleBased"
)

func PossibleSynchronizationSettingKindValues 

func PossibleSynchronizationSettingKindValues() []SynchronizationSettingKind

PossibleSynchronizationSettingKindValues returns the possible values for the SynchronizationSettingKind const type.

type SynchronizationSettingList 

type SynchronizationSettingList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []SynchronizationSettingClassification

	// The Url of next result page.
	NextLink *string
}

SynchronizationSettingList - List response for get Synchronization settings

func (SynchronizationSettingList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SynchronizationSettingList.

func (*SynchronizationSettingList) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SynchronizationSettingList.

type SynchronizationSettingsClient 

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

SynchronizationSettingsClient contains the methods for the SynchronizationSettings group. Don't use this type directly, use NewSynchronizationSettingsClient() instead.

func NewSynchronizationSettingsClient 

func NewSynchronizationSettingsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SynchronizationSettingsClient, error)

NewSynchronizationSettingsClient creates a new instance of SynchronizationSettingsClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SynchronizationSettingsClient) BeginDelete 

func (client *SynchronizationSettingsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, shareName string, synchronizationSettingName string, options *SynchronizationSettingsClientBeginDeleteOptions) (*runtime.Poller[SynchronizationSettingsClientDeleteResponse], error)

BeginDelete - Delete a synchronizationSetting in a share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • synchronizationSettingName - The name of the synchronizationSetting .
  • options - SynchronizationSettingsClientBeginDeleteOptions contains the optional parameters for the SynchronizationSettingsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/SynchronizationSettings_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSynchronizationSettingsClient().BeginDelete(ctx, "SampleResourceGroup", "Account1", "Share1", "SynchronizationSetting1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OperationResponse = armdatashare.OperationResponse{
	// 	Status: to.Ptr(armdatashare.StatusSucceeded),
	// }
}

Output:

func (*SynchronizationSettingsClient) Create 

func (client *SynchronizationSettingsClient) Create(ctx context.Context, resourceGroupName string, accountName string, shareName string, synchronizationSettingName string, synchronizationSetting SynchronizationSettingClassification, options *SynchronizationSettingsClientCreateOptions) (SynchronizationSettingsClientCreateResponse, error)

Create - Create a synchronizationSetting If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share to add the synchronization setting to.
  • synchronizationSettingName - The name of the synchronizationSetting.
  • synchronizationSetting - The new synchronization setting information.
  • options - SynchronizationSettingsClientCreateOptions contains the optional parameters for the SynchronizationSettingsClient.Create method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/SynchronizationSettings_Create.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSynchronizationSettingsClient().Create(ctx, "SampleResourceGroup", "Account1", "Share1", "Dataset1", &armdatashare.ScheduledSynchronizationSetting{
		Kind: to.Ptr(armdatashare.SynchronizationSettingKindScheduleBased),
		Properties: &armdatashare.ScheduledSynchronizationSettingProperties{
			RecurrenceInterval:  to.Ptr(armdatashare.RecurrenceIntervalDay),
			SynchronizationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t }()),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.SynchronizationSettingsClientCreateResponse{
	// 	                            SynchronizationSettingClassification: &armdatashare.ScheduledSynchronizationSetting{
	// 		Name: to.Ptr("SynchronizationSetting1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shares/synchronizationSettings"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/synchronizationSettings/SynchronizationSetting1"),
	// 		Kind: to.Ptr(armdatashare.SynchronizationSettingKindScheduleBased),
	// 		Properties: &armdatashare.ScheduledSynchronizationSettingProperties{
	// 			ProvisioningState: to.Ptr(armdatashare.ProvisioningStateSucceeded),
	// 			RecurrenceInterval: to.Ptr(armdatashare.RecurrenceIntervalDay),
	// 			SynchronizationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
	// 			UserName: to.Ptr("John Smith"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*SynchronizationSettingsClient) Get 

func (client *SynchronizationSettingsClient) Get(ctx context.Context, resourceGroupName string, accountName string, shareName string, synchronizationSettingName string, options *SynchronizationSettingsClientGetOptions) (SynchronizationSettingsClientGetResponse, error)

Get - Get a synchronizationSetting in a share If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • synchronizationSettingName - The name of the synchronizationSetting.
  • options - SynchronizationSettingsClientGetOptions contains the optional parameters for the SynchronizationSettingsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/SynchronizationSettings_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSynchronizationSettingsClient().Get(ctx, "SampleResourceGroup", "Account1", "Share1", "SynchronizationSetting1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.SynchronizationSettingsClientGetResponse{
	// 	                            SynchronizationSettingClassification: &armdatashare.ScheduledSynchronizationSetting{
	// 		Name: to.Ptr("SynchronizationSetting1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shares/synchronizationSettings"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/synchronizationSettings/SynchronizationSetting1"),
	// 		Kind: to.Ptr(armdatashare.SynchronizationSettingKindScheduleBased),
	// 		Properties: &armdatashare.ScheduledSynchronizationSettingProperties{
	// 			ProvisioningState: to.Ptr(armdatashare.ProvisioningStateSucceeded),
	// 			RecurrenceInterval: to.Ptr(armdatashare.RecurrenceIntervalDay),
	// 			SynchronizationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
	// 			UserName: to.Ptr("John Smith"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*SynchronizationSettingsClient) NewListBySharePager added in v0.4.0 

func (client *SynchronizationSettingsClient) NewListBySharePager(resourceGroupName string, accountName string, shareName string, options *SynchronizationSettingsClientListByShareOptions) *runtime.Pager[SynchronizationSettingsClientListByShareResponse]

NewListBySharePager - List synchronizationSettings in a share

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareName - The name of the share.
  • options - SynchronizationSettingsClientListByShareOptions contains the optional parameters for the SynchronizationSettingsClient.NewListBySharePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/SynchronizationSettings_ListByShare.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSynchronizationSettingsClient().NewListBySharePager("SampleResourceGroup", "Account1", "Share1", &armdatashare.SynchronizationSettingsClientListByShareOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SynchronizationSettingList = armdatashare.SynchronizationSettingList{
		// 	Value: []armdatashare.SynchronizationSettingClassification{
		// 		&armdatashare.ScheduledSynchronizationSetting{
		// 			Name: to.Ptr("SynchronizationSetting1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/shares/synchronizationSettings"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/synchronizationSettings/SynchronizationSetting1"),
		// 			Kind: to.Ptr(armdatashare.SynchronizationSettingKindScheduleBased),
		// 			Properties: &armdatashare.ScheduledSynchronizationSettingProperties{
		// 				RecurrenceInterval: to.Ptr(armdatashare.RecurrenceIntervalDay),
		// 				SynchronizationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 				UserName: to.Ptr("John Smith"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type SynchronizationSettingsClientBeginDeleteOptions added in v0.2.0 

type SynchronizationSettingsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SynchronizationSettingsClientBeginDeleteOptions contains the optional parameters for the SynchronizationSettingsClient.BeginDelete method.

type SynchronizationSettingsClientCreateOptions added in v0.2.0 

type SynchronizationSettingsClientCreateOptions struct {
}

SynchronizationSettingsClientCreateOptions contains the optional parameters for the SynchronizationSettingsClient.Create method.

type SynchronizationSettingsClientCreateResponse added in v0.2.0 

type SynchronizationSettingsClientCreateResponse struct {
	// A Synchronization Setting data transfer object.
	SynchronizationSettingClassification
}

SynchronizationSettingsClientCreateResponse contains the response from method SynchronizationSettingsClient.Create.

func (*SynchronizationSettingsClientCreateResponse) UnmarshalJSON added in v0.3.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SynchronizationSettingsClientCreateResponse.

type SynchronizationSettingsClientDeleteResponse added in v0.2.0 

type SynchronizationSettingsClientDeleteResponse struct {
	// Response for long running operation
	OperationResponse
}

SynchronizationSettingsClientDeleteResponse contains the response from method SynchronizationSettingsClient.BeginDelete.

type SynchronizationSettingsClientGetOptions added in v0.2.0 

type SynchronizationSettingsClientGetOptions struct {
}

SynchronizationSettingsClientGetOptions contains the optional parameters for the SynchronizationSettingsClient.Get method.

type SynchronizationSettingsClientGetResponse added in v0.2.0 

type SynchronizationSettingsClientGetResponse struct {
	// A Synchronization Setting data transfer object.
	SynchronizationSettingClassification
}

SynchronizationSettingsClientGetResponse contains the response from method SynchronizationSettingsClient.Get.

func (*SynchronizationSettingsClientGetResponse) UnmarshalJSON added in v0.3.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SynchronizationSettingsClientGetResponse.

type SynchronizationSettingsClientListByShareOptions added in v0.2.0 

type SynchronizationSettingsClientListByShareOptions struct {
	// continuation token
	SkipToken *string
}

SynchronizationSettingsClientListByShareOptions contains the optional parameters for the SynchronizationSettingsClient.NewListBySharePager method.

type SynchronizationSettingsClientListByShareResponse added in v0.2.0 

type SynchronizationSettingsClientListByShareResponse struct {
	// List response for get Synchronization settings
	SynchronizationSettingList
}

SynchronizationSettingsClientListByShareResponse contains the response from method SynchronizationSettingsClient.NewListBySharePager.

type Synchronize 

type Synchronize struct {
	// Mode of synchronization used in triggers and snapshot sync. Incremental by default
	SynchronizationMode *SynchronizationMode
}

Synchronize - Payload for the synchronizing the data.

func (Synchronize) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type Synchronize.

func (*Synchronize) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Synchronize.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The type of identity that last modified the resource.
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *LastModifiedByType
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type Trigger 

type Trigger struct {
	// REQUIRED; Kind of synchronization on trigger.
	Kind *TriggerKind

	// READ-ONLY; The resource id of the azure resource
	ID *string

	// READ-ONLY; Name of the azure resource
	Name *string

	// READ-ONLY; System Data of the Azure resource.
	SystemData *SystemData

	// READ-ONLY; Type of the azure resource
	Type *string
}

Trigger - A Trigger data transfer object.

func (*Trigger) GetTrigger 

func (t *Trigger) GetTrigger() *Trigger

GetTrigger implements the TriggerClassification interface for type Trigger.

func (Trigger) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type Trigger.

func (*Trigger) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Trigger.

type TriggerClassification 

type TriggerClassification interface {
	// GetTrigger returns the Trigger content of the underlying type.
	GetTrigger() *Trigger
}

TriggerClassification provides polymorphic access to related types. Call the interface's GetTrigger() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ScheduledTrigger, *Trigger

type TriggerKind 

type TriggerKind string

TriggerKind - Kind of synchronization on trigger. 

const (
	TriggerKindScheduleBased TriggerKind = "ScheduleBased"
)

func PossibleTriggerKindValues 

func PossibleTriggerKindValues() []TriggerKind

PossibleTriggerKindValues returns the possible values for the TriggerKind const type.

type TriggerList 

type TriggerList struct {
	// REQUIRED; Collection of items of type DataTransferObjects.
	Value []TriggerClassification

	// The Url of next result page.
	NextLink *string
}

TriggerList - List response for get triggers

func (TriggerList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TriggerList.

func (*TriggerList) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type TriggerList.

type TriggerStatus 

type TriggerStatus string

TriggerStatus - Gets the trigger state 

const (
	TriggerStatusActive                              TriggerStatus = "Active"
	TriggerStatusInactive                            TriggerStatus = "Inactive"
	TriggerStatusSourceSynchronizationSettingDeleted TriggerStatus = "SourceSynchronizationSettingDeleted"
)

func PossibleTriggerStatusValues 

func PossibleTriggerStatusValues() []TriggerStatus

PossibleTriggerStatusValues returns the possible values for the TriggerStatus const type.

type TriggersClient 

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

TriggersClient contains the methods for the Triggers group. Don't use this type directly, use NewTriggersClient() instead.

func NewTriggersClient 

func NewTriggersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*TriggersClient, error)

NewTriggersClient creates a new instance of TriggersClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*TriggersClient) BeginCreate 

func (client *TriggersClient) BeginCreate(ctx context.Context, resourceGroupName string, accountName string, shareSubscriptionName string, triggerName string, trigger TriggerClassification, options *TriggersClientBeginCreateOptions) (*runtime.Poller[TriggersClientCreateResponse], error)

BeginCreate - Create a Trigger If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the share subscription which will hold the data set sink.
  • triggerName - The name of the trigger.
  • trigger - Trigger details.
  • options - TriggersClientBeginCreateOptions contains the optional parameters for the TriggersClient.BeginCreate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Triggers_Create.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewTriggersClient().BeginCreate(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", "Trigger1", &armdatashare.ScheduledTrigger{
		Kind: to.Ptr(armdatashare.TriggerKindScheduleBased),
		Properties: &armdatashare.ScheduledTriggerProperties{
			RecurrenceInterval:  to.Ptr(armdatashare.RecurrenceIntervalDay),
			SynchronizationMode: to.Ptr(armdatashare.SynchronizationModeIncremental),
			SynchronizationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t }()),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.TriggersClientCreateResponse{
	// 	                            TriggerClassification: &armdatashare.ScheduledTrigger{
	// 		Name: to.Ptr("Trigger1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/triggers"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/triggers/Trigger1"),
	// 		Kind: to.Ptr(armdatashare.TriggerKindScheduleBased),
	// 		Properties: &armdatashare.ScheduledTriggerProperties{
	// 			ProvisioningState: to.Ptr(armdatashare.ProvisioningStateSucceeded),
	// 			RecurrenceInterval: to.Ptr(armdatashare.RecurrenceIntervalDay),
	// 			SynchronizationMode: to.Ptr(armdatashare.SynchronizationModeIncremental),
	// 			SynchronizationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
	// 			TriggerStatus: to.Ptr(armdatashare.TriggerStatusActive),
	// 			UserName: to.Ptr("John Smith"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*TriggersClient) BeginDelete 

func (client *TriggersClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, shareSubscriptionName string, triggerName string, options *TriggersClientBeginDeleteOptions) (*runtime.Poller[TriggersClientDeleteResponse], error)

BeginDelete - Delete a Trigger in a shareSubscription If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the shareSubscription.
  • triggerName - The name of the trigger.
  • options - TriggersClientBeginDeleteOptions contains the optional parameters for the TriggersClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Triggers_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewTriggersClient().BeginDelete(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", "Trigger1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OperationResponse = armdatashare.OperationResponse{
	// 	Status: to.Ptr(armdatashare.StatusSucceeded),
	// }
}

Output:

func (*TriggersClient) Get 

func (client *TriggersClient) Get(ctx context.Context, resourceGroupName string, accountName string, shareSubscriptionName string, triggerName string, options *TriggersClientGetOptions) (TriggersClientGetResponse, error)

Get - Get a Trigger in a shareSubscription If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the shareSubscription.
  • triggerName - The name of the trigger.
  • options - TriggersClientGetOptions contains the optional parameters for the TriggersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Triggers_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewTriggersClient().Get(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", "Trigger1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.TriggersClientGetResponse{
	// 	                            TriggerClassification: &armdatashare.ScheduledTrigger{
	// 		Name: to.Ptr("Trigger1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/triggers"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/triggers/Trigger1"),
	// 		Kind: to.Ptr(armdatashare.TriggerKindScheduleBased),
	// 		Properties: &armdatashare.ScheduledTriggerProperties{
	// 			ProvisioningState: to.Ptr(armdatashare.ProvisioningStateSucceeded),
	// 			RecurrenceInterval: to.Ptr(armdatashare.RecurrenceIntervalDay),
	// 			SynchronizationMode: to.Ptr(armdatashare.SynchronizationModeIncremental),
	// 			SynchronizationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
	// 			TriggerStatus: to.Ptr(armdatashare.TriggerStatusActive),
	// 			UserName: to.Ptr("John Smith"),
	// 		},
	// 	},
	// 	                        }
}

Output:

func (*TriggersClient) NewListByShareSubscriptionPager added in v0.4.0 

func (client *TriggersClient) NewListByShareSubscriptionPager(resourceGroupName string, accountName string, shareSubscriptionName string, options *TriggersClientListByShareSubscriptionOptions) *runtime.Pager[TriggersClientListByShareSubscriptionResponse]

NewListByShareSubscriptionPager - List Triggers in a share subscription

Generated from API version 2020-09-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the share account.
  • shareSubscriptionName - The name of the share subscription.
  • options - TriggersClientListByShareSubscriptionOptions contains the optional parameters for the TriggersClient.NewListByShareSubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/Triggers_ListByShareSubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewTriggersClient().NewListByShareSubscriptionPager("SampleResourceGroup", "Account1", "ShareSubscription1", &armdatashare.TriggersClientListByShareSubscriptionOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.TriggerList = armdatashare.TriggerList{
		// 	Value: []armdatashare.TriggerClassification{
		// 		&armdatashare.ScheduledTrigger{
		// 			Name: to.Ptr("Trigger1"),
		// 			Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/triggers"),
		// 			ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/triggers/Trigger1"),
		// 			Kind: to.Ptr(armdatashare.TriggerKindScheduleBased),
		// 			Properties: &armdatashare.ScheduledTriggerProperties{
		// 				ProvisioningState: to.Ptr(armdatashare.ProvisioningStateSucceeded),
		// 				RecurrenceInterval: to.Ptr(armdatashare.RecurrenceIntervalDay),
		// 				SynchronizationMode: to.Ptr(armdatashare.SynchronizationModeIncremental),
		// 				SynchronizationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-14T04:47:52.961Z"); return t}()),
		// 				UserName: to.Ptr("John Smith"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type TriggersClientBeginCreateOptions added in v0.2.0 

type TriggersClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TriggersClientBeginCreateOptions contains the optional parameters for the TriggersClient.BeginCreate method.

type TriggersClientBeginDeleteOptions added in v0.2.0 

type TriggersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TriggersClientBeginDeleteOptions contains the optional parameters for the TriggersClient.BeginDelete method.

type TriggersClientCreateResponse added in v0.2.0 

type TriggersClientCreateResponse struct {
	// A Trigger data transfer object.
	TriggerClassification
}

TriggersClientCreateResponse contains the response from method TriggersClient.BeginCreate.

func (TriggersClientCreateResponse) MarshalJSON added in v1.2.0 

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

MarshalJSON implements the json.Marshaller interface for type TriggersClientCreateResponse.

func (*TriggersClientCreateResponse) UnmarshalJSON added in v0.3.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type TriggersClientCreateResponse.

type TriggersClientDeleteResponse added in v0.2.0 

type TriggersClientDeleteResponse struct {
	// Response for long running operation
	OperationResponse
}

TriggersClientDeleteResponse contains the response from method TriggersClient.BeginDelete.

type TriggersClientGetOptions added in v0.2.0 

type TriggersClientGetOptions struct {
}

TriggersClientGetOptions contains the optional parameters for the TriggersClient.Get method.

type TriggersClientGetResponse added in v0.2.0 

type TriggersClientGetResponse struct {
	// A Trigger data transfer object.
	TriggerClassification
}

TriggersClientGetResponse contains the response from method TriggersClient.Get.

func (*TriggersClientGetResponse) UnmarshalJSON added in v0.3.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type TriggersClientGetResponse.

type TriggersClientListByShareSubscriptionOptions added in v0.2.0 

type TriggersClientListByShareSubscriptionOptions struct {
	// Continuation token
	SkipToken *string
}

TriggersClientListByShareSubscriptionOptions contains the optional parameters for the TriggersClient.NewListByShareSubscriptionPager method.

type TriggersClientListByShareSubscriptionResponse added in v0.2.0 

type TriggersClientListByShareSubscriptionResponse struct {
	// List response for get triggers
	TriggerList
}

TriggersClientListByShareSubscriptionResponse contains the response from method TriggersClient.NewListByShareSubscriptionPager.

type Type 

type Type string

Type - Identity Type 

const (
	TypeSystemAssigned Type = "SystemAssigned"
)

func PossibleTypeValues 

func PossibleTypeValues() []Type

PossibleTypeValues returns the possible values for the Type const type.

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.