armdatacatalog

package module
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Dec 7, 2021 License: MIT Imports: 13 Imported by: 1

README

Azure Data Catalog Module for Go

PkgGoDev

The armdatacatalog module provides operations for working with Azure Data Catalog.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Data Catalog module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datacatalog/armdatacatalog

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Data Catalog. 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.

Clients

Azure Data Catalog modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armdatacatalog.(<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{
    Host: arm.AzureChina,
}
client := armdatacatalog.(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Data Catalog 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 ADCCatalog 

type ADCCatalog struct {
	Resource
	// Azure Data Catalog properties.
	Properties *ADCCatalogProperties `json:"properties,omitempty"`
}

ADCCatalog - Azure Data Catalog.

func (ADCCatalog) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ADCCatalog.

type ADCCatalogProperties 

type ADCCatalogProperties struct {
	// Azure data catalog admin list.
	Admins []*Principals `json:"admins,omitempty"`

	// Automatic unit adjustment enabled or not.
	EnableAutomaticUnitAdjustment *bool `json:"enableAutomaticUnitAdjustment,omitempty"`

	// Azure data catalog SKU.
	SKU *SKUType `json:"sku,omitempty"`

	// Azure data catalog provision status.
	SuccessfullyProvisioned *bool `json:"successfullyProvisioned,omitempty"`

	// Azure data catalog units.
	Units *int32 `json:"units,omitempty"`

	// Azure data catalog user list.
	Users []*Principals `json:"users,omitempty"`
}

ADCCatalogProperties - Properties of the data catalog.

func (ADCCatalogProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ADCCatalogProperties.

type ADCCatalogsBeginDeleteOptions 

type ADCCatalogsBeginDeleteOptions struct {
}

ADCCatalogsBeginDeleteOptions contains the optional parameters for the ADCCatalogs.BeginDelete method.

type ADCCatalogsClient 

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

ADCCatalogsClient contains the methods for the ADCCatalogs group. Don't use this type directly, use NewADCCatalogsClient() instead.

func NewADCCatalogsClient 

func NewADCCatalogsClient(subscriptionID string, catalogName string, credential azcore.TokenCredential, options *arm.ClientOptions) *ADCCatalogsClient

NewADCCatalogsClient creates a new instance of ADCCatalogsClient with the specified values.

func (*ADCCatalogsClient) BeginDelete 

func (client *ADCCatalogsClient) BeginDelete(ctx context.Context, resourceGroupName string, options *ADCCatalogsBeginDeleteOptions) (ADCCatalogsDeletePollerResponse, error)

BeginDelete - The Delete Azure Data Catalog Service operation deletes an existing data catalog. If the operation fails it returns a generic error.

Example

x-ms-original-file: specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/examples/DeleteADCCatalog.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datacatalog/armdatacatalog"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdatacatalog.NewADCCatalogsClient("<subscription-id>",
		"<catalog-name>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ADCCatalogsClient) CreateOrUpdate 

func (client *ADCCatalogsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, properties ADCCatalog, options *ADCCatalogsCreateOrUpdateOptions) (ADCCatalogsCreateOrUpdateResponse, 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. If the operation fails it returns a generic error.

Example

x-ms-original-file: specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/examples/CreateOrUpdateADCCatalog.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/datacatalog/armdatacatalog"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdatacatalog.NewADCCatalogsClient("<subscription-id>",
		"<catalog-name>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		armdatacatalog.ADCCatalog{
			Resource: armdatacatalog.Resource{
				Location: to.StringPtr("<location>"),
				Tags: map[string]*string{
					"mykey":  to.StringPtr("myvalue"),
					"mykey2": to.StringPtr("myvalue2"),
				},
			},
			Properties: &armdatacatalog.ADCCatalogProperties{
				Admins: []*armdatacatalog.Principals{
					{
						ObjectID: to.StringPtr("<object-id>"),
						Upn:      to.StringPtr("<upn>"),
					}},
				EnableAutomaticUnitAdjustment: to.BoolPtr(false),
				SKU:                           armdatacatalog.SKUTypeStandard.ToPtr(),
				Units:                         to.Int32Ptr(1),
				Users: []*armdatacatalog.Principals{
					{
						ObjectID: to.StringPtr("<object-id>"),
						Upn:      to.StringPtr("<upn>"),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("ADCCatalog.ID: %s\n", *res.ID)
}

Output:

func (*ADCCatalogsClient) Get 

func (client *ADCCatalogsClient) Get(ctx context.Context, resourceGroupName string, options *ADCCatalogsGetOptions) (ADCCatalogsGetResponse, error)

Get - The Get Azure Data Catalog Service operation retrieves a json representation of the data catalog. If the operation fails it returns a generic error.

Example

x-ms-original-file: specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/examples/GetADCCatalog.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datacatalog/armdatacatalog"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdatacatalog.NewADCCatalogsClient("<subscription-id>",
		"<catalog-name>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("ADCCatalog.ID: %s\n", *res.ID)
}

Output:

func (*ADCCatalogsClient) ListtByResourceGroup 

func (client *ADCCatalogsClient) ListtByResourceGroup(ctx context.Context, resourceGroupName string, options *ADCCatalogsListtByResourceGroupOptions) (ADCCatalogsListtByResourceGroupResponse, error)

ListtByResourceGroup - The List catalogs in Resource Group operation lists all the Azure Data Catalogs available under the given resource group. If the operation fails it returns a generic error.

Example

x-ms-original-file: specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/examples/ListADCCatalogsByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datacatalog/armdatacatalog"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdatacatalog.NewADCCatalogsClient("<subscription-id>",
		"<catalog-name>", cred, nil)
	_, err = client.ListtByResourceGroup(ctx,
		"<resource-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ADCCatalogsClient) Update 

func (client *ADCCatalogsClient) Update(ctx context.Context, resourceGroupName string, properties ADCCatalog, options *ADCCatalogsUpdateOptions) (ADCCatalogsUpdateResponse, 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. If the operation fails it returns a generic error.

Example

x-ms-original-file: specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/examples/UpdateADCCatalog.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/datacatalog/armdatacatalog"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdatacatalog.NewADCCatalogsClient("<subscription-id>",
		"<catalog-name>", cred, nil)
	res, err := client.Update(ctx,
		"<resource-group-name>",
		armdatacatalog.ADCCatalog{
			Resource: armdatacatalog.Resource{
				Location: to.StringPtr("<location>"),
				Tags: map[string]*string{
					"mykey":  to.StringPtr("myvalue"),
					"mykey2": to.StringPtr("myvalue2"),
				},
			},
			Properties: &armdatacatalog.ADCCatalogProperties{
				Admins: []*armdatacatalog.Principals{
					{
						ObjectID: to.StringPtr("<object-id>"),
						Upn:      to.StringPtr("<upn>"),
					}},
				EnableAutomaticUnitAdjustment: to.BoolPtr(false),
				SKU:                           armdatacatalog.SKUTypeStandard.ToPtr(),
				Units:                         to.Int32Ptr(1),
				Users: []*armdatacatalog.Principals{
					{
						ObjectID: to.StringPtr("<object-id>"),
						Upn:      to.StringPtr("<upn>"),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("ADCCatalog.ID: %s\n", *res.ID)
}

Output:

type ADCCatalogsCreateOrUpdateOptions 

type ADCCatalogsCreateOrUpdateOptions struct {
}

ADCCatalogsCreateOrUpdateOptions contains the optional parameters for the ADCCatalogs.CreateOrUpdate method.

type ADCCatalogsCreateOrUpdateResponse 

type ADCCatalogsCreateOrUpdateResponse struct {
	ADCCatalogsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ADCCatalogsCreateOrUpdateResponse contains the response from method ADCCatalogs.CreateOrUpdate.

type ADCCatalogsCreateOrUpdateResult 

type ADCCatalogsCreateOrUpdateResult struct {
	ADCCatalog
}

ADCCatalogsCreateOrUpdateResult contains the result from method ADCCatalogs.CreateOrUpdate.

type ADCCatalogsDeletePoller 

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

ADCCatalogsDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ADCCatalogsDeletePoller) Done 

func (p *ADCCatalogsDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ADCCatalogsDeletePoller) FinalResponse 

func (p *ADCCatalogsDeletePoller) FinalResponse(ctx context.Context) (ADCCatalogsDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ADCCatalogsDeleteResponse will be returned.

func (*ADCCatalogsDeletePoller) Poll 

func (p *ADCCatalogsDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ADCCatalogsDeletePoller) ResumeToken 

func (p *ADCCatalogsDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ADCCatalogsDeletePollerResponse 

type ADCCatalogsDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ADCCatalogsDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ADCCatalogsDeletePollerResponse contains the response from method ADCCatalogs.Delete.

func (ADCCatalogsDeletePollerResponse) PollUntilDone 

func (l ADCCatalogsDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ADCCatalogsDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ADCCatalogsDeletePollerResponse) Resume 

func (l *ADCCatalogsDeletePollerResponse) Resume(ctx context.Context, client *ADCCatalogsClient, token string) error

Resume rehydrates a ADCCatalogsDeletePollerResponse from the provided client and resume token.

type ADCCatalogsDeleteResponse 

type ADCCatalogsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ADCCatalogsDeleteResponse contains the response from method ADCCatalogs.Delete.

type ADCCatalogsGetOptions 

type ADCCatalogsGetOptions struct {
}

ADCCatalogsGetOptions contains the optional parameters for the ADCCatalogs.Get method.

type ADCCatalogsGetResponse 

type ADCCatalogsGetResponse struct {
	ADCCatalogsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ADCCatalogsGetResponse contains the response from method ADCCatalogs.Get.

type ADCCatalogsGetResult 

type ADCCatalogsGetResult struct {
	ADCCatalog
}

ADCCatalogsGetResult contains the result from method ADCCatalogs.Get.

type ADCCatalogsListResult 

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

ADCCatalogsListResult - The response from the List Azure Data Catalog operation.

func (ADCCatalogsListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ADCCatalogsListResult.

type ADCCatalogsListtByResourceGroupOptions 

type ADCCatalogsListtByResourceGroupOptions struct {
}

ADCCatalogsListtByResourceGroupOptions contains the optional parameters for the ADCCatalogs.ListtByResourceGroup method.

type ADCCatalogsListtByResourceGroupResponse 

type ADCCatalogsListtByResourceGroupResponse struct {
	ADCCatalogsListtByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ADCCatalogsListtByResourceGroupResponse contains the response from method ADCCatalogs.ListtByResourceGroup.

type ADCCatalogsListtByResourceGroupResult 

type ADCCatalogsListtByResourceGroupResult struct {
	ADCCatalogsListResult
}

ADCCatalogsListtByResourceGroupResult contains the result from method ADCCatalogs.ListtByResourceGroup.

type ADCCatalogsUpdateOptions 

type ADCCatalogsUpdateOptions struct {
}

ADCCatalogsUpdateOptions contains the optional parameters for the ADCCatalogs.Update method.

type ADCCatalogsUpdateResponse 

type ADCCatalogsUpdateResponse struct {
	ADCCatalogsUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ADCCatalogsUpdateResponse contains the response from method ADCCatalogs.Update.

type ADCCatalogsUpdateResult 

type ADCCatalogsUpdateResult struct {
	ADCCatalog
}

ADCCatalogsUpdateResult contains the result from method ADCCatalogs.Update.

type ADCOperationsClient 

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

ADCOperationsClient contains the methods for the ADCOperations group. Don't use this type directly, use NewADCOperationsClient() instead.

func NewADCOperationsClient 

func NewADCOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *ADCOperationsClient

NewADCOperationsClient creates a new instance of ADCOperationsClient with the specified values.

func (*ADCOperationsClient) List 

func (client *ADCOperationsClient) List(ctx context.Context, options *ADCOperationsListOptions) (ADCOperationsListResponse, error)

List - Lists all the available Azure Data Catalog service operations. If the operation fails it returns a generic error.

Example

x-ms-original-file: specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/examples/GetOperations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datacatalog/armdatacatalog"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armdatacatalog.NewADCOperationsClient(cred, nil)
	_, err = client.List(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type ADCOperationsListOptions 

type ADCOperationsListOptions struct {
}

ADCOperationsListOptions contains the optional parameters for the ADCOperations.List method.

type ADCOperationsListResponse 

type ADCOperationsListResponse struct {
	ADCOperationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ADCOperationsListResponse contains the response from method ADCOperations.List.

type ADCOperationsListResult 

type ADCOperationsListResult struct {
	OperationEntityListResult
}

ADCOperationsListResult contains the result from method ADCOperations.List.

type OperationDisplayInfo 

type OperationDisplayInfo struct {
	// The description of the operation.
	Description *string `json:"description,omitempty"`

	// The action that users can perform, based on their permission level.
	Operation *string `json:"operation,omitempty"`

	// Service provider: Azure Data Catalog Service.
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplayInfo - The operation supported by Azure Data Catalog Service.

type OperationEntity 

type OperationEntity struct {
	// The operation supported by Azure Data Catalog Service.
	Display *OperationDisplayInfo `json:"display,omitempty"`

	// Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`
}

OperationEntity - The operation supported by Azure Data Catalog Service.

type OperationEntityListResult 

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

OperationEntityListResult - The list of Azure data catalog service operation response.

func (OperationEntityListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationEntityListResult.

type Principals 

type Principals struct {
	// Object Id for the user
	ObjectID *string `json:"objectId,omitempty"`

	// UPN of the user.
	Upn *string `json:"upn,omitempty"`
}

Principals - User principals.

type Resource 

type Resource struct {
	// Resource etag
	Etag *string `json:"etag,omitempty"`

	// Resource location
	Location *string `json:"location,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - The Resource model definition.

func (Resource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Resource.

type SKUType 

type SKUType string

SKUType - Azure data catalog SKU. 

const (
	SKUTypeFree     SKUType = "Free"
	SKUTypeStandard SKUType = "Standard"
)

func PossibleSKUTypeValues 

func PossibleSKUTypeValues() []SKUType

PossibleSKUTypeValues returns the possible values for the SKUType const type.

func (SKUType) ToPtr 

func (c SKUType) ToPtr() *SKUType

ToPtr returns a *SKUType pointing to the current value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.