componentapikeysapis

package
v0.20240227.1130345 Latest Latest
Warning

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

Go to latest
Published: Feb 27, 2024 License: MPL-2.0 Imports: 9 Imported by: 1

README

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

The componentapikeysapis 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-sdk/resource-manager/applicationinsights/2015-05-01/componentapikeysapis"

Client Initialization

client := componentapikeysapis.NewComponentApiKeysAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ComponentApiKeysAPIsClient.APIKeysCreate

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

payload := componentapikeysapis.APIKeyRequest{
	// ...
}


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

Example Usage: ComponentApiKeysAPIsClient.APIKeysDelete

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

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

Example Usage: ComponentApiKeysAPIsClient.APIKeysGet

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

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

Example Usage: ComponentApiKeysAPIsClient.APIKeysList

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

read, err := client.APIKeysList(ctx, id)
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 ValidateApiKeyID

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

ValidateApiKeyID checks that 'input' can be parsed as a Api Key ID

func ValidateComponentID

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

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

Types

type APIKeyRequest

type APIKeyRequest struct {
	LinkedReadProperties  *[]string `json:"linkedReadProperties,omitempty"`
	LinkedWriteProperties *[]string `json:"linkedWriteProperties,omitempty"`
	Name                  *string   `json:"name,omitempty"`
}

type APIKeysCreateOperationResponse

type APIKeysCreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationInsightsComponentAPIKey
}

type APIKeysDeleteOperationResponse

type APIKeysDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationInsightsComponentAPIKey
}

type APIKeysGetOperationResponse

type APIKeysGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationInsightsComponentAPIKey
}

type APIKeysListOperationResponse

type APIKeysListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApplicationInsightsComponentAPIKeyListResult
}

type ApiKeyId

type ApiKeyId struct {
	SubscriptionId    string
	ResourceGroupName string
	ComponentName     string
	KeyId             string
}

ApiKeyId is a struct representing the Resource ID for a Api Key

func NewApiKeyID

func NewApiKeyID(subscriptionId string, resourceGroupName string, componentName string, keyId string) ApiKeyId

NewApiKeyID returns a new ApiKeyId struct

func ParseApiKeyID

func ParseApiKeyID(input string) (*ApiKeyId, error)

ParseApiKeyID parses 'input' into a ApiKeyId

func ParseApiKeyIDInsensitively

func ParseApiKeyIDInsensitively(input string) (*ApiKeyId, error)

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

func (*ApiKeyId) FromParseResult

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

func (ApiKeyId) ID

func (id ApiKeyId) ID() string

ID returns the formatted Api Key ID

func (ApiKeyId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Api Key ID

func (ApiKeyId) String

func (id ApiKeyId) String() string

String returns a human-readable description of this Api Key ID

type ApplicationInsightsComponentAPIKey

type ApplicationInsightsComponentAPIKey struct {
	ApiKey                *string   `json:"apiKey,omitempty"`
	CreatedDate           *string   `json:"createdDate,omitempty"`
	Id                    *string   `json:"id,omitempty"`
	LinkedReadProperties  *[]string `json:"linkedReadProperties,omitempty"`
	LinkedWriteProperties *[]string `json:"linkedWriteProperties,omitempty"`
	Name                  *string   `json:"name,omitempty"`
}

type ApplicationInsightsComponentAPIKeyListResult

type ApplicationInsightsComponentAPIKeyListResult struct {
	Value []ApplicationInsightsComponentAPIKey `json:"value"`
}

type ComponentApiKeysAPIsClient

type ComponentApiKeysAPIsClient struct {
	Client *resourcemanager.Client
}

func NewComponentApiKeysAPIsClientWithBaseURI

func NewComponentApiKeysAPIsClientWithBaseURI(sdkApi sdkEnv.Api) (*ComponentApiKeysAPIsClient, error)

func (ComponentApiKeysAPIsClient) APIKeysCreate

APIKeysCreate ...

func (ComponentApiKeysAPIsClient) APIKeysDelete

APIKeysDelete ...

func (ComponentApiKeysAPIsClient) APIKeysGet

APIKeysGet ...

func (ComponentApiKeysAPIsClient) APIKeysList

APIKeysList ...

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

Jump to

Keyboard shortcuts

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