dataproducts

package
v0.20241126.2320 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 License: MPL-2.0 Imports: 17 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/networkanalytics/2023-11-15/dataproducts Documentation

The dataproducts SDK allows for interaction with Azure Resource Manager networkanalytics (API Version 2023-11-15).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/networkanalytics/2023-11-15/dataproducts"

Client Initialization

client := dataproducts.NewDataProductsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataProductsClient.AddUserRole

ctx := context.TODO()
id := dataproducts.NewDataProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName")

payload := dataproducts.RoleAssignmentCommonProperties{
	// ...
}


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

Example Usage: DataProductsClient.Create

ctx := context.TODO()
id := dataproducts.NewDataProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName")

payload := dataproducts.DataProduct{
	// ...
}


if err := client.CreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DataProductsClient.Delete

ctx := context.TODO()
id := dataproducts.NewDataProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: DataProductsClient.GenerateStorageAccountSasToken

ctx := context.TODO()
id := dataproducts.NewDataProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName")

payload := dataproducts.AccountSas{
	// ...
}


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

Example Usage: DataProductsClient.Get

ctx := context.TODO()
id := dataproducts.NewDataProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName")

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

Example Usage: DataProductsClient.ListByResourceGroup

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DataProductsClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ListBySubscription(ctx, id)` can be used to do batched pagination
items, err := client.ListBySubscriptionComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DataProductsClient.ListRolesAssignments

ctx := context.TODO()
id := dataproducts.NewDataProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName")
var payload interface{}

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

Example Usage: DataProductsClient.RemoveUserRole

ctx := context.TODO()
id := dataproducts.NewDataProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName")

payload := dataproducts.RoleAssignmentDetail{
	// ...
}


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

Example Usage: DataProductsClient.RotateKey

ctx := context.TODO()
id := dataproducts.NewDataProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName")

payload := dataproducts.KeyVaultInfo{
	// ...
}


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

Example Usage: DataProductsClient.Update

ctx := context.TODO()
id := dataproducts.NewDataProductID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataProductName")

payload := dataproducts.DataProductUpdate{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForControlState 

func PossibleValuesForControlState() []string

func PossibleValuesForDataProductUserRole 

func PossibleValuesForDataProductUserRole() []string

func PossibleValuesForDefaultAction 

func PossibleValuesForDefaultAction() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateDataProductID 

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

ValidateDataProductID checks that 'input' can be parsed as a Data Product ID

Types

type AccountSas 

type AccountSas struct {
	ExpiryTimeStamp string `json:"expiryTimeStamp"`
	IPAddress       string `json:"ipAddress"`
	StartTimeStamp  string `json:"startTimeStamp"`
}

func (*AccountSas) GetExpiryTimeStampAsTime 

func (o *AccountSas) GetExpiryTimeStampAsTime() (*time.Time, error)

func (*AccountSas) GetStartTimeStampAsTime 

func (o *AccountSas) GetStartTimeStampAsTime() (*time.Time, error)

func (*AccountSas) SetExpiryTimeStampAsTime 

func (o *AccountSas) SetExpiryTimeStampAsTime(input time.Time)

func (*AccountSas) SetStartTimeStampAsTime 

func (o *AccountSas) SetStartTimeStampAsTime(input time.Time)

type AccountSasToken 

type AccountSasToken struct {
	StorageAccountSasToken string `json:"storageAccountSasToken"`
}

type AddUserRoleOperationResponse 

type AddUserRoleOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RoleAssignmentDetail
}

type ConsumptionEndpointsProperties 

type ConsumptionEndpointsProperties struct {
	FileAccessResourceId *string `json:"fileAccessResourceId,omitempty"`
	FileAccessURL        *string `json:"fileAccessUrl,omitempty"`
	IngestionResourceId  *string `json:"ingestionResourceId,omitempty"`
	IngestionURL         *string `json:"ingestionUrl,omitempty"`
	QueryResourceId      *string `json:"queryResourceId,omitempty"`
	QueryURL             *string `json:"queryUrl,omitempty"`
}

type ControlState 

type ControlState string
const (
	ControlStateDisabled ControlState = "Disabled"
	ControlStateEnabled  ControlState = "Enabled"
)

func (*ControlState) UnmarshalJSON 

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

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataProduct
}

type DataProduct 

type DataProduct struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties *DataProductProperties             `json:"properties,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type DataProductId 

type DataProductId struct {
	SubscriptionId    string
	ResourceGroupName string
	DataProductName   string
}

DataProductId is a struct representing the Resource ID for a Data Product

func NewDataProductID 

func NewDataProductID(subscriptionId string, resourceGroupName string, dataProductName string) DataProductId

NewDataProductID returns a new DataProductId struct

func ParseDataProductID 

func ParseDataProductID(input string) (*DataProductId, error)

