datacollectionendpoints

package
v0.20240412.1150433 Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/insights/2021-04-01/datacollectionendpoints Documentation

The datacollectionendpoints SDK allows for interaction with the Azure Resource Manager Service insights (API Version 2021-04-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/2021-04-01/datacollectionendpoints"

Client Initialization

client := datacollectionendpoints.NewDataCollectionEndpointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataCollectionEndpointsClient.Create

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

payload := datacollectionendpoints.DataCollectionEndpointResource{
	// ...
}


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: DataCollectionEndpointsClient.Delete

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

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: DataCollectionEndpointsClient.Get

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

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: DataCollectionEndpointsClient.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: DataCollectionEndpointsClient.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: DataCollectionEndpointsClient.Update

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

payload := datacollectionendpoints.ResourceForUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForKnownDataCollectionEndpointProvisioningState 

func PossibleValuesForKnownDataCollectionEndpointProvisioningState() []string

func PossibleValuesForKnownDataCollectionEndpointResourceKind 

func PossibleValuesForKnownDataCollectionEndpointResourceKind() []string

func PossibleValuesForKnownPublicNetworkAccessOptions 

func PossibleValuesForKnownPublicNetworkAccessOptions() []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

Types

type ConfigurationAccessEndpointSpec 

type ConfigurationAccessEndpointSpec struct {
	Endpoint *string `json:"endpoint,omitempty"`
}

type CreateOperationResponse 

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

type DataCollectionEndpoint 

type DataCollectionEndpoint struct {
	ConfigurationAccess *ConfigurationAccessEndpointSpec              `json:"configurationAccess,omitempty"`
	Description         *string                                       `json:"description,omitempty"`
	ImmutableId         *string                                       `json:"immutableId,omitempty"`
	LogsIngestion       *LogsIngestionEndpointSpec                    `json:"logsIngestion,omitempty"`
	NetworkAcls         *NetworkRuleSet                               `json:"networkAcls,omitempty"`
	ProvisioningState   *KnownDataCollectionEndpointProvisioningState `json:"provisioningState,omitempty"`
}

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 DataCollectionEndpointResource 

type DataCollectionEndpointResource struct {
	Etag       *string                                  `json:"etag,omitempty"`
	Id         *string                                  `json:"id,omitempty"`
	Kind       *KnownDataCollectionEndpointResourceKind `json:"kind,omitempty"`
	Location   string                                   `json:"location"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *DataCollectionEndpoint                  `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                   `json:"systemData,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type DataCollectionEndpointResourceOperationPredicate 

type DataCollectionEndpointResourceOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (DataCollectionEndpointResourceOperationPredicate) Matches 

func (p DataCollectionEndpointResourceOperationPredicate) Matches(input DataCollectionEndpointResource) bool

type DataCollectionEndpointsClient 

type DataCollectionEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewDataCollectionEndpointsClientWithBaseURI 

func NewDataCollectionEndpointsClientWithBaseURI(sdkApi sdkEnv.Api) (*DataCollectionEndpointsClient, error)

func (DataCollectionEndpointsClient) Create 

func (c DataCollectionEndpointsClient) Create(ctx context.Context, id DataCollectionEndpointId, input DataCollectionEndpointResource) (result CreateOperationResponse, err error)

Create ...

func (DataCollectionEndpointsClient) Delete 

func (c DataCollectionEndpointsClient) Delete(ctx context.Context, id DataCollectionEndpointId) (result DeleteOperationResponse, err error)

Delete ...

func (DataCollectionEndpointsClient) Get 

func (c DataCollectionEndpointsClient) Get(ctx context.Context, id DataCollectionEndpointId) (result GetOperationResponse, err error)

Get ...

func (DataCollectionEndpointsClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (DataCollectionEndpointsClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (DataCollectionEndpointsClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DataCollectionEndpointsClient) ListBySubscription 

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

ListBySubscription ...

func (DataCollectionEndpointsClient) ListBySubscriptionComplete 

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

ListBySubscriptionComplete retrieves all the results into a single object

func (DataCollectionEndpointsClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DataCollectionEndpointsClient) Update 

func (c DataCollectionEndpointsClient) Update(ctx context.Context, id DataCollectionEndpointId, input ResourceForUpdate) (result UpdateOperationResponse, err error)

Update ...

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type KnownDataCollectionEndpointProvisioningState 

type KnownDataCollectionEndpointProvisioningState string
const (
	KnownDataCollectionEndpointProvisioningStateCreating  KnownDataCollectionEndpointProvisioningState = "Creating"
	KnownDataCollectionEndpointProvisioningStateDeleting  KnownDataCollectionEndpointProvisioningState = "Deleting"
	KnownDataCollectionEndpointProvisioningStateFailed    KnownDataCollectionEndpointProvisioningState = "Failed"
	KnownDataCollectionEndpointProvisioningStateSucceeded KnownDataCollectionEndpointProvisioningState = "Succeeded"
	KnownDataCollectionEndpointProvisioningStateUpdating  KnownDataCollectionEndpointProvisioningState = "Updating"
)

func (*KnownDataCollectionEndpointProvisioningState) UnmarshalJSON added in v0.20240229.1102109 

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

type KnownDataCollectionEndpointResourceKind 

type KnownDataCollectionEndpointResourceKind string
const (
	KnownDataCollectionEndpointResourceKindLinux   KnownDataCollectionEndpointResourceKind = "Linux"
	KnownDataCollectionEndpointResourceKindWindows KnownDataCollectionEndpointResourceKind = "Windows"
)

func (*KnownDataCollectionEndpointResourceKind) UnmarshalJSON added in v0.20240229.1102109 

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

type KnownPublicNetworkAccessOptions 

type KnownPublicNetworkAccessOptions string
const (
	KnownPublicNetworkAccessOptionsDisabled KnownPublicNetworkAccessOptions = "Disabled"
	KnownPublicNetworkAccessOptionsEnabled  KnownPublicNetworkAccessOptions = "Enabled"
)

func (*KnownPublicNetworkAccessOptions) UnmarshalJSON added in v0.20240229.1102109 

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

type ListByResourceGroupCompleteResult 

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

type ListByResourceGroupOperationResponse 

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

type ListBySubscriptionCompleteResult 

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

type ListBySubscriptionOperationResponse 

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

type LogsIngestionEndpointSpec 

type LogsIngestionEndpointSpec struct {
	Endpoint *string `json:"endpoint,omitempty"`
}

type NetworkRuleSet 

type NetworkRuleSet struct {
	PublicNetworkAccess *KnownPublicNetworkAccessOptions `json:"publicNetworkAccess,omitempty"`
}

type ResourceForUpdate 

type ResourceForUpdate struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataCollectionEndpointResource
}

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.