key

README

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

The key 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/key"

Client Initialization

client := key.NewKeyClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: KeyClient.RemoteRenderingAccountsListKeys

ctx := context.TODO()
id := key.NewRemoteRenderingAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "remoteRenderingAccountValue")

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

Example Usage: KeyClient.RemoteRenderingAccountsRegenerateKeys

ctx := context.TODO()
id := key.NewRemoteRenderingAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "remoteRenderingAccountValue")

payload := key.AccountKeyRegenerateRequest{
	// ...
}


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

Example Usage: KeyClient.SpatialAnchorsAccountsListKeys

ctx := context.TODO()
id := key.NewSpatialAnchorsAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "spatialAnchorsAccountValue")

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

Example Usage: KeyClient.SpatialAnchorsAccountsRegenerateKeys

ctx := context.TODO()
id := key.NewSpatialAnchorsAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "spatialAnchorsAccountValue")

payload := key.AccountKeyRegenerateRequest{
	// ...
}


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

Documentation

Index

• func PossibleValuesForSerial() []int64
• func ValidateRemoteRenderingAccountID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateSpatialAnchorsAccountID(input interface{}, key string) (warnings []string, errors []error)
• type AccountKeyRegenerateRequest
• type AccountKeys
• type KeyClient
  • func NewKeyClientWithBaseURI(sdkApi sdkEnv.Api) (*KeyClient, error)
  • func (c KeyClient) RemoteRenderingAccountsListKeys(ctx context.Context, id RemoteRenderingAccountId) (result RemoteRenderingAccountsListKeysOperationResponse, err error)
  • func (c KeyClient) RemoteRenderingAccountsRegenerateKeys(ctx context.Context, id RemoteRenderingAccountId, ...) (result RemoteRenderingAccountsRegenerateKeysOperationResponse, err error)
  • func (c KeyClient) SpatialAnchorsAccountsListKeys(ctx context.Context, id SpatialAnchorsAccountId) (result SpatialAnchorsAccountsListKeysOperationResponse, err error)
  • func (c KeyClient) SpatialAnchorsAccountsRegenerateKeys(ctx context.Context, id SpatialAnchorsAccountId, ...) (result SpatialAnchorsAccountsRegenerateKeysOperationResponse, err error)
• type RemoteRenderingAccountId
  • func NewRemoteRenderingAccountID(subscriptionId string, resourceGroupName string, ...) RemoteRenderingAccountId
  • func ParseRemoteRenderingAccountID(input string) (*RemoteRenderingAccountId, error)
  • func ParseRemoteRenderingAccountIDInsensitively(input string) (*RemoteRenderingAccountId, error)
  • func (id *RemoteRenderingAccountId) FromParseResult(input resourceids.ParseResult) error
  • func (id RemoteRenderingAccountId) ID() string
  • func (id RemoteRenderingAccountId) Segments() []resourceids.Segment
  • func (id RemoteRenderingAccountId) String() string
• type RemoteRenderingAccountsListKeysOperationResponse
• type RemoteRenderingAccountsRegenerateKeysOperationResponse
• type Serial
• type SpatialAnchorsAccountId
  • func NewSpatialAnchorsAccountID(subscriptionId string, resourceGroupName string, ...) SpatialAnchorsAccountId
  • func ParseSpatialAnchorsAccountID(input string) (*SpatialAnchorsAccountId, error)
  • func ParseSpatialAnchorsAccountIDInsensitively(input string) (*SpatialAnchorsAccountId, error)
  • func (id *SpatialAnchorsAccountId) FromParseResult(input resourceids.ParseResult) error
  • func (id SpatialAnchorsAccountId) ID() string
  • func (id SpatialAnchorsAccountId) Segments() []resourceids.Segment
  • func (id SpatialAnchorsAccountId) String() string
• type SpatialAnchorsAccountsListKeysOperationResponse
• type SpatialAnchorsAccountsRegenerateKeysOperationResponse

Functions

func PossibleValuesForSerial

func PossibleValuesForSerial() []int64

func ValidateRemoteRenderingAccountID

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

ValidateRemoteRenderingAccountID checks that 'input' can be parsed as a Remote Rendering Account ID

func ValidateSpatialAnchorsAccountID

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

ValidateSpatialAnchorsAccountID checks that 'input' can be parsed as a Spatial Anchors Account ID

Types

type AccountKeyRegenerateRequest

type AccountKeyRegenerateRequest struct {
	Serial *Serial `json:"serial,omitempty"`
}

type AccountKeys

