capabilitytypes

README

github.com/hashicorp/go-azure-sdk/resource-manager/chaosstudio/2023-11-01/capabilitytypes Documentation

The capabilitytypes SDK allows for interaction with the Azure Resource Manager Service chaosstudio (API Version 2023-11-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/chaosstudio/2023-11-01/capabilitytypes"

Client Initialization

client := capabilitytypes.NewCapabilityTypesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CapabilityTypesClient.List

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

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

Documentation

Index

• func ValidateTargetTypeID(input interface{}, key string) (warnings []string, errors []error)
• type CapabilityType
• type CapabilityTypeOperationPredicate
  • func (p CapabilityTypeOperationPredicate) Matches(input CapabilityType) bool
• type CapabilityTypeProperties
• type CapabilityTypePropertiesRuntimeProperties
• type CapabilityTypesClient
  • func NewCapabilityTypesClientWithBaseURI(sdkApi sdkEnv.Api) (*CapabilityTypesClient, error)
  • func (c CapabilityTypesClient) List(ctx context.Context, id TargetTypeId, options ListOperationOptions) (result ListOperationResponse, err error)
  • func (c CapabilityTypesClient) ListComplete(ctx context.Context, id TargetTypeId, options ListOperationOptions) (ListCompleteResult, error)
  • func (c CapabilityTypesClient) ListCompleteMatchingPredicate(ctx context.Context, id TargetTypeId, options ListOperationOptions, ...) (result ListCompleteResult, err error)
• 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 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

Functions

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 CapabilityType

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

type CapabilityTypeOperationPredicate

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

func (CapabilityTypeOperationPredicate) Matches

func (p CapabilityTypeOperationPredicate) Matches(input CapabilityType) bool

type CapabilityTypeProperties

type CapabilityTypeProperties struct {
	AzureRbacActions     *[]string                                  `json:"azureRbacActions,omitempty"`
	AzureRbacDataActions *[]string                                  `json:"azureRbacDataActions,omitempty"`
	Description          *string                                    `json:"description,omitempty"`
	DisplayName          *string                                    `json:"displayName,omitempty"`
	Kind                 *string                                    `json:"kind,omitempty"`
	ParametersSchema     *string                                    `json:"parametersSchema,omitempty"`
	Publisher            *string                                    `json:"publisher,omitempty"`
	RuntimeProperties    *CapabilityTypePropertiesRuntimeProperties `json:"runtimeProperties,omitempty"`
	TargetType           *string                                    `json:"targetType,omitempty"`
	Urn                  *string                                    `json:"urn,omitempty"`
}

type CapabilityTypePropertiesRuntimeProperties

type CapabilityTypePropertiesRuntimeProperties struct {
	Kind *string `json:"kind,omitempty"`
}

type CapabilityTypesClient

type CapabilityTypesClient struct {
	Client *resourcemanager.Client
}

func NewCapabilityTypesClientWithBaseURI

func NewCapabilityTypesClientWithBaseURI(sdkApi sdkEnv.Api) (*CapabilityTypesClient, error)

func (CapabilityTypesClient) List

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

List ...

func (CapabilityTypesClient) ListComplete

func (c CapabilityTypesClient) ListComplete(ctx context.Context, id TargetTypeId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (CapabilityTypesClient) ListCompleteMatchingPredicate

func (c CapabilityTypesClient) ListCompleteMatchingPredicate(ctx context.Context, id TargetTypeId, options ListOperationOptions, predicate CapabilityTypeOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CapabilityType
}

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        *[]CapabilityType
}

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