azuretrafficcollectors

package
v0.20230222.1112900 Latest Latest
Warning

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

Go to latest
Published: Feb 22, 2023 License: MPL-2.0 Imports: 12 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 the Azure Resource Manager Service 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-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 := azuretrafficcollectors.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 := azuretrafficcollectors.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", "azureTrafficCollectorValue")

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", "azureTrafficCollectorValue")

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", "azureTrafficCollectorValue")

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", "azureTrafficCollectorValue")

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) ID

ID returns the formatted Azure Traffic Collector ID

func (AzureTrafficCollectorId) Segments

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

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 autorest.Client
	// contains filtered or unexported fields
}

func NewAzureTrafficCollectorsClientWithBaseURI

func NewAzureTrafficCollectorsClientWithBaseURI(endpoint string) AzureTrafficCollectorsClient

func (AzureTrafficCollectorsClient) ByResourceGroupList

ByResourceGroupList ...

func (AzureTrafficCollectorsClient) ByResourceGroupListComplete

ByResourceGroupListComplete retrieves all of the results into a single object

func (AzureTrafficCollectorsClient) ByResourceGroupListCompleteMatchingPredicate

ByResourceGroupListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (AzureTrafficCollectorsClient) BySubscriptionList

BySubscriptionList ...

func (AzureTrafficCollectorsClient) BySubscriptionListComplete

BySubscriptionListComplete retrieves all of the results into a single object

func (AzureTrafficCollectorsClient) BySubscriptionListCompleteMatchingPredicate

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

BySubscriptionListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (AzureTrafficCollectorsClient) CreateOrUpdate

CreateOrUpdate ...

func (AzureTrafficCollectorsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (AzureTrafficCollectorsClient) Delete

Delete ...

func (AzureTrafficCollectorsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (AzureTrafficCollectorsClient) Get

Get ...

func (AzureTrafficCollectorsClient) UpdateTags

UpdateTags ...

type ByResourceGroupListCompleteResult

type ByResourceGroupListCompleteResult struct {
	Items []AzureTrafficCollector
}

type ByResourceGroupListOperationResponse

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

func (ByResourceGroupListOperationResponse) HasMore

func (ByResourceGroupListOperationResponse) LoadMore

type BySubscriptionListCompleteResult

type BySubscriptionListCompleteResult struct {
	Items []AzureTrafficCollector
}

type BySubscriptionListOperationResponse

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

func (BySubscriptionListOperationResponse) HasMore

func (BySubscriptionListOperationResponse) LoadMore

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type CreatedByType

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

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type GetOperationResponse

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

type ProvisioningState

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

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
	Model        *AzureTrafficCollector
}

Jump to

Keyboard shortcuts

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