type AccountKeys struct {
	PrimaryKey   *string `json:"primaryKey,omitempty"`
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

type KeyClient

type KeyClient struct {
	Client *resourcemanager.Client
}

func NewKeyClientWithBaseURI

func NewKeyClientWithBaseURI(sdkApi sdkEnv.Api) (*KeyClient, error)

func (KeyClient) RemoteRenderingAccountsListKeys

func (c KeyClient) RemoteRenderingAccountsListKeys(ctx context.Context, id RemoteRenderingAccountId) (result RemoteRenderingAccountsListKeysOperationResponse, err error)

RemoteRenderingAccountsListKeys ...

func (KeyClient) RemoteRenderingAccountsRegenerateKeys

func (c KeyClient) RemoteRenderingAccountsRegenerateKeys(ctx context.Context, id RemoteRenderingAccountId, input AccountKeyRegenerateRequest) (result RemoteRenderingAccountsRegenerateKeysOperationResponse, err error)

RemoteRenderingAccountsRegenerateKeys ...

func (KeyClient) SpatialAnchorsAccountsListKeys

func (c KeyClient) SpatialAnchorsAccountsListKeys(ctx context.Context, id SpatialAnchorsAccountId) (result SpatialAnchorsAccountsListKeysOperationResponse, err error)

SpatialAnchorsAccountsListKeys ...

func (KeyClient) SpatialAnchorsAccountsRegenerateKeys

func (c KeyClient) SpatialAnchorsAccountsRegenerateKeys(ctx context.Context, id SpatialAnchorsAccountId, input AccountKeyRegenerateRequest) (result SpatialAnchorsAccountsRegenerateKeysOperationResponse, err error)

SpatialAnchorsAccountsRegenerateKeys ...

type RemoteRenderingAccountId

type RemoteRenderingAccountId struct {
	SubscriptionId             string
	ResourceGroupName          string
	RemoteRenderingAccountName string
}

RemoteRenderingAccountId is a struct representing the Resource ID for a Remote Rendering Account

func NewRemoteRenderingAccountID

func NewRemoteRenderingAccountID(subscriptionId string, resourceGroupName string, remoteRenderingAccountName string) RemoteRenderingAccountId

NewRemoteRenderingAccountID returns a new RemoteRenderingAccountId struct

func ParseRemoteRenderingAccountID

func ParseRemoteRenderingAccountID(input string) (*RemoteRenderingAccountId, error)

ParseRemoteRenderingAccountID parses 'input' into a RemoteRenderingAccountId

func ParseRemoteRenderingAccountIDInsensitively

func ParseRemoteRenderingAccountIDInsensitively(input string) (*RemoteRenderingAccountId, error)

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

func (*RemoteRenderingAccountId) FromParseResult

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

func (RemoteRenderingAccountId) ID

func (id RemoteRenderingAccountId) ID() string

ID returns the formatted Remote Rendering Account ID

func (RemoteRenderingAccountId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Remote Rendering Account ID

func (RemoteRenderingAccountId) String

func (id RemoteRenderingAccountId) String() string

String returns a human-readable description of this Remote Rendering Account ID

type RemoteRenderingAccountsListKeysOperationResponse

type RemoteRenderingAccountsListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccountKeys
}

type RemoteRenderingAccountsRegenerateKeysOperationResponse

type RemoteRenderingAccountsRegenerateKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccountKeys
}

type Serial

type Serial int64

const (
	SerialPrimary   Serial = 1
	SerialSecondary Serial = 2
)

type SpatialAnchorsAccountId

type SpatialAnchorsAccountId struct {
	SubscriptionId            string
	ResourceGroupName         string
	SpatialAnchorsAccountName string
}

SpatialAnchorsAccountId is a struct representing the Resource ID for a Spatial Anchors Account

func NewSpatialAnchorsAccountID

func NewSpatialAnchorsAccountID(subscriptionId string, resourceGroupName string, spatialAnchorsAccountName string) SpatialAnchorsAccountId

NewSpatialAnchorsAccountID returns a new SpatialAnchorsAccountId struct

func ParseSpatialAnchorsAccountID

func ParseSpatialAnchorsAccountID(input string) (*SpatialAnchorsAccountId, error)

ParseSpatialAnchorsAccountID parses 'input' into a SpatialAnchorsAccountId

func ParseSpatialAnchorsAccountIDInsensitively

func ParseSpatialAnchorsAccountIDInsensitively(input string) (*SpatialAnchorsAccountId, error)

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

func (*SpatialAnchorsAccountId) FromParseResult

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

func (SpatialAnchorsAccountId) ID

func (id SpatialAnchorsAccountId) ID() string

ID returns the formatted Spatial Anchors Account ID

func (SpatialAnchorsAccountId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Spatial Anchors Account ID

func (SpatialAnchorsAccountId) String

func (id SpatialAnchorsAccountId) String() string

String returns a human-readable description of this Spatial Anchors Account ID

type SpatialAnchorsAccountsListKeysOperationResponse

type SpatialAnchorsAccountsListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccountKeys
}

type SpatialAnchorsAccountsRegenerateKeysOperationResponse

type SpatialAnchorsAccountsRegenerateKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccountKeys
}