accesstoken

README

github.com/hashicorp/go-azure-sdk/resource-manager/videoindexer/2024-01-01/accesstoken Documentation

The accesstoken SDK allows for interaction with Azure Resource Manager videoindexer (API Version 2024-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/videoindexer/2024-01-01/accesstoken"

Client Initialization

client := accesstoken.NewAccessTokenClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AccessTokenClient.GenerateAccessToken

ctx := context.TODO()
id := accesstoken.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName")

payload := accesstoken.GenerateAccessTokenParameters{
	// ...
}


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

Example Usage: AccessTokenClient.GenerateRestrictedViewerAccessToken

ctx := context.TODO()
id := accesstoken.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName")

payload := accesstoken.GenerateRestrictedViewerAccessTokenParameters{
	// ...
}


read, err := client.GenerateRestrictedViewerAccessToken(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 PossibleValuesForPermissionType() []string
• func PossibleValuesForScope() []string
• func ValidateAccountID(input interface{}, key string) (warnings []string, errors []error)
• type AccessToken
• type AccessTokenClient
  • func NewAccessTokenClientWithBaseURI(sdkApi sdkEnv.Api) (*AccessTokenClient, error)
  • func (c AccessTokenClient) GenerateAccessToken(ctx context.Context, id AccountId, input GenerateAccessTokenParameters) (result GenerateAccessTokenOperationResponse, err error)
  • func (c AccessTokenClient) GenerateRestrictedViewerAccessToken(ctx context.Context, id AccountId, ...) (result GenerateRestrictedViewerAccessTokenOperationResponse, err error)
• type AccountId
  • func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId
  • func ParseAccountID(input string) (*AccountId, error)
  • func ParseAccountIDInsensitively(input string) (*AccountId, error)
  • func (id *AccountId) FromParseResult(input resourceids.ParseResult) error
  • func (id AccountId) ID() string
  • func (id AccountId) Segments() []resourceids.Segment
  • func (id AccountId) String() string
• type GenerateAccessTokenOperationResponse
• type GenerateAccessTokenParameters
• type GenerateRestrictedViewerAccessTokenOperationResponse
• type GenerateRestrictedViewerAccessTokenParameters
• type PermissionType
  • func (s *PermissionType) UnmarshalJSON(bytes []byte) error
• type Scope
  • func (s *Scope) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForPermissionType

func PossibleValuesForPermissionType() []string

func PossibleValuesForScope

func PossibleValuesForScope() []string

func ValidateAccountID

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

ValidateAccountID checks that 'input' can be parsed as a Account ID

Types

type AccessToken

type AccessToken struct {
	AccessToken *string `json:"accessToken,omitempty"`
}

type AccessTokenClient

type AccessTokenClient struct {
	Client *resourcemanager.Client
}

func NewAccessTokenClientWithBaseURI

func NewAccessTokenClientWithBaseURI(sdkApi sdkEnv.Api) (*AccessTokenClient, error)

func (AccessTokenClient) GenerateAccessToken

func (c AccessTokenClient) GenerateAccessToken(ctx context.Context, id AccountId, input GenerateAccessTokenParameters) (result GenerateAccessTokenOperationResponse, err error)

GenerateAccessToken ...

func (AccessTokenClient) GenerateRestrictedViewerAccessToken

func (c AccessTokenClient) GenerateRestrictedViewerAccessToken(ctx context.Context, id AccountId, input GenerateRestrictedViewerAccessTokenParameters) (result GenerateRestrictedViewerAccessTokenOperationResponse, err error)

GenerateRestrictedViewerAccessToken ...

type AccountId

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively

func ParseAccountIDInsensitively(input string) (*AccountId, error)

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

func (*AccountId) FromParseResult

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

func (AccountId) ID

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments

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

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

func (AccountId) String

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type GenerateAccessTokenOperationResponse

type GenerateAccessTokenOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccessToken
}

type GenerateAccessTokenParameters

type GenerateAccessTokenParameters struct {
	PermissionType PermissionType `json:"permissionType"`
	ProjectId      *string        `json:"projectId,omitempty"`
	Scope          Scope          `json:"scope"`
	VideoId        *string        `json:"videoId,omitempty"`
}

type GenerateRestrictedViewerAccessTokenOperationResponse

type GenerateRestrictedViewerAccessTokenOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccessToken
}

type GenerateRestrictedViewerAccessTokenParameters

type GenerateRestrictedViewerAccessTokenParameters struct {
	ProjectId *string `json:"projectId,omitempty"`
	Scope     Scope   `json:"scope"`
	VideoId   *string `json:"videoId,omitempty"`
}

type PermissionType

type PermissionType string

const (
	PermissionTypeContributor PermissionType = "Contributor"
	PermissionTypeReader      PermissionType = "Reader"
)

func (*PermissionType) UnmarshalJSON

func (s *PermissionType) UnmarshalJSON(bytes []byte) error

type Scope

type Scope string

const (
	ScopeAccount Scope = "Account"
	ScopeProject Scope = "Project"
	ScopeVideo   Scope = "Video"
)

func (*Scope) UnmarshalJSON

func (s *Scope) UnmarshalJSON(bytes []byte) error