datacollectionruleassociations

package
v0.20241209.1115630 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/insights/2022-06-01/datacollectionruleassociations Documentation

The datacollectionruleassociations SDK allows for interaction with Azure Resource Manager insights (API Version 2022-06-01).

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

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/insights/2022-06-01/datacollectionruleassociations"

Client Initialization

client := datacollectionruleassociations.NewDataCollectionRuleAssociationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataCollectionRuleAssociationsClient.Create

ctx := context.TODO()
id := datacollectionruleassociations.NewScopedDataCollectionRuleAssociationID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "dataCollectionRuleAssociationName")

payload := datacollectionruleassociations.DataCollectionRuleAssociationProxyOnlyResource{
	// ...
}


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

Example Usage: DataCollectionRuleAssociationsClient.Delete

ctx := context.TODO()
id := datacollectionruleassociations.NewScopedDataCollectionRuleAssociationID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "dataCollectionRuleAssociationName")

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

Example Usage: DataCollectionRuleAssociationsClient.Get

ctx := context.TODO()
id := datacollectionruleassociations.NewScopedDataCollectionRuleAssociationID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "dataCollectionRuleAssociationName")

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: DataCollectionRuleAssociationsClient.ListByDataCollectionEndpoint

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

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

Example Usage: DataCollectionRuleAssociationsClient.ListByResource

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: DataCollectionRuleAssociationsClient.ListByRule

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForKnownDataCollectionRuleAssociationProvisioningState 

func PossibleValuesForKnownDataCollectionRuleAssociationProvisioningState() []string

func ValidateDataCollectionEndpointID 

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

ValidateDataCollectionEndpointID checks that 'input' can be parsed as a Data Collection Endpoint ID

func ValidateDataCollectionRuleID 

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

ValidateDataCollectionRuleID checks that 'input' can be parsed as a Data Collection Rule ID

func ValidateScopedDataCollectionRuleAssociationID 

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

ValidateScopedDataCollectionRuleAssociationID checks that 'input' can be parsed as a Scoped Data Collection Rule Association ID

Types

type CreateOperationResponse 

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataCollectionRuleAssociationProxyOnlyResource
}

type DataCollectionEndpointId 

type DataCollectionEndpointId struct {
	SubscriptionId             string
	ResourceGroupName          string
	DataCollectionEndpointName string
}

DataCollectionEndpointId is a struct representing the Resource ID for a Data Collection Endpoint

func NewDataCollectionEndpointID 

func NewDataCollectionEndpointID(subscriptionId string, resourceGroupName string, dataCollectionEndpointName string) DataCollectionEndpointId

NewDataCollectionEndpointID returns a new DataCollectionEndpointId struct

func ParseDataCollectionEndpointID 

func ParseDataCollectionEndpointID(input string) (*DataCollectionEndpointId, error)

ParseDataCollectionEndpointID parses 'input' into a DataCollectionEndpointId

func ParseDataCollectionEndpointIDInsensitively 

func ParseDataCollectionEndpointIDInsensitively(input string) (*DataCollectionEndpointId, error)

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

func (*DataCollectionEndpointId) FromParseResult 

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

func (DataCollectionEndpointId) ID 

func (id DataCollectionEndpointId) ID() string

ID returns the formatted Data Collection Endpoint ID

