operations

README

github.com/hashicorp/go-azure-sdk/resource-manager/maps/2021-02-01/operations Documentation

The operations SDK allows for interaction with the Azure Resource Manager Service maps (API Version 2021-02-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/maps/2021-02-01/operations"

Client Initialization

client := operations.NewOperationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OperationsClient.MapsListSubscriptionOperations

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Documentation

Index

• type Dimension
• type MapsListSubscriptionOperationsCompleteResult
• type MapsListSubscriptionOperationsOperationResponse
• type MetricSpecification
• type OperationDetail
• type OperationDetailOperationPredicate
  • func (p OperationDetailOperationPredicate) Matches(input OperationDetail) bool
• type OperationDisplay
• type OperationProperties
• type OperationsClient
  • func NewOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*OperationsClient, error)
  • func (c OperationsClient) MapsListSubscriptionOperations(ctx context.Context, id commonids.SubscriptionId) (result MapsListSubscriptionOperationsOperationResponse, err error)
  • func (c OperationsClient) MapsListSubscriptionOperationsComplete(ctx context.Context, id commonids.SubscriptionId) (MapsListSubscriptionOperationsCompleteResult, error)
  • func (c OperationsClient) MapsListSubscriptionOperationsCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result MapsListSubscriptionOperationsCompleteResult, err error)
• type ServiceSpecification

Types

type Dimension

type Dimension struct {
	DisplayName           *string `json:"displayName,omitempty"`
	InternalMetricName    *string `json:"internalMetricName,omitempty"`
	InternalName          *string `json:"internalName,omitempty"`
	Name                  *string `json:"name,omitempty"`
	SourceMdmNamespace    *string `json:"sourceMdmNamespace,omitempty"`
	ToBeExportedToShoebox *bool   `json:"toBeExportedToShoebox,omitempty"`
}

type MapsListSubscriptionOperationsCompleteResult

type MapsListSubscriptionOperationsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []OperationDetail
}

type MapsListSubscriptionOperationsOperationResponse

type MapsListSubscriptionOperationsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]OperationDetail
}

type MetricSpecification

type MetricSpecification struct {
	AggregationType                 *string      `json:"aggregationType,omitempty"`
	Category                        *string      `json:"category,omitempty"`
	Dimensions                      *[]Dimension `json:"dimensions,omitempty"`
	DisplayDescription              *string      `json:"displayDescription,omitempty"`
	DisplayName                     *string      `json:"displayName,omitempty"`
	FillGapWithZero                 *bool        `json:"fillGapWithZero,omitempty"`
	Name                            *string      `json:"name,omitempty"`
	ResourceIdDimensionNameOverride *string      `json:"resourceIdDimensionNameOverride,omitempty"`
	Unit                            *string      `json:"unit,omitempty"`
}

type OperationDetail

type OperationDetail struct {
	Display      *OperationDisplay    `json:"display,omitempty"`
	IsDataAction *bool                `json:"isDataAction,omitempty"`
	Name         *string              `json:"name,omitempty"`
	Origin       *string              `json:"origin,omitempty"`
	Properties   *OperationProperties `json:"properties,omitempty"`
}

type OperationDetailOperationPredicate

type OperationDetailOperationPredicate struct {
	IsDataAction *bool
	Name         *string
	Origin       *string
}

func (OperationDetailOperationPredicate) Matches

func (p OperationDetailOperationPredicate) Matches(input OperationDetail) bool

type OperationDisplay

type OperationDisplay struct {
	Description *string `json:"description,omitempty"`
	Operation   *string `json:"operation,omitempty"`
	Provider    *string `json:"provider,omitempty"`
	Resource    *string `json:"resource,omitempty"`
}

type OperationProperties

type OperationProperties struct {
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

type OperationsClient

type OperationsClient struct {
	Client *resourcemanager.Client
}

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*OperationsClient, error)

func (OperationsClient) MapsListSubscriptionOperations

func (c OperationsClient) MapsListSubscriptionOperations(ctx context.Context, id commonids.SubscriptionId) (result MapsListSubscriptionOperationsOperationResponse, err error)

MapsListSubscriptionOperations ...

func (OperationsClient) MapsListSubscriptionOperationsComplete

func (c OperationsClient) MapsListSubscriptionOperationsComplete(ctx context.Context, id commonids.SubscriptionId) (MapsListSubscriptionOperationsCompleteResult, error)

MapsListSubscriptionOperationsComplete retrieves all the results into a single object

func (OperationsClient) MapsListSubscriptionOperationsCompleteMatchingPredicate

func (c OperationsClient) MapsListSubscriptionOperationsCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate OperationDetailOperationPredicate) (result MapsListSubscriptionOperationsCompleteResult, err error)

MapsListSubscriptionOperationsCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ServiceSpecification

type ServiceSpecification struct {
	MetricSpecifications *[]MetricSpecification `json:"metricSpecifications,omitempty"`
}