datacollectionendpoints

package
v0.20240222.1164640 Latest Latest
Warning

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

Go to latest
Published: Feb 22, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

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

The datacollectionendpoints SDK allows for interaction with the Azure Resource Manager Service 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/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 PossibleValuesForKnownLocationSpecProvisioningStatus

func PossibleValuesForKnownLocationSpecProvisioningStatus() []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
	Model        *DataCollectionEndpointResource
}

type DataCollectionEndpoint

type DataCollectionEndpoint struct {
	ConfigurationAccess        *ConfigurationAccessEndpointSpec              `json:"configurationAccess,omitempty"`
	Description                *string                                       `json:"description,omitempty"`
	FailoverConfiguration      *FailoverConfigurationSpec                    `json:"failoverConfiguration,omitempty"`
	ImmutableId                *string                                       `json:"immutableId,omitempty"`
	LogsIngestion              *LogsIngestionEndpointSpec                    `json:"logsIngestion,omitempty"`
	Metadata                   *Metadata                                     `json:"metadata,omitempty"`
	MetricsIngestion           *MetricsIngestionEndpointSpec                 `json:"metricsIngestion,omitempty"`
	NetworkAcls                *NetworkRuleSet                               `json:"networkAcls,omitempty"`
	PrivateLinkScopedResources *[]PrivateLinkScopedResource                  `json:"privateLinkScopedResources,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

ID returns the formatted Data Collection Endpoint ID

func (DataCollectionEndpointId) Segments

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"`
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,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

type DataCollectionEndpointsClient

type DataCollectionEndpointsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewDataCollectionEndpointsClientWithBaseURI

func NewDataCollectionEndpointsClientWithBaseURI(endpoint string) DataCollectionEndpointsClient

func (DataCollectionEndpointsClient) Create

Create ...

func (DataCollectionEndpointsClient) Delete

Delete ...

func (DataCollectionEndpointsClient) Get

Get ...

func (DataCollectionEndpointsClient) ListByResourceGroup

ListByResourceGroup ...

func (DataCollectionEndpointsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all of the results into a single object

func (DataCollectionEndpointsClient) ListByResourceGroupCompleteMatchingPredicate

ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (DataCollectionEndpointsClient) ListBySubscription

ListBySubscription ...

func (DataCollectionEndpointsClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all of the results into a single object

func (DataCollectionEndpointsClient) ListBySubscriptionCompleteMatchingPredicate

ListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (DataCollectionEndpointsClient) Update

Update ...

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type FailoverConfigurationSpec

type FailoverConfigurationSpec struct {
	ActiveLocation *string         `json:"activeLocation,omitempty"`
	Locations      *[]LocationSpec `json:"locations,omitempty"`
}

type GetOperationResponse

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

type KnownDataCollectionEndpointProvisioningState

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

type KnownDataCollectionEndpointResourceKind

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

type KnownLocationSpecProvisioningStatus

type KnownLocationSpecProvisioningStatus string
const (
	KnownLocationSpecProvisioningStatusCanceled  KnownLocationSpecProvisioningStatus = "Canceled"
	KnownLocationSpecProvisioningStatusCreating  KnownLocationSpecProvisioningStatus = "Creating"
	KnownLocationSpecProvisioningStatusDeleting  KnownLocationSpecProvisioningStatus = "Deleting"
	KnownLocationSpecProvisioningStatusFailed    KnownLocationSpecProvisioningStatus = "Failed"
	KnownLocationSpecProvisioningStatusSucceeded KnownLocationSpecProvisioningStatus = "Succeeded"
	KnownLocationSpecProvisioningStatusUpdating  KnownLocationSpecProvisioningStatus = "Updating"
)

type KnownPublicNetworkAccessOptions

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

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []DataCollectionEndpointResource
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]DataCollectionEndpointResource
	// contains filtered or unexported fields
}

func (ListByResourceGroupOperationResponse) HasMore

func (ListByResourceGroupOperationResponse) LoadMore

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []DataCollectionEndpointResource
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]DataCollectionEndpointResource
	// contains filtered or unexported fields
}

func (ListBySubscriptionOperationResponse) HasMore

func (ListBySubscriptionOperationResponse) LoadMore

type LocationSpec

type LocationSpec struct {
	Location           *string                              `json:"location,omitempty"`
	ProvisioningStatus *KnownLocationSpecProvisioningStatus `json:"provisioningStatus,omitempty"`
}

type LogsIngestionEndpointSpec

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

type Metadata

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

type MetricsIngestionEndpointSpec

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

type NetworkRuleSet

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

type PrivateLinkScopedResource

type PrivateLinkScopedResource struct {
	ResourceId *string `json:"resourceId,omitempty"`
	ScopeId    *string `json:"scopeId,omitempty"`
}

type ResourceForUpdate

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

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL