...

Package datacatalog

import "github.com/Azure/azure-sdk-for-go/services/datacatalog/mgmt/2016-03-30/datacatalog"
Overview
Index
Subdirectories

Overview ▾

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datacatalog/armdatacatalog(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datacatalog/armdatacatalog). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package datacatalog implements the Azure ARM Datacatalog service API version 2016-03-30.

The Azure Data Catalog management API provides a RESTful set of web services that interact with Azure Data Catalog services.

Index ▾

Constants
func UserAgent() string
func Version() string
type ADCCatalog
    func (ac ADCCatalog) MarshalJSON() ([]byte, error)
    func (ac *ADCCatalog) UnmarshalJSON(body []byte) error
type ADCCatalogProperties
type ADCCatalogsClient
    func NewADCCatalogsClient(subscriptionID string, catalogName string) ADCCatalogsClient
    func NewADCCatalogsClientWithBaseURI(baseURI string, subscriptionID string, catalogName string) ADCCatalogsClient
    func (client ADCCatalogsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, properties ADCCatalog) (result ADCCatalog, err error)
    func (client ADCCatalogsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, properties ADCCatalog) (*http.Request, error)
    func (client ADCCatalogsClient) CreateOrUpdateResponder(resp *http.Response) (result ADCCatalog, err error)
    func (client ADCCatalogsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
    func (client ADCCatalogsClient) Delete(ctx context.Context, resourceGroupName string) (result ADCCatalogsDeleteFuture, err error)
    func (client ADCCatalogsClient) DeletePreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
    func (client ADCCatalogsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
    func (client ADCCatalogsClient) DeleteSender(req *http.Request) (future ADCCatalogsDeleteFuture, err error)
    func (client ADCCatalogsClient) Get(ctx context.Context, resourceGroupName string) (result ADCCatalog, err error)
    func (client ADCCatalogsClient) GetPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
    func (client ADCCatalogsClient) GetResponder(resp *http.Response) (result ADCCatalog, err error)
    func (client ADCCatalogsClient) GetSender(req *http.Request) (*http.Response, error)
    func (client ADCCatalogsClient) ListtByResourceGroup(ctx context.Context, resourceGroupName string) (result ADCCatalogsListResult, err error)
    func (client ADCCatalogsClient) ListtByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
    func (client ADCCatalogsClient) ListtByResourceGroupResponder(resp *http.Response) (result ADCCatalogsListResult, err error)
    func (client ADCCatalogsClient) ListtByResourceGroupSender(req *http.Request) (*http.Response, error)
    func (client ADCCatalogsClient) Update(ctx context.Context, resourceGroupName string, properties ADCCatalog) (result ADCCatalog, err error)
    func (client ADCCatalogsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, properties ADCCatalog) (*http.Request, error)
    func (client ADCCatalogsClient) UpdateResponder(resp *http.Response) (result ADCCatalog, err error)
    func (client ADCCatalogsClient) UpdateSender(req *http.Request) (*http.Response, error)
type ADCCatalogsDeleteFuture
    func (future *ADCCatalogsDeleteFuture) UnmarshalJSON(body []byte) error
type ADCCatalogsListResult
type ADCOperationsClient
    func NewADCOperationsClient(subscriptionID string, catalogName string) ADCOperationsClient
    func NewADCOperationsClientWithBaseURI(baseURI string, subscriptionID string, catalogName string) ADCOperationsClient
    func (client ADCOperationsClient) List(ctx context.Context) (result OperationEntityListResult, err error)
    func (client ADCOperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
    func (client ADCOperationsClient) ListResponder(resp *http.Response) (result OperationEntityListResult, err error)
    func (client ADCOperationsClient) ListSender(req *http.Request) (*http.Response, error)
type BaseClient
    func New(subscriptionID string, catalogName string) BaseClient
    func NewWithBaseURI(baseURI string, subscriptionID string, catalogName string) BaseClient
type OperationDisplayInfo
type OperationEntity
type OperationEntityListResult
type Principals
type Resource
    func (r Resource) MarshalJSON() ([]byte, error)
type SkuType
    func PossibleSkuTypeValues() []SkuType

Package files

adccatalogs.go adcoperations.go client.go enums.go models.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Datacatalog
    DefaultBaseURI = "https://management.azure.com"
)

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

type ADCCatalog

ADCCatalog azure Data Catalog.

type ADCCatalog struct {
    autorest.Response `json:"-"`
    // ADCCatalogProperties - Azure Data Catalog properties.
    *ADCCatalogProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; Resource Id
    ID *string `json:"id,omitempty"`
    // Name - READ-ONLY; Resource name
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; Resource type
    Type *string `json:"type,omitempty"`
    // Location - Resource location
    Location *string `json:"location,omitempty"`
    // Tags - Resource tags
    Tags map[string]*string `json:"tags"`
    // Etag - Resource etag
    Etag *string `json:"etag,omitempty"`
}

func (ADCCatalog) MarshalJSON

func (ac ADCCatalog) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ADCCatalog.

func (*ADCCatalog) UnmarshalJSON

func (ac *ADCCatalog) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ADCCatalog struct.

type ADCCatalogProperties

ADCCatalogProperties properties of the data catalog.

type ADCCatalogProperties struct {
    // Sku - Azure data catalog SKU. Possible values include: 'Free', 'Standard'
    Sku SkuType `json:"sku,omitempty"`
    // Units - Azure data catalog units.
    Units *int32 `json:"units,omitempty"`
    // Admins - Azure data catalog admin list.
    Admins *[]Principals `json:"admins,omitempty"`
    // Users - Azure data catalog user list.
    Users *[]Principals `json:"users,omitempty"`
    // SuccessfullyProvisioned - Azure data catalog provision status.
    SuccessfullyProvisioned *bool `json:"successfullyProvisioned,omitempty"`
    // EnableAutomaticUnitAdjustment - Automatic unit adjustment enabled or not.
    EnableAutomaticUnitAdjustment *bool `json:"enableAutomaticUnitAdjustment,omitempty"`
}

type ADCCatalogsClient

ADCCatalogsClient is the the Azure Data Catalog management API provides a RESTful set of web services that interact with Azure Data Catalog services.

type ADCCatalogsClient struct {
    BaseClient
}

func NewADCCatalogsClient

func NewADCCatalogsClient(subscriptionID string, catalogName string) ADCCatalogsClient

NewADCCatalogsClient creates an instance of the ADCCatalogsClient client.

func NewADCCatalogsClientWithBaseURI

func NewADCCatalogsClientWithBaseURI(baseURI string, subscriptionID string, catalogName string) ADCCatalogsClient

NewADCCatalogsClientWithBaseURI creates an instance of the ADCCatalogsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ADCCatalogsClient) CreateOrUpdate

func (client ADCCatalogsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, properties ADCCatalog) (result ADCCatalog, err error)

CreateOrUpdate the Create Azure Data Catalog service operation creates a new data catalog service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. properties - properties supplied to the Create or Update a data catalog.

func (ADCCatalogsClient) CreateOrUpdatePreparer

func (client ADCCatalogsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, properties ADCCatalog) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ADCCatalogsClient) CreateOrUpdateResponder

