proxy

package
v0.20230221.1154553 Latest Latest
Warning

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

Go to latest
Published: Feb 21, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/mixedreality/2021-01-01/proxy Documentation

The proxy SDK allows for interaction with the Azure Resource Manager Service mixedreality (API Version 2021-01-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/mixedreality/2021-01-01/proxy"

Client Initialization

client := proxy.NewProxyClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProxyClient.CheckNameAvailabilityLocal

ctx := context.TODO()
id := proxy.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

payload := proxy.CheckNameAvailabilityRequest{
	// ...
}


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

Example Usage: ProxyClient.RemoteRenderingAccountsListBySubscription

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

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

Example Usage: ProxyClient.SpatialAnchorsAccountsListBySubscription

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

// alternatively `client.SpatialAnchorsAccountsListBySubscription(ctx, id)` can be used to do batched pagination
items, err := client.SpatialAnchorsAccountsListBySubscriptionComplete(ctx, id)
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 PossibleValuesForNameUnavailableReason

func PossibleValuesForNameUnavailableReason() []string

func PossibleValuesForSkuTier

func PossibleValuesForSkuTier() []string

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type CheckNameAvailabilityLocalOperationResponse

type CheckNameAvailabilityLocalOperationResponse struct {
	HttpResponse *http.Response
	Model        *CheckNameAvailabilityResponse
}

type CheckNameAvailabilityRequest

type CheckNameAvailabilityRequest struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

type CheckNameAvailabilityResponse

type CheckNameAvailabilityResponse struct {
	Message       *string                `json:"message,omitempty"`
	NameAvailable bool                   `json:"nameAvailable"`
	Reason        *NameUnavailableReason `json:"reason,omitempty"`
}

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type MixedRealityAccountProperties

type MixedRealityAccountProperties struct {
	AccountDomain      *string `json:"accountDomain,omitempty"`
	AccountId          *string `json:"accountId,omitempty"`
	StorageAccountName *string `json:"storageAccountName,omitempty"`
}

type NameUnavailableReason

type NameUnavailableReason string
const (
	NameUnavailableReasonAlreadyExists NameUnavailableReason = "AlreadyExists"
	NameUnavailableReasonInvalid       NameUnavailableReason = "Invalid"
)

type ProxyClient

type ProxyClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewProxyClientWithBaseURI

func NewProxyClientWithBaseURI(endpoint string) ProxyClient

func (ProxyClient) CheckNameAvailabilityLocal

func (c ProxyClient) CheckNameAvailabilityLocal(ctx context.Context, id LocationId, input CheckNameAvailabilityRequest) (result CheckNameAvailabilityLocalOperationResponse, err error)

CheckNameAvailabilityLocal ...

func (ProxyClient) RemoteRenderingAccountsListBySubscription

func (c ProxyClient) RemoteRenderingAccountsListBySubscription(ctx context.Context, id commonids.SubscriptionId) (resp RemoteRenderingAccountsListBySubscriptionOperationResponse, err error)

RemoteRenderingAccountsListBySubscription ...

func (ProxyClient) RemoteRenderingAccountsListBySubscriptionComplete

func (c ProxyClient) RemoteRenderingAccountsListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (RemoteRenderingAccountsListBySubscriptionCompleteResult, error)

RemoteRenderingAccountsListBySubscriptionComplete retrieves all of the results into a single object

func (ProxyClient) RemoteRenderingAccountsListBySubscriptionCompleteMatchingPredicate

func (c ProxyClient) RemoteRenderingAccountsListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate RemoteRenderingAccountOperationPredicate) (resp RemoteRenderingAccountsListBySubscriptionCompleteResult, err error)

RemoteRenderingAccountsListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ProxyClient) SpatialAnchorsAccountsListBySubscription

func (c ProxyClient) SpatialAnchorsAccountsListBySubscription(ctx context.Context, id commonids.SubscriptionId) (resp SpatialAnchorsAccountsListBySubscriptionOperationResponse, err error)

SpatialAnchorsAccountsListBySubscription ...

