key

README

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

The key SDK allows for interaction with Azure Resource Manager mixedreality (API Version 2025-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/2025-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", "remoteRenderingAccountName")

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", "remoteRenderingAccountName")

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
}

Documentation

Index

• func PossibleValuesForSerial() []int64
• func ValidateRemoteRenderingAccountID(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)
• 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

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

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 ...

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
)