func (client ADCCatalogsClient) CreateOrUpdateResponder(resp *http.Response) (result ADCCatalog, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ADCCatalogsClient) CreateOrUpdateSender

func (client ADCCatalogsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (ADCCatalogsClient) Delete

func (client ADCCatalogsClient) Delete(ctx context.Context, resourceGroupName string) (result ADCCatalogsDeleteFuture, err error)

Delete the Delete Azure Data Catalog Service operation deletes an existing data catalog. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive.

func (ADCCatalogsClient) DeletePreparer

func (client ADCCatalogsClient) DeletePreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ADCCatalogsClient) DeleteResponder

func (client ADCCatalogsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ADCCatalogsClient) DeleteSender

func (client ADCCatalogsClient) DeleteSender(req *http.Request) (future ADCCatalogsDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ADCCatalogsClient) Get

func (client ADCCatalogsClient) Get(ctx context.Context, resourceGroupName string) (result ADCCatalog, err error)

Get the Get Azure Data Catalog Service operation retrieves a json representation of the data catalog. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive.

func (ADCCatalogsClient) GetPreparer

func (client ADCCatalogsClient) GetPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ADCCatalogsClient) GetResponder

func (client ADCCatalogsClient) GetResponder(resp *http.Response) (result ADCCatalog, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ADCCatalogsClient) GetSender

func (client ADCCatalogsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ADCCatalogsClient) ListtByResourceGroup

func (client ADCCatalogsClient) ListtByResourceGroup(ctx context.Context, resourceGroupName string) (result ADCCatalogsListResult, err error)

ListtByResourceGroup the List catalogs in Resource Group operation lists all the Azure Data Catalogs available under the given resource group. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive.

func (ADCCatalogsClient) ListtByResourceGroupPreparer

func (client ADCCatalogsClient) ListtByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListtByResourceGroupPreparer prepares the ListtByResourceGroup request.

func (ADCCatalogsClient) ListtByResourceGroupResponder

func (client ADCCatalogsClient) ListtByResourceGroupResponder(resp *http.Response) (result ADCCatalogsListResult, err error)

ListtByResourceGroupResponder handles the response to the ListtByResourceGroup request. The method always closes the http.Response Body.

func (ADCCatalogsClient) ListtByResourceGroupSender

func (client ADCCatalogsClient) ListtByResourceGroupSender(req *http.Request) (*http.Response, error)

ListtByResourceGroupSender sends the ListtByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (ADCCatalogsClient) Update

func (client ADCCatalogsClient) Update(ctx context.Context, resourceGroupName string, properties ADCCatalog) (result ADCCatalog, err error)

Update the Update Azure Data Catalog Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. properties - properties supplied to the Update a data catalog.

func (ADCCatalogsClient) UpdatePreparer

func (client ADCCatalogsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, properties ADCCatalog) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ADCCatalogsClient) UpdateResponder

func (client ADCCatalogsClient) UpdateResponder(resp *http.Response) (result ADCCatalog, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ADCCatalogsClient) UpdateSender

func (client ADCCatalogsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type ADCCatalogsDeleteFuture

ADCCatalogsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type ADCCatalogsDeleteFuture struct {
    azure.FutureAPI
    // Result returns the result of the asynchronous operation.
    // If the operation has not completed it will return an error.
    Result func(ADCCatalogsClient) (autorest.Response, error)
}

func (*ADCCatalogsDeleteFuture) UnmarshalJSON

func (future *ADCCatalogsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ADCCatalogsListResult

ADCCatalogsListResult the response from the List Azure Data Catalog operation.

type ADCCatalogsListResult struct {
    autorest.Response `json:"-"`
    // Value - the list of Azure Data Catalogs.
    Value *[]ADCCatalog `json:"value,omitempty"`
}

type ADCOperationsClient

ADCOperationsClient is the the Azure Data Catalog management API provides a RESTful set of web services that interact with Azure Data Catalog services.

type ADCOperationsClient struct {
    BaseClient
}

func NewADCOperationsClient

func NewADCOperationsClient(subscriptionID string, catalogName string) ADCOperationsClient

NewADCOperationsClient creates an instance of the ADCOperationsClient client.

func NewADCOperationsClientWithBaseURI

func NewADCOperationsClientWithBaseURI(baseURI string, subscriptionID string, catalogName string) ADCOperationsClient

NewADCOperationsClientWithBaseURI creates an instance of the ADCOperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ADCOperationsClient) List

func (client ADCOperationsClient) List(ctx context.Context) (result OperationEntityListResult, err error)

List lists all the available Azure Data Catalog service operations.

func (ADCOperationsClient) ListPreparer

func (client ADCOperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (ADCOperationsClient) ListResponder

func (client ADCOperationsClient) ListResponder(resp *http.Response) (result OperationEntityListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ADCOperationsClient) ListSender

func (client ADCOperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type BaseClient

BaseClient is the base client for Datacatalog.

type BaseClient struct {
    autorest.Client
    BaseURI        string
    SubscriptionID string
    CatalogName    string
}

func New

func New(subscriptionID string, catalogName string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string, catalogName string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type OperationDisplayInfo

OperationDisplayInfo the operation supported by Azure Data Catalog Service.

type OperationDisplayInfo struct {
    // Description - The description of the operation.
    Description *string `json:"description,omitempty"`
    // Operation - The action that users can perform, based on their permission level.
    Operation *string `json:"operation,omitempty"`
    // Provider - Service provider: Azure Data Catalog Service.
    Provider *string `json:"provider,omitempty"`
    // Resource - Resource on which the operation is performed.
    Resource *string `json:"resource,omitempty"`
}

type OperationEntity

OperationEntity the operation supported by Azure Data Catalog Service.

type OperationEntity struct {
    // Name - Operation name: {provider}/{resource}/{operation}.
    Name *string `json:"name,omitempty"`
    // Display - The operation supported by Azure Data Catalog Service.
    Display *OperationDisplayInfo `json:"display,omitempty"`
}

type OperationEntityListResult

OperationEntityListResult the list of Azure data catalog service operation response.

type OperationEntityListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of operations.
    Value *[]OperationEntity `json:"value,omitempty"`
}

type Principals

Principals user principals.

type Principals struct {
    // Upn - UPN of the user.
    Upn *string `json:"upn,omitempty"`
    // ObjectID - Object Id for the user
    ObjectID *string `json:"objectId,omitempty"`
}

type Resource

Resource the Resource model definition.

type Resource struct {
    // ID - READ-ONLY; Resource Id
    ID *string `json:"id,omitempty"`
    // Name - READ-ONLY; Resource name
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; Resource type
    Type *string `json:"type,omitempty"`
    // Location - Resource location
    Location *string `json:"location,omitempty"`
    // Tags - Resource tags
    Tags map[string]*string `json:"tags"`
    // Etag - Resource etag
    Etag *string `json:"etag,omitempty"`
}

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type SkuType

SkuType enumerates the values for sku type.

type SkuType string
const (
    // Free ...
    Free SkuType = "Free"
    // Standard ...
    Standard SkuType = "Standard"
)

func PossibleSkuTypeValues

func PossibleSkuTypeValues() []SkuType

PossibleSkuTypeValues returns an array of possible values for the SkuType const type.

Subdirectories

Name Synopsis
..
datacatalogapi Deprecated: Please note, this package has been deprecated.