func (ProxyClient) SpatialAnchorsAccountsListBySubscriptionComplete

func (c ProxyClient) SpatialAnchorsAccountsListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (SpatialAnchorsAccountsListBySubscriptionCompleteResult, error)

SpatialAnchorsAccountsListBySubscriptionComplete retrieves all of the results into a single object

func (ProxyClient) SpatialAnchorsAccountsListBySubscriptionCompleteMatchingPredicate

func (c ProxyClient) SpatialAnchorsAccountsListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate SpatialAnchorsAccountOperationPredicate) (resp SpatialAnchorsAccountsListBySubscriptionCompleteResult, err error)

SpatialAnchorsAccountsListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type RemoteRenderingAccount

type RemoteRenderingAccount struct {
	Id         *string                        `json:"id,omitempty"`
	Identity   *identity.SystemAssigned       `json:"identity,omitempty"`
	Kind       *Sku                           `json:"kind,omitempty"`
	Location   string                         `json:"location"`
	Name       *string                        `json:"name,omitempty"`
	Plan       *identity.SystemAssigned       `json:"plan,omitempty"`
	Properties *MixedRealityAccountProperties `json:"properties,omitempty"`
	Sku        *Sku                           `json:"sku,omitempty"`
	SystemData *systemdata.SystemData         `json:"systemData,omitempty"`
	Tags       *map[string]string             `json:"tags,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type RemoteRenderingAccountOperationPredicate

type RemoteRenderingAccountOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (RemoteRenderingAccountOperationPredicate) Matches

type RemoteRenderingAccountsListBySubscriptionCompleteResult

type RemoteRenderingAccountsListBySubscriptionCompleteResult struct {
	Items []RemoteRenderingAccount
}

type RemoteRenderingAccountsListBySubscriptionOperationResponse

type RemoteRenderingAccountsListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]RemoteRenderingAccount
	// contains filtered or unexported fields
}

func (RemoteRenderingAccountsListBySubscriptionOperationResponse) HasMore

func (RemoteRenderingAccountsListBySubscriptionOperationResponse) LoadMore

type Sku

type Sku struct {
	Capacity *int64   `json:"capacity,omitempty"`
	Family   *string  `json:"family,omitempty"`
	Name     string   `json:"name"`
	Size     *string  `json:"size,omitempty"`
	Tier     *SkuTier `json:"tier,omitempty"`
}

type SkuTier

type SkuTier string
const (
	SkuTierBasic    SkuTier = "Basic"
	SkuTierFree     SkuTier = "Free"
	SkuTierPremium  SkuTier = "Premium"
	SkuTierStandard SkuTier = "Standard"
)

type SpatialAnchorsAccount

type SpatialAnchorsAccount struct {
	Id         *string                        `json:"id,omitempty"`
	Identity   *identity.SystemAssigned       `json:"identity,omitempty"`
	Kind       *Sku                           `json:"kind,omitempty"`
	Location   string                         `json:"location"`
	Name       *string                        `json:"name,omitempty"`
	Plan       *identity.SystemAssigned       `json:"plan,omitempty"`
	Properties *MixedRealityAccountProperties `json:"properties,omitempty"`
	Sku        *Sku                           `json:"sku,omitempty"`
	SystemData *systemdata.SystemData         `json:"systemData,omitempty"`
	Tags       *map[string]string             `json:"tags,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type SpatialAnchorsAccountOperationPredicate

type SpatialAnchorsAccountOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (SpatialAnchorsAccountOperationPredicate) Matches

type SpatialAnchorsAccountsListBySubscriptionCompleteResult

type SpatialAnchorsAccountsListBySubscriptionCompleteResult struct {
	Items []SpatialAnchorsAccount
}

type SpatialAnchorsAccountsListBySubscriptionOperationResponse

type SpatialAnchorsAccountsListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]SpatialAnchorsAccount
	// contains filtered or unexported fields
}

func (SpatialAnchorsAccountsListBySubscriptionOperationResponse) HasMore

func (SpatialAnchorsAccountsListBySubscriptionOperationResponse) LoadMore

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL