componentsapis

package
v0.20240320.1143605 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/applicationinsights/2020-02-02/componentsapis Documentation

The componentsapis SDK allows for interaction with the Azure Resource Manager Service applicationinsights (API Version 2020-02-02).

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/applicationinsights/2020-02-02/componentsapis"

Client Initialization

client := componentsapis.NewComponentsAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ComponentsAPIsClient.ComponentsCreateOrUpdate

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

payload := componentsapis.ApplicationInsightsComponent{
	// ...
}


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

Example Usage: ComponentsAPIsClient.ComponentsDelete

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

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

Example Usage: ComponentsAPIsClient.ComponentsGet

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

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

Example Usage: ComponentsAPIsClient.ComponentsGetPurgeStatus

ctx := context.TODO()
id := componentsapis.NewOperationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "componentValue", "purgeIdValue")

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

Example Usage: ComponentsAPIsClient.ComponentsList

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

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

Example Usage: ComponentsAPIsClient.ComponentsListByResourceGroup

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

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

Example Usage: ComponentsAPIsClient.ComponentsPurge

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

payload := componentsapis.ComponentPurgeBody{
	// ...
}


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

Example Usage: ComponentsAPIsClient.ComponentsUpdateTags

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

payload := componentsapis.TagsResource{
	// ...
}


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

func PossibleValuesForApplicationType() []string

func PossibleValuesForFlowType 

func PossibleValuesForFlowType() []string

func PossibleValuesForIngestionMode 

func PossibleValuesForIngestionMode() []string

func PossibleValuesForPublicNetworkAccessType 

func PossibleValuesForPublicNetworkAccessType() []string

func PossibleValuesForPurgeState 

func PossibleValuesForPurgeState() []string

func PossibleValuesForRequestSource 

func PossibleValuesForRequestSource() []string

func ValidateComponentID 

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

ValidateComponentID checks that 'input' can be parsed as a Component ID

func ValidateOperationID 

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

ValidateOperationID checks that 'input' can be parsed as a Operation ID

Types

type ApplicationInsightsComponent 

type ApplicationInsightsComponent struct {
	Etag       *string                                 `json:"etag,omitempty"`
	Id         *string                                 `json:"id,omitempty"`
	Kind       string                                  `json:"kind"`
	Location   string                                  `json:"location"`
	Name       *string                                 `json:"name,omitempty"`
	Properties *ApplicationInsightsComponentProperties `json:"properties,omitempty"`
	Tags       *map[string]string                      `json:"tags,omitempty"`
	Type       *string                                 `json:"type,omitempty"`
}

type ApplicationInsightsComponentOperationPredicate 

type ApplicationInsightsComponentOperationPredicate struct {
	Etag     *string
	Id       *string
	Kind     *string
	Location *string
	Name     *string
	Type     *string
}

func (ApplicationInsightsComponentOperationPredicate) Matches 

func (p ApplicationInsightsComponentOperationPredicate) Matches(input ApplicationInsightsComponent) bool

type ApplicationInsightsComponentProperties 

type ApplicationInsightsComponentProperties struct {
	AppId                           *string                      `json:"AppId,omitempty"`
	ApplicationId                   *string                      `json:"ApplicationId,omitempty"`
	ApplicationType                 ApplicationType              `json:"Application_Type"`
	ConnectionString                *string                      `json:"ConnectionString,omitempty"`
	CreationDate                    *string                      `json:"CreationDate,omitempty"`
	DisableIPMasking                *bool                        `json:"DisableIpMasking,omitempty"`
	DisableLocalAuth                *bool                        `json:"DisableLocalAuth,omitempty"`
	FlowType                        *FlowType                    `json:"Flow_Type,omitempty"`
	ForceCustomerStorageForProfiler *bool                        `json:"ForceCustomerStorageForProfiler,omitempty"`
	HockeyAppId                     *string                      `json:"HockeyAppId,omitempty"`
	HockeyAppToken                  *string                      `json:"HockeyAppToken,omitempty"`
	ImmediatePurgeDataOn30Days      *bool                        `json:"ImmediatePurgeDataOn30Days,omitempty"`
	IngestionMode                   *IngestionMode               `json:"IngestionMode,omitempty"`
	InstrumentationKey              *string                      `json:"InstrumentationKey,omitempty"`
	LaMigrationDate                 *string                      `json:"LaMigrationDate,omitempty"`
	Name                            *string                      `json:"Name,omitempty"`
	PrivateLinkScopedResources      *[]PrivateLinkScopedResource `json:"PrivateLinkScopedResources,omitempty"`
	ProvisioningState               *string                      `json:"provisioningState,omitempty"`
	PublicNetworkAccessForIngestion *PublicNetworkAccessType     `json:"publicNetworkAccessForIngestion,omitempty"`
	PublicNetworkAccessForQuery     *PublicNetworkAccessType     `json:"publicNetworkAccessForQuery,omitempty"`
	RequestSource                   *RequestSource               `json:"Request_Source,omitempty"`
	RetentionInDays                 *int64                       `json:"RetentionInDays,omitempty"`
	SamplingPercentage              *float64                     `json:"SamplingPercentage,omitempty"`
	TenantId                        *string                      `json:"TenantId,omitempty"`
	WorkspaceResourceId             *string                      `json:"WorkspaceResourceId,omitempty"`
}