ParseDataProductID parses 'input' into a DataProductId

func ParseDataProductIDInsensitively 

func ParseDataProductIDInsensitively(input string) (*DataProductId, error)

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

func (*DataProductId) FromParseResult 

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

func (DataProductId) ID 

func (id DataProductId) ID() string

ID returns the formatted Data Product ID

func (DataProductId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Data Product ID

func (DataProductId) String 

func (id DataProductId) String() string

String returns a human-readable description of this Data Product ID

type DataProductNetworkAcls 

type DataProductNetworkAcls struct {
	AllowedQueryIPRangeList []string             `json:"allowedQueryIpRangeList"`
	DefaultAction           DefaultAction        `json:"defaultAction"`
	IPRules                 []IPRules            `json:"ipRules"`
	VirtualNetworkRule      []VirtualNetworkRule `json:"virtualNetworkRule"`
}

type DataProductOperationPredicate 

type DataProductOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (DataProductOperationPredicate) Matches 

func (p DataProductOperationPredicate) Matches(input DataProduct) bool

type DataProductProperties 

type DataProductProperties struct {
	AvailableMinorVersions              *[]string                          `json:"availableMinorVersions,omitempty"`
	ConsumptionEndpoints                *ConsumptionEndpointsProperties    `json:"consumptionEndpoints,omitempty"`
	CurrentMinorVersion                 *string                            `json:"currentMinorVersion,omitempty"`
	CustomerEncryptionKey               *EncryptionKeyDetails              `json:"customerEncryptionKey,omitempty"`
	CustomerManagedKeyEncryptionEnabled *ControlState                      `json:"customerManagedKeyEncryptionEnabled,omitempty"`
	Documentation                       *string                            `json:"documentation,omitempty"`
	KeyVaultURL                         *string                            `json:"keyVaultUrl,omitempty"`
	MajorVersion                        string                             `json:"majorVersion"`
	ManagedResourceGroupConfiguration   *ManagedResourceGroupConfiguration `json:"managedResourceGroupConfiguration,omitempty"`
	Networkacls                         *DataProductNetworkAcls            `json:"networkacls,omitempty"`
	Owners                              *[]string                          `json:"owners,omitempty"`
	PrivateLinksEnabled                 *ControlState                      `json:"privateLinksEnabled,omitempty"`
	Product                             string                             `json:"product"`
	ProvisioningState                   *ProvisioningState                 `json:"provisioningState,omitempty"`
	PublicNetworkAccess                 *ControlState                      `json:"publicNetworkAccess,omitempty"`
	Publisher                           string                             `json:"publisher"`
	PurviewAccount                      *string                            `json:"purviewAccount,omitempty"`
	PurviewCollection                   *string                            `json:"purviewCollection,omitempty"`
	Redundancy                          *ControlState                      `json:"redundancy,omitempty"`
	ResourceGuid                        *string                            `json:"resourceGuid,omitempty"`
}

type DataProductUpdate 

type DataProductUpdate struct {
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Properties *DataProductUpdateProperties       `json:"properties,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
}

type DataProductUpdateProperties 

type DataProductUpdateProperties struct {
	CurrentMinorVersion *string       `json:"currentMinorVersion,omitempty"`
	Owners              *[]string     `json:"owners,omitempty"`
	PrivateLinksEnabled *ControlState `json:"privateLinksEnabled,omitempty"`
	PurviewAccount      *string       `json:"purviewAccount,omitempty"`
	PurviewCollection   *string       `json:"purviewCollection,omitempty"`
}

type DataProductUserRole 

type DataProductUserRole string
const (
	DataProductUserRoleReader          DataProductUserRole = "Reader"
	DataProductUserRoleSensitiveReader DataProductUserRole = "SensitiveReader"
)

func (*DataProductUserRole) UnmarshalJSON 

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

type DataProductsClient 

type DataProductsClient struct {
	Client *resourcemanager.Client
}

func NewDataProductsClientWithBaseURI 

func NewDataProductsClientWithBaseURI(sdkApi sdkEnv.Api) (*DataProductsClient, error)

func (DataProductsClient) AddUserRole 

func (c DataProductsClient) AddUserRole(ctx context.Context, id DataProductId, input RoleAssignmentCommonProperties) (result AddUserRoleOperationResponse, err error)

AddUserRole ...

func (DataProductsClient) Create 

func (c DataProductsClient) Create(ctx context.Context, id DataProductId, input DataProduct) (result CreateOperationResponse, err error)

Create ...

func (DataProductsClient) CreateThenPoll 

func (c DataProductsClient) CreateThenPoll(ctx context.Context, id DataProductId, input DataProduct) error

CreateThenPoll performs Create then polls until it's completed

func (DataProductsClient) Delete 

func (c DataProductsClient) Delete(ctx context.Context, id DataProductId) (result DeleteOperationResponse, err error)

Delete ...

func (DataProductsClient) DeleteThenPoll 

func (c DataProductsClient) DeleteThenPoll(ctx context.Context, id DataProductId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DataProductsClient) GenerateStorageAccountSasToken 

func (c DataProductsClient) GenerateStorageAccountSasToken(ctx context.Context, id DataProductId, input AccountSas) (result GenerateStorageAccountSasTokenOperationResponse, err error)

GenerateStorageAccountSasToken ...

func (DataProductsClient) Get 

func (c DataProductsClient) Get(ctx context.Context, id DataProductId) (result GetOperationResponse, err error)

Get ...

func (DataProductsClient) ListByResourceGroup 

func (c DataProductsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (DataProductsClient) ListByResourceGroupComplete 

func (c DataProductsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (DataProductsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c DataProductsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate DataProductOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DataProductsClient) ListBySubscription 

func (c DataProductsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (DataProductsClient) ListBySubscriptionComplete 

func (c DataProductsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (DataProductsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c DataProductsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate DataProductOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DataProductsClient) ListRolesAssignments 

func (c DataProductsClient) ListRolesAssignments(ctx context.Context, id DataProductId, input interface{}) (result ListRolesAssignmentsOperationResponse, err error)

ListRolesAssignments ...

func (DataProductsClient) RemoveUserRole 

func (c DataProductsClient) RemoveUserRole(ctx context.Context, id DataProductId, input RoleAssignmentDetail) (result RemoveUserRoleOperationResponse, err error)

RemoveUserRole ...

func (DataProductsClient) RotateKey 

func (c DataProductsClient) RotateKey(ctx context.Context, id DataProductId, input KeyVaultInfo) (result RotateKeyOperationResponse, err error)

RotateKey ...

func (DataProductsClient) Update 

func (c DataProductsClient) Update(ctx context.Context, id DataProductId, input DataProductUpdate) (result UpdateOperationResponse, err error)

Update ...

func (DataProductsClient) UpdateThenPoll 

func (c DataProductsClient) UpdateThenPoll(ctx context.Context, id DataProductId, input DataProductUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type DefaultAction 

type DefaultAction string
const (
	DefaultActionAllow DefaultAction = "Allow"
	DefaultActionDeny  DefaultAction = "Deny"
)

func (*DefaultAction) UnmarshalJSON 

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

type DeleteOperationResponse 

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

type EncryptionKeyDetails 

type EncryptionKeyDetails struct {
	KeyName     string `json:"keyName"`
	KeyVaultUri string `json:"keyVaultUri"`
	KeyVersion  string `json:"keyVersion"`
}

type GenerateStorageAccountSasTokenOperationResponse 

type GenerateStorageAccountSasTokenOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccountSasToken
}

type GetOperationResponse 

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

type IPRules 

type IPRules struct {
	Action string  `json:"action"`
	Value  *string `json:"value,omitempty"`
}

type KeyVaultInfo 

type KeyVaultInfo struct {
	KeyVaultURL string `json:"keyVaultUrl"`
}

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DataProduct
}

type ListByResourceGroupCustomPager 

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

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataProduct
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DataProduct
}

type ListBySubscriptionCustomPager 

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

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataProduct
}

type ListRoleAssignments 

type ListRoleAssignments struct {
	Count                  int64                  `json:"count"`
	RoleAssignmentResponse []RoleAssignmentDetail `json:"roleAssignmentResponse"`
}

type ListRolesAssignmentsOperationResponse 

type ListRolesAssignmentsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ListRoleAssignments
}

type ManagedResourceGroupConfiguration 

type ManagedResourceGroupConfiguration struct {
	Location string `json:"location"`
	Name     string `json:"name"`
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type RemoveUserRoleOperationResponse 

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

type RoleAssignmentCommonProperties 

type RoleAssignmentCommonProperties struct {
	DataTypeScope []string            `json:"dataTypeScope"`
	PrincipalId   string              `json:"principalId"`
	PrincipalType string              `json:"principalType"`
	Role          DataProductUserRole `json:"role"`
	RoleId        string              `json:"roleId"`
	UserName      string              `json:"userName"`
}

type RoleAssignmentDetail 

type RoleAssignmentDetail struct {
	DataTypeScope    []string            `json:"dataTypeScope"`
	PrincipalId      string              `json:"principalId"`
	PrincipalType    string              `json:"principalType"`
	Role             DataProductUserRole `json:"role"`
	RoleAssignmentId string              `json:"roleAssignmentId"`
	RoleId           string              `json:"roleId"`
	UserName         string              `json:"userName"`
}

type RotateKeyOperationResponse 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataProduct
}

type VirtualNetworkRule 

type VirtualNetworkRule struct {
	Action *string `json:"action,omitempty"`
	Id     string  `json:"id"`
	State  *string `json:"state,omitempty"`
}

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.