capabilities

package
v0.20231114.1102450 Latest Latest
Warning

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

 Go to latest Published: Nov 14, 2023 License: MPL-2.0 Imports: 10 Imported by: 0

README

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

The capabilities 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/capabilities"

Client Initialization

client := capabilities.NewCapabilitiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CapabilitiesClient.CapabilityTypesGet

ctx := context.TODO()
id := capabilities.NewCapabilityTypeID("12345678-1234-9876-4563-123456789012", "locationValue", "targetTypeValue", "capabilityTypeValue")

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

Example Usage: CapabilitiesClient.CreateOrUpdate

ctx := context.TODO()
id := capabilities.NewScopedCapabilityID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "targetValue", "capabilityValue")

payload := capabilities.Capability{
	// ...
}


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

Example Usage: CapabilitiesClient.Delete

ctx := context.TODO()
id := capabilities.NewScopedCapabilityID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "targetValue", "capabilityValue")

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

Example Usage: CapabilitiesClient.Get

ctx := context.TODO()
id := capabilities.NewScopedCapabilityID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "targetValue", "capabilityValue")

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

ctx := context.TODO()
id := capabilities.NewScopedTargetID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "targetValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateCapabilityTypeID 

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

ValidateCapabilityTypeID checks that 'input' can be parsed as a Capability Type ID

func ValidateScopedCapabilityID 

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

ValidateScopedCapabilityID checks that 'input' can be parsed as a Scoped Capability ID

func ValidateScopedTargetID 

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

ValidateScopedTargetID checks that 'input' can be parsed as a Scoped Target ID

Types

type CapabilitiesClient 

type CapabilitiesClient struct {
	Client *resourcemanager.Client
}

func NewCapabilitiesClientWithBaseURI 

func NewCapabilitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*CapabilitiesClient, error)

func (CapabilitiesClient) CapabilityTypesGet 

func (c CapabilitiesClient) CapabilityTypesGet(ctx context.Context, id CapabilityTypeId) (result CapabilityTypesGetOperationResponse, err error)

CapabilityTypesGet ...

func (CapabilitiesClient) CreateOrUpdate 

func (c CapabilitiesClient) CreateOrUpdate(ctx context.Context, id ScopedCapabilityId, input Capability) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (CapabilitiesClient) Delete 

func (c CapabilitiesClient) Delete(ctx context.Context, id ScopedCapabilityId) (result DeleteOperationResponse, err error)

Delete ...

func (CapabilitiesClient) Get 

func (c CapabilitiesClient) Get(ctx context.Context, id ScopedCapabilityId) (result GetOperationResponse, err error)

Get ...

func (CapabilitiesClient) List 

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

List ...

func (CapabilitiesClient) ListComplete 

func (c CapabilitiesClient) ListComplete(ctx context.Context, id ScopedTargetId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (CapabilitiesClient) ListCompleteMatchingPredicate 

func (c CapabilitiesClient) ListCompleteMatchingPredicate(ctx context.Context, id ScopedTargetId, options ListOperationOptions, predicate CapabilityOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type Capability 

type Capability struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *CapabilityProperties  `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type CapabilityOperationPredicate 

type CapabilityOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (CapabilityOperationPredicate) Matches 

func (p CapabilityOperationPredicate) Matches(input Capability) bool

type CapabilityProperties 

type CapabilityProperties struct {
	Description      *string `json:"description,omitempty"`
	ParametersSchema *string `json:"parametersSchema,omitempty"`
	Publisher        *string `json:"publisher,omitempty"`
	TargetType       *string `json:"targetType,omitempty"`
	Urn              *string `json:"urn,omitempty"`
}

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 CapabilityTypeId 

type CapabilityTypeId struct {
	SubscriptionId     string
	LocationName       string
	TargetTypeName     string
	CapabilityTypeName string
}

CapabilityTypeId is a struct representing the Resource ID for a Capability Type

func NewCapabilityTypeID 

func NewCapabilityTypeID(subscriptionId string, locationName string, targetTypeName string, capabilityTypeName string) CapabilityTypeId

NewCapabilityTypeID returns a new CapabilityTypeId struct

func ParseCapabilityTypeID 

func ParseCapabilityTypeID(input string) (*CapabilityTypeId, error)

ParseCapabilityTypeID parses 'input' into a CapabilityTypeId

func ParseCapabilityTypeIDInsensitively 

func ParseCapabilityTypeIDInsensitively(input string) (*CapabilityTypeId, error)

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

func (CapabilityTypeId) ID 

func (id CapabilityTypeId) ID() string

ID returns the formatted Capability Type ID

func (CapabilityTypeId) Segments 

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

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

func (CapabilityTypeId) String 

func (id CapabilityTypeId) String() string

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

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 CapabilityTypesGetOperationResponse 

type CapabilityTypesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CapabilityType
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Capability
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	Items []Capability
}

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

type ScopedCapabilityId 

type ScopedCapabilityId struct {
	Scope          string
	TargetName     string
	CapabilityName string
}

ScopedCapabilityId is a struct representing the Resource ID for a Scoped Capability

func NewScopedCapabilityID 

func NewScopedCapabilityID(scope string, targetName string, capabilityName string) ScopedCapabilityId

NewScopedCapabilityID returns a new ScopedCapabilityId struct

func ParseScopedCapabilityID 

func ParseScopedCapabilityID(input string) (*ScopedCapabilityId, error)

ParseScopedCapabilityID parses 'input' into a ScopedCapabilityId

func ParseScopedCapabilityIDInsensitively 

func ParseScopedCapabilityIDInsensitively(input string) (*ScopedCapabilityId, error)

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

func (ScopedCapabilityId) ID 

func (id ScopedCapabilityId) ID() string

ID returns the formatted Scoped Capability ID

func (ScopedCapabilityId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Scoped Capability ID

func (ScopedCapabilityId) String 

func (id ScopedCapabilityId) String() string

String returns a human-readable description of this Scoped Capability ID

type ScopedTargetId 

type ScopedTargetId struct {
	Scope      string
	TargetName string
}

ScopedTargetId is a struct representing the Resource ID for a Scoped Target

func NewScopedTargetID 

func NewScopedTargetID(scope string, targetName string) ScopedTargetId

NewScopedTargetID returns a new ScopedTargetId struct

func ParseScopedTargetID 

func ParseScopedTargetID(input string) (*ScopedTargetId, error)

ParseScopedTargetID parses 'input' into a ScopedTargetId

func ParseScopedTargetIDInsensitively 

func ParseScopedTargetIDInsensitively(input string) (*ScopedTargetId, error)

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

func (ScopedTargetId) ID 

func (id ScopedTargetId) ID() string

ID returns the formatted Scoped Target ID

func (ScopedTargetId) Segments 

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

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

func (ScopedTargetId) String 

func (id ScopedTargetId) String() string

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.