targettypes

README

github.com/hashicorp/go-azure-sdk/resource-manager/chaosstudio/2023-04-15-preview/targettypes Documentation

The targettypes SDK allows for interaction with the Azure Resource Manager Service chaosstudio (API Version 2023-04-15-preview).

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/chaosstudio/2023-04-15-preview/targettypes"

Client Initialization

client := targettypes.NewTargetTypesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TargetTypesClient.Get

ctx := context.TODO()
id := targettypes.NewTargetTypeID("12345678-1234-9876-4563-123456789012", "locationValue", "targetTypeValue")

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: TargetTypesClient.List

ctx := context.TODO()
id := targettypes.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

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

Documentation

Index

• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateTargetTypeID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
  • func (o ListOperationOptions) ToHeaders() *client.Headers
  • func (o ListOperationOptions) ToOData() *odata.Query
  • func (o ListOperationOptions) ToQuery() *client.QueryParams
• type ListOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type TargetType
• type TargetTypeId
  • func NewTargetTypeID(subscriptionId string, locationName string, targetTypeName string) TargetTypeId
  • func ParseTargetTypeID(input string) (*TargetTypeId, error)
  • func ParseTargetTypeIDInsensitively(input string) (*TargetTypeId, error)
  • func (id *TargetTypeId) FromParseResult(input resourceids.ParseResult) error
  • func (id TargetTypeId) ID() string
  • func (id TargetTypeId) Segments() []resourceids.Segment
  • func (id TargetTypeId) String() string
• type TargetTypeOperationPredicate
  • func (p TargetTypeOperationPredicate) Matches(input TargetType) bool
• type TargetTypeProperties
• type TargetTypesClient
  • func NewTargetTypesClientWithBaseURI(sdkApi sdkEnv.Api) (*TargetTypesClient, error)
  • func (c TargetTypesClient) Get(ctx context.Context, id TargetTypeId) (result GetOperationResponse, err error)
  • func (c TargetTypesClient) List(ctx context.Context, id LocationId, options ListOperationOptions) (result ListOperationResponse, err error)
  • func (c TargetTypesClient) ListComplete(ctx context.Context, id LocationId, options ListOperationOptions) (ListCompleteResult, error)
  • func (c TargetTypesClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, options ListOperationOptions, ...) (result ListCompleteResult, err error)

Functions

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

func ValidateTargetTypeID

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

ValidateTargetTypeID checks that 'input' can be parsed as a Target Type ID

Types

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TargetType
}

type ListCompleteResult

type ListCompleteResult struct {
	Items []TargetType
}

type ListOperationOptions

type ListOperationOptions struct {
	ContinuationToken *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TargetType
}

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type TargetType

type TargetType struct {
	Id         *string                `json:"id,omitempty"`
	Location   *string                `json:"location,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties TargetTypeProperties   `json:"properties"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type TargetTypeId

type TargetTypeId struct {
	SubscriptionId string
	LocationName   string
	TargetTypeName string
}

TargetTypeId is a struct representing the Resource ID for a Target Type

func NewTargetTypeID

func NewTargetTypeID(subscriptionId string, locationName string, targetTypeName string) TargetTypeId

NewTargetTypeID returns a new TargetTypeId struct

func ParseTargetTypeID

func ParseTargetTypeID(input string) (*TargetTypeId, error)

ParseTargetTypeID parses 'input' into a TargetTypeId

func ParseTargetTypeIDInsensitively

func ParseTargetTypeIDInsensitively(input string) (*TargetTypeId, error)

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

func (*TargetTypeId) FromParseResult

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

func (TargetTypeId) ID

func (id TargetTypeId) ID() string

ID returns the formatted Target Type ID

func (TargetTypeId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Target Type ID

func (TargetTypeId) String

func (id TargetTypeId) String() string

String returns a human-readable description of this Target Type ID

type TargetTypeOperationPredicate

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

func (TargetTypeOperationPredicate) Matches

func (p TargetTypeOperationPredicate) Matches(input TargetType) bool

type TargetTypeProperties

type TargetTypeProperties struct {
	Description      *string   `json:"description,omitempty"`
	DisplayName      *string   `json:"displayName,omitempty"`
	PropertiesSchema *string   `json:"propertiesSchema,omitempty"`
	ResourceTypes    *[]string `json:"resourceTypes,omitempty"`
}

type TargetTypesClient

type TargetTypesClient struct {
	Client *resourcemanager.Client
}

func NewTargetTypesClientWithBaseURI

func NewTargetTypesClientWithBaseURI(sdkApi sdkEnv.Api) (*TargetTypesClient, error)

func (TargetTypesClient) Get

func (c TargetTypesClient) Get(ctx context.Context, id TargetTypeId) (result GetOperationResponse, err error)

Get ...

func (TargetTypesClient) List

func (c TargetTypesClient) List(ctx context.Context, id LocationId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (TargetTypesClient) ListComplete

func (c TargetTypesClient) ListComplete(ctx context.Context, id LocationId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (TargetTypesClient) ListCompleteMatchingPredicate

func (c TargetTypesClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, options ListOperationOptions, predicate TargetTypeOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate