webtestsapis

package
v0.20240404.1145457 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/applicationinsights/2015-05-01/webtestsapis Documentation

The webtestsapis SDK allows for interaction with the Azure Resource Manager Service applicationinsights (API Version 2015-05-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/applicationinsights/2015-05-01/webtestsapis"

Client Initialization

client := webtestsapis.NewWebTestsAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WebTestsAPIsClient.WebTestsCreateOrUpdate

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

payload := webtestsapis.WebTest{
	// ...
}


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

Example Usage: WebTestsAPIsClient.WebTestsDelete

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

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

Example Usage: WebTestsAPIsClient.WebTestsGet

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

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

Example Usage: WebTestsAPIsClient.WebTestsList

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

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

Example Usage: WebTestsAPIsClient.WebTestsListByComponent

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

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

Example Usage: WebTestsAPIsClient.WebTestsListByResourceGroup

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

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

Example Usage: WebTestsAPIsClient.WebTestsUpdateTags

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

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


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

func PossibleValuesForWebTestKind() []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 ValidateWebTestID

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

ValidateWebTestID checks that 'input' can be parsed as a Web Test ID

Types

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 TagsResource

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

type WebTest

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

type WebTestGeolocation

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

type WebTestId

type WebTestId struct {
	SubscriptionId    string
	ResourceGroupName string
	WebTestName       string
}

WebTestId is a struct representing the Resource ID for a Web Test

func NewWebTestID

func NewWebTestID(subscriptionId string, resourceGroupName string, webTestName string) WebTestId

NewWebTestID returns a new WebTestId struct

func ParseWebTestID

func ParseWebTestID(input string) (*WebTestId, error)

ParseWebTestID parses 'input' into a WebTestId

func ParseWebTestIDInsensitively

func ParseWebTestIDInsensitively(input string) (*WebTestId, error)

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

func (*WebTestId) FromParseResult

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

func (WebTestId) ID

func (id WebTestId) ID() string

ID returns the formatted Web Test ID

func (WebTestId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Web Test ID

func (WebTestId) String

func (id WebTestId) String() string

String returns a human-readable description of this Web Test ID

type WebTestKind

type WebTestKind string
const (
	WebTestKindMultistep WebTestKind = "multistep"
	WebTestKindPing      WebTestKind = "ping"
)

func (*WebTestKind) UnmarshalJSON

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

type WebTestOperationPredicate

type WebTestOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (WebTestOperationPredicate) Matches

func (p WebTestOperationPredicate) Matches(input WebTest) bool

type WebTestProperties

type WebTestProperties struct {
	Configuration      *WebTestPropertiesConfiguration `json:"Configuration,omitempty"`
	Description        *string                         `json:"Description,omitempty"`
	Enabled            *bool                           `json:"Enabled,omitempty"`
	Frequency          *int64                          `json:"Frequency,omitempty"`
	Kind               WebTestKind                     `json:"Kind"`
	Locations          []WebTestGeolocation            `json:"Locations"`
	Name               string                          `json:"Name"`
	ProvisioningState  *string                         `json:"provisioningState,omitempty"`
	RetryEnabled       *bool                           `json:"RetryEnabled,omitempty"`
	SyntheticMonitorId string                          `json:"SyntheticMonitorId"`
	Timeout            *int64                          `json:"Timeout,omitempty"`
}

type WebTestPropertiesConfiguration

type WebTestPropertiesConfiguration struct {
	WebTest *string `json:"WebTest,omitempty"`
}

type WebTestsAPIsClient

type WebTestsAPIsClient struct {
	Client *resourcemanager.Client
}

func NewWebTestsAPIsClientWithBaseURI

func NewWebTestsAPIsClientWithBaseURI(sdkApi sdkEnv.Api) (*WebTestsAPIsClient, error)

func (WebTestsAPIsClient) WebTestsCreateOrUpdate

func (c WebTestsAPIsClient) WebTestsCreateOrUpdate(ctx context.Context, id WebTestId, input WebTest) (result WebTestsCreateOrUpdateOperationResponse, err error)

WebTestsCreateOrUpdate ...

func (WebTestsAPIsClient) WebTestsDelete

func (c WebTestsAPIsClient) WebTestsDelete(ctx context.Context, id WebTestId) (result WebTestsDeleteOperationResponse, err error)

WebTestsDelete ...

func (WebTestsAPIsClient) WebTestsGet

func (c WebTestsAPIsClient) WebTestsGet(ctx context.Context, id WebTestId) (result WebTestsGetOperationResponse, err error)

WebTestsGet ...

func (WebTestsAPIsClient) WebTestsList

WebTestsList ...

func (WebTestsAPIsClient) WebTestsListByComponent

func (c WebTestsAPIsClient) WebTestsListByComponent(ctx context.Context, id ComponentId) (result WebTestsListByComponentOperationResponse, err error)

WebTestsListByComponent ...

func (WebTestsAPIsClient) WebTestsListByComponentComplete

func (c WebTestsAPIsClient) WebTestsListByComponentComplete(ctx context.Context, id ComponentId) (WebTestsListByComponentCompleteResult, error)

WebTestsListByComponentComplete retrieves all the results into a single object

func (WebTestsAPIsClient) WebTestsListByComponentCompleteMatchingPredicate

func (c WebTestsAPIsClient) WebTestsListByComponentCompleteMatchingPredicate(ctx context.Context, id ComponentId, predicate WebTestOperationPredicate) (result WebTestsListByComponentCompleteResult, err error)

WebTestsListByComponentCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (WebTestsAPIsClient) WebTestsListByResourceGroup

WebTestsListByResourceGroup ...

func (WebTestsAPIsClient) WebTestsListByResourceGroupComplete

WebTestsListByResourceGroupComplete retrieves all the results into a single object

func (WebTestsAPIsClient) WebTestsListByResourceGroupCompleteMatchingPredicate

func (c WebTestsAPIsClient) WebTestsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate WebTestOperationPredicate) (result WebTestsListByResourceGroupCompleteResult, err error)

WebTestsListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (WebTestsAPIsClient) WebTestsListComplete

WebTestsListComplete retrieves all the results into a single object

func (WebTestsAPIsClient) WebTestsListCompleteMatchingPredicate

func (c WebTestsAPIsClient) WebTestsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate WebTestOperationPredicate) (result WebTestsListCompleteResult, err error)

WebTestsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (WebTestsAPIsClient) WebTestsUpdateTags

func (c WebTestsAPIsClient) WebTestsUpdateTags(ctx context.Context, id WebTestId, input TagsResource) (result WebTestsUpdateTagsOperationResponse, err error)

WebTestsUpdateTags ...

type WebTestsCreateOrUpdateOperationResponse

type WebTestsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WebTest
}

type WebTestsDeleteOperationResponse

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

type WebTestsGetOperationResponse

type WebTestsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WebTest
}

type WebTestsListByComponentCompleteResult

type WebTestsListByComponentCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []WebTest
}

type WebTestsListByComponentOperationResponse

type WebTestsListByComponentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]WebTest
}

type WebTestsListByResourceGroupCompleteResult

type WebTestsListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []WebTest
}

type WebTestsListByResourceGroupOperationResponse

type WebTestsListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]WebTest
}

type WebTestsListCompleteResult

type WebTestsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []WebTest
}

type WebTestsListOperationResponse

type WebTestsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]WebTest
}

type WebTestsUpdateTagsOperationResponse

type WebTestsUpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WebTest
}

Jump to

Keyboard shortcuts

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