targets

package
v0.20230313.1140427 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/chaosstudio/2022-07-01-preview/targets Documentation

The targets SDK allows for interaction with the Azure Resource Manager Service chaosstudio (API Version 2022-07-01-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/2022-07-01-preview/targets"

Client Initialization

client := targets.NewTargetsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TargetsClient.CreateOrUpdate

ctx := context.TODO()
id := targets.NewTargetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "providerValue", "parentResourceTypeValue", "parentResourceValue", "targetValue")

payload := targets.Target{
	// ...
}


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: TargetsClient.Delete

ctx := context.TODO()
id := targets.NewTargetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "providerValue", "parentResourceTypeValue", "parentResourceValue", "targetValue")

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: TargetsClient.Get

ctx := context.TODO()
id := targets.NewTargetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "providerValue", "parentResourceTypeValue", "parentResourceValue", "targetValue")

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

ctx := context.TODO()
id := targets.NewProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "providerValue", "parentResourceTypeValue", "parentResourceValue")

// alternatively `client.List(ctx, id, targets.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, targets.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 ValidateProviderID 

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

ValidateProviderID checks that 'input' can be parsed as a Provider ID

func ValidateTargetID 

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

ValidateTargetID checks that 'input' can be parsed as a Target ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	Items []Target
}

type ListOperationOptions 

type ListOperationOptions struct {
	ContinuationToken *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230206.1124515 

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

func (ListOperationOptions) ToOData added in v0.20230206.1124515 

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

func (ListOperationOptions) ToQuery added in v0.20230206.1124515 

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

type ListOperationResponse 

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

type ProviderId 

type ProviderId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ProviderName       string
	ParentResourceType string
	ParentResourceName string
}

ProviderId is a struct representing the Resource ID for a Provider

func NewProviderID 

func NewProviderID(subscriptionId string, resourceGroupName string, providerName string, parentResourceType string, parentResourceName string) ProviderId

NewProviderID returns a new ProviderId struct

func ParseProviderID 

func ParseProviderID(input string) (*ProviderId, error)

ParseProviderID parses 'input' into a ProviderId

func ParseProviderIDInsensitively 

func ParseProviderIDInsensitively(input string) (*ProviderId, error)

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

func (ProviderId) ID 

func (id ProviderId) ID() string

ID returns the formatted Provider ID

func (ProviderId) Segments 

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

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

func (ProviderId) String 

func (id ProviderId) String() string

String returns a human-readable description of this Provider ID

type Target 

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

type TargetId 

type TargetId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ProviderName       string
	ParentResourceType string
	ParentResourceName string
	TargetName         string
}

TargetId is a struct representing the Resource ID for a Target

func NewTargetID 

func NewTargetID(subscriptionId string, resourceGroupName string, providerName string, parentResourceType string, parentResourceName string, targetName string) TargetId

NewTargetID returns a new TargetId struct

func ParseTargetID 

func ParseTargetID(input string) (*TargetId, error)

ParseTargetID parses 'input' into a TargetId

func ParseTargetIDInsensitively 

func ParseTargetIDInsensitively(input string) (*TargetId, error)

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

func (TargetId) ID 

func (id TargetId) ID() string

ID returns the formatted Target ID

func (TargetId) Segments 

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

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

func (TargetId) String 

func (id TargetId) String() string

String returns a human-readable description of this Target ID

type TargetOperationPredicate 

type TargetOperationPredicate struct {
	Id         *string
	Location   *string
	Name       *string
	Properties *interface{}
	Type       *string
}

func (TargetOperationPredicate) Matches 

func (p TargetOperationPredicate) Matches(input Target) bool

type TargetsClient 

type TargetsClient struct {
	Client *resourcemanager.Client
}

func NewTargetsClientWithBaseURI 

func NewTargetsClientWithBaseURI(api environments.Api) (*TargetsClient, error)

func (TargetsClient) CreateOrUpdate 

func (c TargetsClient) CreateOrUpdate(ctx context.Context, id TargetId, input Target) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (TargetsClient) Delete 

func (c TargetsClient) Delete(ctx context.Context, id TargetId) (result DeleteOperationResponse, err error)

Delete ...

func (TargetsClient) Get 

func (c TargetsClient) Get(ctx context.Context, id TargetId) (result GetOperationResponse, err error)

Get ...

func (TargetsClient) List 

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

List ...

func (TargetsClient) ListComplete 

func (c TargetsClient) ListComplete(ctx context.Context, id ProviderId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (TargetsClient) ListCompleteMatchingPredicate 

func (c TargetsClient) ListCompleteMatchingPredicate(ctx context.Context, id ProviderId, options ListOperationOptions, predicate TargetOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.