func (DataCollectionEndpointId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Data Collection Endpoint ID

func (DataCollectionEndpointId) String 

func (id DataCollectionEndpointId) String() string

String returns a human-readable description of this Data Collection Endpoint ID

type DataCollectionRuleAssociation 

type DataCollectionRuleAssociation struct {
	DataCollectionEndpointId *string                                              `json:"dataCollectionEndpointId,omitempty"`
	DataCollectionRuleId     *string                                              `json:"dataCollectionRuleId,omitempty"`
	Description              *string                                              `json:"description,omitempty"`
	Metadata                 *Metadata                                            `json:"metadata,omitempty"`
	ProvisioningState        *KnownDataCollectionRuleAssociationProvisioningState `json:"provisioningState,omitempty"`
}

type DataCollectionRuleAssociationProxyOnlyResource 

type DataCollectionRuleAssociationProxyOnlyResource struct {
	Etag       *string                        `json:"etag,omitempty"`
	Id         *string                        `json:"id,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *DataCollectionRuleAssociation `json:"properties,omitempty"`
	SystemData *systemdata.SystemData         `json:"systemData,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type DataCollectionRuleAssociationProxyOnlyResourceOperationPredicate 

type DataCollectionRuleAssociationProxyOnlyResourceOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (DataCollectionRuleAssociationProxyOnlyResourceOperationPredicate) Matches 

func (p DataCollectionRuleAssociationProxyOnlyResourceOperationPredicate) Matches(input DataCollectionRuleAssociationProxyOnlyResource) bool

type DataCollectionRuleAssociationsClient 

type DataCollectionRuleAssociationsClient struct {
	Client *resourcemanager.Client
}

func NewDataCollectionRuleAssociationsClientWithBaseURI 

func NewDataCollectionRuleAssociationsClientWithBaseURI(sdkApi sdkEnv.Api) (*DataCollectionRuleAssociationsClient, error)

func (DataCollectionRuleAssociationsClient) Create 

func (c DataCollectionRuleAssociationsClient) Create(ctx context.Context, id ScopedDataCollectionRuleAssociationId, input DataCollectionRuleAssociationProxyOnlyResource) (result CreateOperationResponse, err error)

Create ...

func (DataCollectionRuleAssociationsClient) Delete 

func (c DataCollectionRuleAssociationsClient) Delete(ctx context.Context, id ScopedDataCollectionRuleAssociationId) (result DeleteOperationResponse, err error)

Delete ...

func (DataCollectionRuleAssociationsClient) Get 

func (c DataCollectionRuleAssociationsClient) Get(ctx context.Context, id ScopedDataCollectionRuleAssociationId) (result GetOperationResponse, err error)

Get ...

func (DataCollectionRuleAssociationsClient) ListByDataCollectionEndpoint 

func (c DataCollectionRuleAssociationsClient) ListByDataCollectionEndpoint(ctx context.Context, id DataCollectionEndpointId) (result ListByDataCollectionEndpointOperationResponse, err error)

ListByDataCollectionEndpoint ...

func (DataCollectionRuleAssociationsClient) ListByDataCollectionEndpointComplete 

func (c DataCollectionRuleAssociationsClient) ListByDataCollectionEndpointComplete(ctx context.Context, id DataCollectionEndpointId) (ListByDataCollectionEndpointCompleteResult, error)

ListByDataCollectionEndpointComplete retrieves all the results into a single object

func (DataCollectionRuleAssociationsClient) ListByDataCollectionEndpointCompleteMatchingPredicate 

func (c DataCollectionRuleAssociationsClient) ListByDataCollectionEndpointCompleteMatchingPredicate(ctx context.Context, id DataCollectionEndpointId, predicate DataCollectionRuleAssociationProxyOnlyResourceOperationPredicate) (result ListByDataCollectionEndpointCompleteResult, err error)

ListByDataCollectionEndpointCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DataCollectionRuleAssociationsClient) ListByResource 

func (c DataCollectionRuleAssociationsClient) ListByResource(ctx context.Context, id commonids.ScopeId) (result ListByResourceOperationResponse, err error)

ListByResource ...

func (DataCollectionRuleAssociationsClient) ListByResourceComplete 

func (c DataCollectionRuleAssociationsClient) ListByResourceComplete(ctx context.Context, id commonids.ScopeId) (ListByResourceCompleteResult, error)

ListByResourceComplete retrieves all the results into a single object

func (DataCollectionRuleAssociationsClient) ListByResourceCompleteMatchingPredicate 

func (c DataCollectionRuleAssociationsClient) ListByResourceCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, predicate DataCollectionRuleAssociationProxyOnlyResourceOperationPredicate) (result ListByResourceCompleteResult, err error)

ListByResourceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DataCollectionRuleAssociationsClient) ListByRule 

func (c DataCollectionRuleAssociationsClient) ListByRule(ctx context.Context, id DataCollectionRuleId) (result ListByRuleOperationResponse, err error)

ListByRule ...

func (DataCollectionRuleAssociationsClient) ListByRuleComplete 

func (c DataCollectionRuleAssociationsClient) ListByRuleComplete(ctx context.Context, id DataCollectionRuleId) (ListByRuleCompleteResult, error)

ListByRuleComplete retrieves all the results into a single object

func (DataCollectionRuleAssociationsClient) ListByRuleCompleteMatchingPredicate 

func (c DataCollectionRuleAssociationsClient) ListByRuleCompleteMatchingPredicate(ctx context.Context, id DataCollectionRuleId, predicate DataCollectionRuleAssociationProxyOnlyResourceOperationPredicate) (result ListByRuleCompleteResult, err error)

ListByRuleCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DataCollectionRuleId 

type DataCollectionRuleId struct {
	SubscriptionId         string
	ResourceGroupName      string
	DataCollectionRuleName string
}

DataCollectionRuleId is a struct representing the Resource ID for a Data Collection Rule

func NewDataCollectionRuleID 

func NewDataCollectionRuleID(subscriptionId string, resourceGroupName string, dataCollectionRuleName string) DataCollectionRuleId

NewDataCollectionRuleID returns a new DataCollectionRuleId struct

func ParseDataCollectionRuleID 

func ParseDataCollectionRuleID(input string) (*DataCollectionRuleId, error)

