README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/chaosstudio/2023-11-01/capabilities
Documentation
The capabilities
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/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.NewChaosStudioCapabilityID("/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.NewChaosStudioCapabilityID("/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.NewChaosStudioCapabilityID("/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.NewChaosStudioTargetID("/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 ¶
- func ValidateCapabilityTypeID(input interface{}, key string) (warnings []string, errors []error)
- type CapabilitiesClient
- func (c CapabilitiesClient) CapabilityTypesGet(ctx context.Context, id CapabilityTypeId) (result CapabilityTypesGetOperationResponse, err error)
- func (c CapabilitiesClient) CreateOrUpdate(ctx context.Context, id commonids.ChaosStudioCapabilityId, input Capability) (result CreateOrUpdateOperationResponse, err error)
- func (c CapabilitiesClient) Delete(ctx context.Context, id commonids.ChaosStudioCapabilityId) (result DeleteOperationResponse, err error)
- func (c CapabilitiesClient) Get(ctx context.Context, id commonids.ChaosStudioCapabilityId) (result GetOperationResponse, err error)
- func (c CapabilitiesClient) List(ctx context.Context, id commonids.ChaosStudioTargetId, ...) (result ListOperationResponse, err error)
- func (c CapabilitiesClient) ListComplete(ctx context.Context, id commonids.ChaosStudioTargetId, ...) (ListCompleteResult, error)
- func (c CapabilitiesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ChaosStudioTargetId, ...) (result ListCompleteResult, err error)
- type Capability
- type CapabilityOperationPredicate
- type CapabilityProperties
- type CapabilityType
- type CapabilityTypeId
- type CapabilityTypeProperties
- type CapabilityTypePropertiesRuntimeProperties
- type CapabilityTypesGetOperationResponse
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListCompleteResult
- type ListOperationOptions
- type ListOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateCapabilityTypeID ¶
ValidateCapabilityTypeID checks that 'input' can be parsed as a Capability Type 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 commonids.ChaosStudioCapabilityId, input Capability) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (CapabilitiesClient) Delete ¶
func (c CapabilitiesClient) Delete(ctx context.Context, id commonids.ChaosStudioCapabilityId) (result DeleteOperationResponse, err error)
Delete ...
func (CapabilitiesClient) Get ¶
func (c CapabilitiesClient) Get(ctx context.Context, id commonids.ChaosStudioCapabilityId) (result GetOperationResponse, err error)
Get ...
func (CapabilitiesClient) List ¶
func (c CapabilitiesClient) List(ctx context.Context, id commonids.ChaosStudioTargetId, options ListOperationOptions) (result ListOperationResponse, err error)
List ...
func (CapabilitiesClient) ListComplete ¶
func (c CapabilitiesClient) ListComplete(ctx context.Context, id commonids.ChaosStudioTargetId, options ListOperationOptions) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (CapabilitiesClient) ListCompleteMatchingPredicate ¶
func (c CapabilitiesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ChaosStudioTargetId, 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 ¶
func (CapabilityOperationPredicate) Matches ¶
func (p CapabilityOperationPredicate) Matches(input Capability) bool
type CapabilityProperties ¶
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) FromParseResult ¶ added in v0.20231127.1171502
func (id *CapabilityTypeId) FromParseResult(input resourceids.ParseResult) error
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 GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *Capability }
type ListCompleteResult ¶
type ListCompleteResult struct { LatestHttpResponse *http.Response 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 }
Source Files ¶
- client.go
- id_capabilitytype.go
- method_capabilitytypesget.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_list.go
- model_capability.go
- model_capabilityproperties.go
- model_capabilitytype.go
- model_capabilitytypeproperties.go
- model_capabilitytypepropertiesruntimeproperties.go
- predicates.go
- version.go