azuretrafficcollectors

package
v0.20240923.1142107 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/networkfunction/2022-11-01/azuretrafficcollectors Documentation

The azuretrafficcollectors SDK allows for interaction with Azure Resource Manager networkfunction (API Version 2022-11-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/networkfunction/2022-11-01/azuretrafficcollectors"

Client Initialization

client := azuretrafficcollectors.NewAzureTrafficCollectorsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AzureTrafficCollectorsClient.ByResourceGroupList

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

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

Example Usage: AzureTrafficCollectorsClient.BySubscriptionList

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

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

Example Usage: AzureTrafficCollectorsClient.CreateOrUpdate

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

payload := azuretrafficcollectors.AzureTrafficCollector{
	// ...
}


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

Example Usage: AzureTrafficCollectorsClient.Delete

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

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

Example Usage: AzureTrafficCollectorsClient.Get

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

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: AzureTrafficCollectorsClient.UpdateTags

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

payload := azuretrafficcollectors.TagsObject{
	// ...
}


read, err := client.UpdateTags(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 PossibleValuesForCreatedByType 

func PossibleValuesForCreatedByType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateAzureTrafficCollectorID 

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

ValidateAzureTrafficCollectorID checks that 'input' can be parsed as a Azure Traffic Collector ID

Types

type AzureTrafficCollector 

type AzureTrafficCollector struct {
	Etag       *string                                `json:"etag,omitempty"`
	Id         *string                                `json:"id,omitempty"`
	Location   string                                 `json:"location"`
	Name       *string                                `json:"name,omitempty"`
	Properties *AzureTrafficCollectorPropertiesFormat `json:"properties,omitempty"`
	SystemData *SystemData                            `json:"systemData,omitempty"`
	Tags       *map[string]string                     `json:"tags,omitempty"`
	Type       *string                                `json:"type,omitempty"`
}

type AzureTrafficCollectorId 

type AzureTrafficCollectorId struct {
	SubscriptionId            string
	ResourceGroupName         string
	AzureTrafficCollectorName string
}

AzureTrafficCollectorId is a struct representing the Resource ID for a Azure Traffic Collector

func NewAzureTrafficCollectorID 

func NewAzureTrafficCollectorID(subscriptionId string, resourceGroupName string, azureTrafficCollectorName string) AzureTrafficCollectorId

NewAzureTrafficCollectorID returns a new AzureTrafficCollectorId struct

func ParseAzureTrafficCollectorID 

func ParseAzureTrafficCollectorID(input string) (*AzureTrafficCollectorId, error)

ParseAzureTrafficCollectorID parses 'input' into a AzureTrafficCollectorId

func ParseAzureTrafficCollectorIDInsensitively 

func ParseAzureTrafficCollectorIDInsensitively(input string) (*AzureTrafficCollectorId, error)

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

func (*AzureTrafficCollectorId) FromParseResult 

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

func (AzureTrafficCollectorId) ID 

func (id AzureTrafficCollectorId) ID() string

ID returns the formatted Azure Traffic Collector ID

func (AzureTrafficCollectorId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Azure Traffic Collector ID

func (AzureTrafficCollectorId) String 

func (id AzureTrafficCollectorId) String() string

String returns a human-readable description of this Azure Traffic Collector ID

type AzureTrafficCollectorOperationPredicate 

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

func (AzureTrafficCollectorOperationPredicate) Matches 

func (p AzureTrafficCollectorOperationPredicate) Matches(input AzureTrafficCollector) bool

type AzureTrafficCollectorPropertiesFormat 

type AzureTrafficCollectorPropertiesFormat struct {
	CollectorPolicies *[]ResourceReference `json:"collectorPolicies,omitempty"`
	ProvisioningState *ProvisioningState   `json:"provisioningState,omitempty"`
	VirtualHub        *ResourceReference   `json:"virtualHub,omitempty"`
}

type AzureTrafficCollectorsClient 

type AzureTrafficCollectorsClient struct {
	Client *resourcemanager.Client
}

func NewAzureTrafficCollectorsClientWithBaseURI 

func NewAzureTrafficCollectorsClientWithBaseURI(sdkApi sdkEnv.Api) (*AzureTrafficCollectorsClient, error)

func (AzureTrafficCollectorsClient) ByResourceGroupList 

func (c AzureTrafficCollectorsClient) ByResourceGroupList(ctx context.Context, id commonids.ResourceGroupId) (result ByResourceGroupListOperationResponse, err error)

ByResourceGroupList ...

func (AzureTrafficCollectorsClient) ByResourceGroupListComplete 

func (c AzureTrafficCollectorsClient) ByResourceGroupListComplete(ctx context.Context, id commonids.ResourceGroupId) (ByResourceGroupListCompleteResult, error)

ByResourceGroupListComplete retrieves all the results into a single object

func (AzureTrafficCollectorsClient) ByResourceGroupListCompleteMatchingPredicate 

func (c AzureTrafficCollectorsClient) ByResourceGroupListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate AzureTrafficCollectorOperationPredicate) (result ByResourceGroupListCompleteResult, err error)

ByResourceGroupListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AzureTrafficCollectorsClient) BySubscriptionList 

func (c AzureTrafficCollectorsClient) BySubscriptionList(ctx context.Context, id commonids.SubscriptionId) (result BySubscriptionListOperationResponse, err error)

BySubscriptionList ...

func (AzureTrafficCollectorsClient) BySubscriptionListComplete 

func (c AzureTrafficCollectorsClient) BySubscriptionListComplete(ctx context.Context, id commonids.SubscriptionId) (BySubscriptionListCompleteResult, error)

BySubscriptionListComplete retrieves all the results into a single object

func (AzureTrafficCollectorsClient) BySubscriptionListCompleteMatchingPredicate 

func (c AzureTrafficCollectorsClient) BySubscriptionListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate AzureTrafficCollectorOperationPredicate) (result BySubscriptionListCompleteResult, err error)

BySubscriptionListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AzureTrafficCollectorsClient) CreateOrUpdate 

func (c AzureTrafficCollectorsClient) CreateOrUpdate(ctx context.Context, id AzureTrafficCollectorId, input AzureTrafficCollector) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (AzureTrafficCollectorsClient) CreateOrUpdateThenPoll 

func (c AzureTrafficCollectorsClient) CreateOrUpdateThenPoll(ctx context.Context, id AzureTrafficCollectorId, input AzureTrafficCollector) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (AzureTrafficCollectorsClient) Delete 

func (c AzureTrafficCollectorsClient) Delete(ctx context.Context, id AzureTrafficCollectorId) (result DeleteOperationResponse, err error)

Delete ...

func (AzureTrafficCollectorsClient) DeleteThenPoll 

func (c AzureTrafficCollectorsClient) DeleteThenPoll(ctx context.Context, id AzureTrafficCollectorId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AzureTrafficCollectorsClient) Get 

func (c AzureTrafficCollectorsClient) Get(ctx context.Context, id AzureTrafficCollectorId) (result GetOperationResponse, err error)

Get ...

func (AzureTrafficCollectorsClient) UpdateTags 

func (c AzureTrafficCollectorsClient) UpdateTags(ctx context.Context, id AzureTrafficCollectorId, input TagsObject) (result UpdateTagsOperationResponse, err error)

UpdateTags ...

type ByResourceGroupListCompleteResult 

type ByResourceGroupListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AzureTrafficCollector
}

type ByResourceGroupListCustomPager added in v0.20240628.1153531 

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

type ByResourceGroupListOperationResponse 

type ByResourceGroupListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AzureTrafficCollector
}

type BySubscriptionListCompleteResult 

type BySubscriptionListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AzureTrafficCollector
}

type BySubscriptionListCustomPager added in v0.20240628.1153531 

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

type BySubscriptionListOperationResponse 

type BySubscriptionListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AzureTrafficCollector
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AzureTrafficCollector
}

type CreatedByType 

type CreatedByType string
const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func (*CreatedByType) UnmarshalJSON 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type ResourceReference 

type ResourceReference struct {
	Id *string `json:"id,omitempty"`
}

type SystemData 

type SystemData struct {
	CreatedAt          *string        `json:"createdAt,omitempty"`
	CreatedBy          *string        `json:"createdBy,omitempty"`
	CreatedByType      *CreatedByType `json:"createdByType,omitempty"`
	LastModifiedBy     *string        `json:"lastModifiedBy,omitempty"`
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

func (*SystemData) GetCreatedAtAsTime 

func (o *SystemData) GetCreatedAtAsTime() (*time.Time, error)

func (*SystemData) SetCreatedAtAsTime 

func (o *SystemData) SetCreatedAtAsTime(input time.Time)

type TagsObject 

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

type UpdateTagsOperationResponse 

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AzureTrafficCollector
}

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.