func (*ApplicationInsightsComponentProperties) GetCreationDateAsTime 

func (o *ApplicationInsightsComponentProperties) GetCreationDateAsTime() (*time.Time, error)

func (*ApplicationInsightsComponentProperties) GetLaMigrationDateAsTime 

func (o *ApplicationInsightsComponentProperties) GetLaMigrationDateAsTime() (*time.Time, error)

func (*ApplicationInsightsComponentProperties) SetCreationDateAsTime 

func (o *ApplicationInsightsComponentProperties) SetCreationDateAsTime(input time.Time)

func (*ApplicationInsightsComponentProperties) SetLaMigrationDateAsTime 

func (o *ApplicationInsightsComponentProperties) SetLaMigrationDateAsTime(input time.Time)

type ApplicationType 

type ApplicationType string
const (
	ApplicationTypeOther ApplicationType = "other"
	ApplicationTypeWeb   ApplicationType = "web"
)

func (*ApplicationType) UnmarshalJSON 

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

type ComponentId 

type ComponentId struct {
	SubscriptionId    string
	ResourceGroupName string
	ComponentName     string
}

ComponentId is a struct representing the Resource ID for a Component

func NewComponentID 

func NewComponentID(subscriptionId string, resourceGroupName string, componentName string) ComponentId

NewComponentID returns a new ComponentId struct

func ParseComponentID 

func ParseComponentID(input string) (*ComponentId, error)

ParseComponentID parses 'input' into a ComponentId

func ParseComponentIDInsensitively 

func ParseComponentIDInsensitively(input string) (*ComponentId, error)

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

func (*ComponentId) FromParseResult 

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

func (ComponentId) ID 

func (id ComponentId) ID() string

ID returns the formatted Component ID

func (ComponentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Component ID

func (ComponentId) String 

func (id ComponentId) String() string

String returns a human-readable description of this Component ID

type ComponentPurgeBody 

type ComponentPurgeBody struct {
	Filters []ComponentPurgeBodyFilters `json:"filters"`
	Table   string                      `json:"table"`
}

type ComponentPurgeBodyFilters 

type ComponentPurgeBodyFilters struct {
	Column   *string      `json:"column,omitempty"`
	Key      *string      `json:"key,omitempty"`
	Operator *string      `json:"operator,omitempty"`
	Value    *interface{} `json:"value,omitempty"`
}

type ComponentPurgeResponse 

type ComponentPurgeResponse struct {
	OperationId string `json:"operationId"`
}

type ComponentPurgeStatusResponse 

type ComponentPurgeStatusResponse struct {
	Status PurgeState `json:"status"`
}

type ComponentsAPIsClient 

type ComponentsAPIsClient struct {
	Client *resourcemanager.Client
}

func NewComponentsAPIsClientWithBaseURI 

func NewComponentsAPIsClientWithBaseURI(sdkApi sdkEnv.Api) (*ComponentsAPIsClient, error)

func (ComponentsAPIsClient) ComponentsCreateOrUpdate 

func (c ComponentsAPIsClient) ComponentsCreateOrUpdate(ctx context.Context, id ComponentId, input ApplicationInsightsComponent) (result ComponentsCreateOrUpdateOperationResponse, err error)

ComponentsCreateOrUpdate ...

func (ComponentsAPIsClient) ComponentsDelete 

func (c ComponentsAPIsClient) ComponentsDelete(ctx context.Context, id ComponentId) (result ComponentsDeleteOperationResponse, err error)

ComponentsDelete ...

func (ComponentsAPIsClient) ComponentsGet 

func (c ComponentsAPIsClient) ComponentsGet(ctx context.Context, id ComponentId) (result ComponentsGetOperationResponse, err error)

ComponentsGet ...

func (ComponentsAPIsClient) ComponentsGetPurgeStatus 

func (c ComponentsAPIsClient) ComponentsGetPurgeStatus(ctx context.Context, id OperationId) (result ComponentsGetPurgeStatusOperationResponse, err error)

ComponentsGetPurgeStatus ...

func (ComponentsAPIsClient) ComponentsList 

func (c ComponentsAPIsClient) ComponentsList(ctx context.Context, id commonids.SubscriptionId) (result ComponentsListOperationResponse, err error)

ComponentsList ...

func (ComponentsAPIsClient) ComponentsListByResourceGroup 

func (c ComponentsAPIsClient) ComponentsListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ComponentsListByResourceGroupOperationResponse, err error)

ComponentsListByResourceGroup ...

func (ComponentsAPIsClient) ComponentsListByResourceGroupComplete 

func (c ComponentsAPIsClient) ComponentsListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ComponentsListByResourceGroupCompleteResult, error)

ComponentsListByResourceGroupComplete retrieves all the results into a single object

func (ComponentsAPIsClient) ComponentsListByResourceGroupCompleteMatchingPredicate 

func (c ComponentsAPIsClient) ComponentsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ApplicationInsightsComponentOperationPredicate) (result ComponentsListByResourceGroupCompleteResult, err error)

ComponentsListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ComponentsAPIsClient) ComponentsListComplete 

func (c ComponentsAPIsClient) ComponentsListComplete(ctx context.Context, id commonids.SubscriptionId) (ComponentsListCompleteResult, error)

ComponentsListComplete retrieves all the results into a single object

func (ComponentsAPIsClient) ComponentsListCompleteMatchingPredicate 

func (c ComponentsAPIsClient) ComponentsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ApplicationInsightsComponentOperationPredicate) (result ComponentsListCompleteResult, err error)

ComponentsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ComponentsAPIsClient) ComponentsPurge 

func (c ComponentsAPIsClient) ComponentsPurge(ctx context.Context, id ComponentId, input ComponentPurgeBody) (result ComponentsPurgeOperationResponse, err error)

ComponentsPurge ...

func (ComponentsAPIsClient) ComponentsUpdateTags 

func (c ComponentsAPIsClient) ComponentsUpdateTags(ctx context.Context, id ComponentId, input TagsResource) (result ComponentsUpdateTagsOperationResponse, err error)

ComponentsUpdateTags ...

type ComponentsCreateOrUpdateOperationResponse 

type ComponentsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationInsightsComponent
}

type ComponentsDeleteOperationResponse 

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

type ComponentsGetOperationResponse 

type ComponentsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationInsightsComponent
}

type ComponentsGetPurgeStatusOperationResponse 

type ComponentsGetPurgeStatusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ComponentPurgeStatusResponse
}

type ComponentsListByResourceGroupCompleteResult 

type ComponentsListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApplicationInsightsComponent
}

type ComponentsListByResourceGroupOperationResponse 

type ComponentsListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApplicationInsightsComponent
}

type ComponentsListCompleteResult 

type ComponentsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApplicationInsightsComponent
}

type ComponentsListOperationResponse 

type ComponentsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApplicationInsightsComponent
}

type ComponentsPurgeOperationResponse 

type ComponentsPurgeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ComponentPurgeResponse
}

type ComponentsUpdateTagsOperationResponse 

type ComponentsUpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationInsightsComponent
}

type FlowType 

type FlowType string
const (
	FlowTypeBluefield FlowType = "Bluefield"
)

func (*FlowType) UnmarshalJSON 

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

type IngestionMode 

type IngestionMode string
const (
	IngestionModeApplicationInsights                       IngestionMode = "ApplicationInsights"
	IngestionModeApplicationInsightsWithDiagnosticSettings IngestionMode = "ApplicationInsightsWithDiagnosticSettings"
	IngestionModeLogAnalytics                              IngestionMode = "LogAnalytics"
)

func (*IngestionMode) UnmarshalJSON 

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

type OperationId 

type OperationId struct {
	SubscriptionId    string
	ResourceGroupName string
	ComponentName     string
	PurgeId           string
}

OperationId is a struct representing the Resource ID for a Operation

func NewOperationID 

func NewOperationID(subscriptionId string, resourceGroupName string, componentName string, purgeId string) OperationId

NewOperationID returns a new OperationId struct

func ParseOperationID 

func ParseOperationID(input string) (*OperationId, error)

ParseOperationID parses 'input' into a OperationId

func ParseOperationIDInsensitively 

func ParseOperationIDInsensitively(input string) (*OperationId, error)

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

func (*OperationId) FromParseResult 

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

func (OperationId) ID 

func (id OperationId) ID() string

ID returns the formatted Operation ID

func (OperationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Operation ID

func (OperationId) String 

func (id OperationId) String() string

String returns a human-readable description of this Operation ID

type PrivateLinkScopedResource 

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

type PublicNetworkAccessType 

type PublicNetworkAccessType string
const (
	PublicNetworkAccessTypeDisabled PublicNetworkAccessType = "Disabled"
	PublicNetworkAccessTypeEnabled  PublicNetworkAccessType = "Enabled"
)

func (*PublicNetworkAccessType) UnmarshalJSON 

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

type PurgeState 

type PurgeState string
const (
	PurgeStateCompleted PurgeState = "completed"
	PurgeStatePending   PurgeState = "pending"
)

func (*PurgeState) UnmarshalJSON 

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

type RequestSource 

type RequestSource string
const (
	RequestSourceRest RequestSource = "rest"
)

func (*RequestSource) UnmarshalJSON 

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

type TagsResource 

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

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.