package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# 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
}

# Functions

NewComponentID returns a new ComponentId struct.
No description provided by the author
NewOperationID returns a new OperationId struct.
ParseComponentID parses 'input' into a ComponentId.
ParseComponentIDInsensitively parses 'input' case-insensitively into a ComponentId note: this method should only be used for API response data and not user input.
ParseOperationID parses 'input' into a OperationId.
ParseOperationIDInsensitively parses 'input' case-insensitively into a OperationId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ValidateComponentID checks that 'input' can be parsed as a Component ID.
ValidateOperationID checks that 'input' can be parsed as a Operation ID.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
ComponentId is a struct representing the Resource ID for a Component.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OperationId is a struct representing the Resource ID for a Operation.
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author