ParseDataCollectionRuleID parses 'input' into a DataCollectionRuleId

func ParseDataCollectionRuleIDInsensitively 

func ParseDataCollectionRuleIDInsensitively(input string) (*DataCollectionRuleId, error)

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

func (*DataCollectionRuleId) FromParseResult 

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

func (DataCollectionRuleId) ID 

func (id DataCollectionRuleId) ID() string

ID returns the formatted Data Collection Rule ID

func (DataCollectionRuleId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Data Collection Rule ID

func (DataCollectionRuleId) String 

func (id DataCollectionRuleId) String() string

String returns a human-readable description of this Data Collection Rule ID

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type KnownDataCollectionRuleAssociationProvisioningState 

type KnownDataCollectionRuleAssociationProvisioningState string
const (
	KnownDataCollectionRuleAssociationProvisioningStateCanceled  KnownDataCollectionRuleAssociationProvisioningState = "Canceled"
	KnownDataCollectionRuleAssociationProvisioningStateCreating  KnownDataCollectionRuleAssociationProvisioningState = "Creating"
	KnownDataCollectionRuleAssociationProvisioningStateDeleting  KnownDataCollectionRuleAssociationProvisioningState = "Deleting"
	KnownDataCollectionRuleAssociationProvisioningStateFailed    KnownDataCollectionRuleAssociationProvisioningState = "Failed"
	KnownDataCollectionRuleAssociationProvisioningStateSucceeded KnownDataCollectionRuleAssociationProvisioningState = "Succeeded"
	KnownDataCollectionRuleAssociationProvisioningStateUpdating  KnownDataCollectionRuleAssociationProvisioningState = "Updating"
)

func (*KnownDataCollectionRuleAssociationProvisioningState) UnmarshalJSON added in v0.20240229.1102109 

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

type ListByDataCollectionEndpointCompleteResult 

type ListByDataCollectionEndpointCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DataCollectionRuleAssociationProxyOnlyResource
}

type ListByDataCollectionEndpointCustomPager added in v0.20240628.1153531 

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

type ListByDataCollectionEndpointOperationResponse 

type ListByDataCollectionEndpointOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataCollectionRuleAssociationProxyOnlyResource
}

type ListByResourceCompleteResult 

type ListByResourceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DataCollectionRuleAssociationProxyOnlyResource
}

type ListByResourceCustomPager added in v0.20240628.1153531 

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

type ListByResourceOperationResponse 

type ListByResourceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataCollectionRuleAssociationProxyOnlyResource
}

type ListByRuleCompleteResult 

type ListByRuleCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DataCollectionRuleAssociationProxyOnlyResource
}

type ListByRuleCustomPager added in v0.20240628.1153531 

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

type ListByRuleOperationResponse 

type ListByRuleOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataCollectionRuleAssociationProxyOnlyResource
}

type Metadata 

type Metadata struct {
	ProvisionedBy           *string `json:"provisionedBy,omitempty"`
	ProvisionedByResourceId *string `json:"provisionedByResourceId,omitempty"`
}

type ScopedDataCollectionRuleAssociationId 

type ScopedDataCollectionRuleAssociationId struct {
	ResourceUri                       string
	DataCollectionRuleAssociationName string
}

ScopedDataCollectionRuleAssociationId is a struct representing the Resource ID for a Scoped Data Collection Rule Association

func NewScopedDataCollectionRuleAssociationID 

func NewScopedDataCollectionRuleAssociationID(resourceUri string, dataCollectionRuleAssociationName string) ScopedDataCollectionRuleAssociationId

NewScopedDataCollectionRuleAssociationID returns a new ScopedDataCollectionRuleAssociationId struct

func ParseScopedDataCollectionRuleAssociationID 

func ParseScopedDataCollectionRuleAssociationID(input string) (*ScopedDataCollectionRuleAssociationId, error)

ParseScopedDataCollectionRuleAssociationID parses 'input' into a ScopedDataCollectionRuleAssociationId

func ParseScopedDataCollectionRuleAssociationIDInsensitively 

func ParseScopedDataCollectionRuleAssociationIDInsensitively(input string) (*ScopedDataCollectionRuleAssociationId, error)

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

func (*ScopedDataCollectionRuleAssociationId) FromParseResult 

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

func (ScopedDataCollectionRuleAssociationId) ID 

func (id ScopedDataCollectionRuleAssociationId) ID() string

ID returns the formatted Scoped Data Collection Rule Association ID

func (ScopedDataCollectionRuleAssociationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Scoped Data Collection Rule Association ID

func (ScopedDataCollectionRuleAssociationId) String 

func (id ScopedDataCollectionRuleAssociationId) String() string

String returns a human-readable description of this Scoped Data Collection Rule Association ID

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.