provideroperationsmetadata

README

github.com/hashicorp/go-azure-sdk/resource-manager/authorization/2022-04-01/provideroperationsmetadata Documentation

The provideroperationsmetadata SDK allows for interaction with the Azure Resource Manager Service authorization (API Version 2022-04-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/authorization/2022-04-01/provideroperationsmetadata"

Client Initialization

client := provideroperationsmetadata.NewProviderOperationsMetadataClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProviderOperationsMetadataClient.Get

ctx := context.TODO()
id := provideroperationsmetadata.NewProviderOperationID("providerOperationValue")

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

Example Usage: ProviderOperationsMetadataClient.List

ctx := context.TODO()


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

Documentation

Index

• func ValidateProviderOperationID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationOptions
  • func DefaultGetOperationOptions() GetOperationOptions
  • func (o GetOperationOptions) ToHeaders() *client.Headers
  • func (o GetOperationOptions) ToOData() *odata.Query
  • func (o GetOperationOptions) ToQuery() *client.QueryParams
• 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 ProviderOperation
• type ProviderOperationId
  • func NewProviderOperationID(providerOperationName string) ProviderOperationId
  • func ParseProviderOperationID(input string) (*ProviderOperationId, error)
  • func ParseProviderOperationIDInsensitively(input string) (*ProviderOperationId, error)
  • func (id *ProviderOperationId) FromParseResult(input resourceids.ParseResult) error
  • func (id ProviderOperationId) ID() string
  • func (id ProviderOperationId) Segments() []resourceids.Segment
  • func (id ProviderOperationId) String() string
• type ProviderOperationsMetadata
• type ProviderOperationsMetadataClient
  • func NewProviderOperationsMetadataClientWithBaseURI(sdkApi sdkEnv.Api) (*ProviderOperationsMetadataClient, error)
  • func (c ProviderOperationsMetadataClient) Get(ctx context.Context, id ProviderOperationId, options GetOperationOptions) (result GetOperationResponse, err error)
  • func (c ProviderOperationsMetadataClient) List(ctx context.Context, options ListOperationOptions) (result ListOperationResponse, err error)
  • func (c ProviderOperationsMetadataClient) ListComplete(ctx context.Context, options ListOperationOptions) (ListCompleteResult, error)
  • func (c ProviderOperationsMetadataClient) ListCompleteMatchingPredicate(ctx context.Context, options ListOperationOptions, ...) (result ListCompleteResult, err error)
• type ProviderOperationsMetadataOperationPredicate
  • func (p ProviderOperationsMetadataOperationPredicate) Matches(input ProviderOperationsMetadata) bool
• type ResourceType

Functions

func ValidateProviderOperationID

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

ValidateProviderOperationID checks that 'input' can be parsed as a Provider Operation ID

Types

type GetOperationOptions

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders

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

func (GetOperationOptions) ToOData

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

func (GetOperationOptions) ToQuery

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

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationOptions

type ListOperationOptions struct {
	Expand *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        *[]ProviderOperationsMetadata
}

type ProviderOperation

type ProviderOperation struct {
	Description  *string      `json:"description,omitempty"`
	DisplayName  *string      `json:"displayName,omitempty"`
	IsDataAction *bool        `json:"isDataAction,omitempty"`
	Name         *string      `json:"name,omitempty"`
	Origin       *string      `json:"origin,omitempty"`
	Properties   *interface{} `json:"properties,omitempty"`
}

type ProviderOperationId

type ProviderOperationId struct {
	ProviderOperationName string
}

ProviderOperationId is a struct representing the Resource ID for a Provider Operation

func NewProviderOperationID

func NewProviderOperationID(providerOperationName string) ProviderOperationId

NewProviderOperationID returns a new ProviderOperationId struct

func ParseProviderOperationID

func ParseProviderOperationID(input string) (*ProviderOperationId, error)

ParseProviderOperationID parses 'input' into a ProviderOperationId

func ParseProviderOperationIDInsensitively

func ParseProviderOperationIDInsensitively(input string) (*ProviderOperationId, error)

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

func (*ProviderOperationId) FromParseResult

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

func (ProviderOperationId) ID

func (id ProviderOperationId) ID() string

ID returns the formatted Provider Operation ID

func (ProviderOperationId) Segments

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

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

func (ProviderOperationId) String

func (id ProviderOperationId) String() string

String returns a human-readable description of this Provider Operation ID

type ProviderOperationsMetadata

type ProviderOperationsMetadata struct {
	DisplayName   *string              `json:"displayName,omitempty"`
	Id            *string              `json:"id,omitempty"`
	Name          *string              `json:"name,omitempty"`
	Operations    *[]ProviderOperation `json:"operations,omitempty"`
	ResourceTypes *[]ResourceType      `json:"resourceTypes,omitempty"`
	Type          *string              `json:"type,omitempty"`
}

type ProviderOperationsMetadataClient

type ProviderOperationsMetadataClient struct {
	Client *resourcemanager.Client
}

func NewProviderOperationsMetadataClientWithBaseURI

func NewProviderOperationsMetadataClientWithBaseURI(sdkApi sdkEnv.Api) (*ProviderOperationsMetadataClient, error)

func (ProviderOperationsMetadataClient) Get

func (c ProviderOperationsMetadataClient) Get(ctx context.Context, id ProviderOperationId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (ProviderOperationsMetadataClient) List

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

List ...

func (ProviderOperationsMetadataClient) ListComplete

func (c ProviderOperationsMetadataClient) ListComplete(ctx context.Context, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ProviderOperationsMetadataClient) ListCompleteMatchingPredicate

func (c ProviderOperationsMetadataClient) ListCompleteMatchingPredicate(ctx context.Context, options ListOperationOptions, predicate ProviderOperationsMetadataOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ProviderOperationsMetadataOperationPredicate

type ProviderOperationsMetadataOperationPredicate struct {
	DisplayName *string
	Id          *string
	Name        *string
	Type        *string
}

func (ProviderOperationsMetadataOperationPredicate) Matches

func (p ProviderOperationsMetadataOperationPredicate) Matches(input ProviderOperationsMetadata) bool

type ResourceType

type ResourceType struct {
	DisplayName *string              `json:"displayName,omitempty"`
	Name        *string              `json:"name,omitempty"`
	Operations  *[]ProviderOperation `json:"operations,omitempty"`
}