videoanalyzers

package
v0.20240628.1082451 Latest Latest
Warning

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

Go to latest
Published: Jun 28, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/videoanalyzer/2021-05-01-preview/videoanalyzers Documentation

The videoanalyzers SDK allows for interaction with the Azure Resource Manager Service videoanalyzer (API Version 2021-05-01-preview).

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/videoanalyzer/2021-05-01-preview/videoanalyzers"

Client Initialization

client := videoanalyzers.NewVideoAnalyzersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VideoAnalyzersClient.LocationsCheckNameAvailability

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

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


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

Example Usage: VideoAnalyzersClient.VideoAnalyzersCreateOrUpdate

ctx := context.TODO()
id := videoanalyzers.NewVideoAnalyzerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue")

payload := videoanalyzers.VideoAnalyzer{
	// ...
}


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

Example Usage: VideoAnalyzersClient.VideoAnalyzersDelete

ctx := context.TODO()
id := videoanalyzers.NewVideoAnalyzerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue")

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

Example Usage: VideoAnalyzersClient.VideoAnalyzersGet

ctx := context.TODO()
id := videoanalyzers.NewVideoAnalyzerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue")

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

Example Usage: VideoAnalyzersClient.VideoAnalyzersList

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

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

Example Usage: VideoAnalyzersClient.VideoAnalyzersListBySubscription

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

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

Example Usage: VideoAnalyzersClient.VideoAnalyzersSyncStorageKeys

ctx := context.TODO()
id := videoanalyzers.NewVideoAnalyzerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue")

payload := videoanalyzers.SyncStorageKeysInput{
	// ...
}


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

Example Usage: VideoAnalyzersClient.VideoAnalyzersUpdate

ctx := context.TODO()
id := videoanalyzers.NewVideoAnalyzerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "videoAnalyzerValue")

payload := videoanalyzers.VideoAnalyzerUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccountEncryptionKeyType

func PossibleValuesForAccountEncryptionKeyType() []string

func PossibleValuesForCheckNameAvailabilityReason

func PossibleValuesForCheckNameAvailabilityReason() []string

func PossibleValuesForVideoAnalyzerEndpointType

func PossibleValuesForVideoAnalyzerEndpointType() []string

func ValidateLocationID

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

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

func ValidateVideoAnalyzerID

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

ValidateVideoAnalyzerID checks that 'input' can be parsed as a Video Analyzer ID

Types

type AccountEncryption

type AccountEncryption struct {
	Identity           *ResourceIdentity        `json:"identity,omitempty"`
	KeyVaultProperties *KeyVaultProperties      `json:"keyVaultProperties,omitempty"`
	Status             *string                  `json:"status,omitempty"`
	Type               AccountEncryptionKeyType `json:"type"`
}

type AccountEncryptionKeyType

type AccountEncryptionKeyType string
const (
	AccountEncryptionKeyTypeCustomerKey AccountEncryptionKeyType = "CustomerKey"
	AccountEncryptionKeyTypeSystemKey   AccountEncryptionKeyType = "SystemKey"
)

func (*AccountEncryptionKeyType) UnmarshalJSON

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

type CheckNameAvailabilityReason

type CheckNameAvailabilityReason string
const (
	CheckNameAvailabilityReasonAlreadyExists CheckNameAvailabilityReason = "AlreadyExists"
	CheckNameAvailabilityReasonInvalid       CheckNameAvailabilityReason = "Invalid"
)

func (*CheckNameAvailabilityReason) UnmarshalJSON

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

type CheckNameAvailabilityRequest

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

type CheckNameAvailabilityResponse

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

type Endpoint

type Endpoint struct {
	EndpointUrl *string                   `json:"endpointUrl,omitempty"`
	Type        VideoAnalyzerEndpointType `json:"type"`
}

type KeyVaultProperties

type KeyVaultProperties struct {
	CurrentKeyIdentifier *string `json:"currentKeyIdentifier,omitempty"`
	KeyIdentifier        string  `json:"keyIdentifier"`
}

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) FromParseResult

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

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 LocationsCheckNameAvailabilityOperationResponse

type LocationsCheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckNameAvailabilityResponse
}

type ResourceIdentity

type ResourceIdentity struct {
	UserAssignedIdentity string `json:"userAssignedIdentity"`
}

type StorageAccount

type StorageAccount struct {
	Id       *string           `json:"id,omitempty"`
	Identity *ResourceIdentity `json:"identity,omitempty"`
	Status   *string           `json:"status,omitempty"`
}

type SyncStorageKeysInput

type SyncStorageKeysInput struct {
	Id *string `json:"id,omitempty"`
}

type UserAssignedManagedIdentity

type UserAssignedManagedIdentity struct {
	ClientId    *string `json:"clientId,omitempty"`
	PrincipalId *string `json:"principalId,omitempty"`
}

type VideoAnalyzer

type VideoAnalyzer struct {
	Id         *string                        `json:"id,omitempty"`
	Identity   *VideoAnalyzerIdentity         `json:"identity,omitempty"`
	Location   string                         `json:"location"`
	Name       *string                        `json:"name,omitempty"`
	Properties *VideoAnalyzerPropertiesUpdate `json:"properties,omitempty"`
	SystemData *systemdata.SystemData         `json:"systemData,omitempty"`
	Tags       *map[string]string             `json:"tags,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type VideoAnalyzerCollection

type VideoAnalyzerCollection struct {
	Value *[]VideoAnalyzer `json:"value,omitempty"`
}

type VideoAnalyzerEndpointType

type VideoAnalyzerEndpointType string
const (
	VideoAnalyzerEndpointTypeClientApi VideoAnalyzerEndpointType = "ClientApi"
)

func (*VideoAnalyzerEndpointType) UnmarshalJSON

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

type VideoAnalyzerId

type VideoAnalyzerId struct {
	SubscriptionId    string
	ResourceGroupName string
	VideoAnalyzerName string
}

VideoAnalyzerId is a struct representing the Resource ID for a Video Analyzer

func NewVideoAnalyzerID

func NewVideoAnalyzerID(subscriptionId string, resourceGroupName string, videoAnalyzerName string) VideoAnalyzerId

NewVideoAnalyzerID returns a new VideoAnalyzerId struct

func ParseVideoAnalyzerID

func ParseVideoAnalyzerID(input string) (*VideoAnalyzerId, error)

ParseVideoAnalyzerID parses 'input' into a VideoAnalyzerId

func ParseVideoAnalyzerIDInsensitively

func ParseVideoAnalyzerIDInsensitively(input string) (*VideoAnalyzerId, error)

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

func (*VideoAnalyzerId) FromParseResult

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

func (VideoAnalyzerId) ID

func (id VideoAnalyzerId) ID() string

ID returns the formatted Video Analyzer ID

func (VideoAnalyzerId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Video Analyzer ID

func (VideoAnalyzerId) String

func (id VideoAnalyzerId) String() string

String returns a human-readable description of this Video Analyzer ID

type VideoAnalyzerIdentity

type VideoAnalyzerIdentity struct {
	Type                   string                                  `json:"type"`
	UserAssignedIdentities *map[string]UserAssignedManagedIdentity `json:"userAssignedIdentities,omitempty"`
}

type VideoAnalyzerPropertiesUpdate

type VideoAnalyzerPropertiesUpdate struct {
	Encryption      *AccountEncryption `json:"encryption,omitempty"`
	Endpoints       *[]Endpoint        `json:"endpoints,omitempty"`
	StorageAccounts *[]StorageAccount  `json:"storageAccounts,omitempty"`
}

type VideoAnalyzerUpdate

type VideoAnalyzerUpdate struct {
	Identity   *VideoAnalyzerIdentity         `json:"identity,omitempty"`
	Properties *VideoAnalyzerPropertiesUpdate `json:"properties,omitempty"`
	Tags       *map[string]string             `json:"tags,omitempty"`
}

type VideoAnalyzersClient

type VideoAnalyzersClient struct {
	Client *resourcemanager.Client
}

func NewVideoAnalyzersClientWithBaseURI

func NewVideoAnalyzersClientWithBaseURI(sdkApi sdkEnv.Api) (*VideoAnalyzersClient, error)

func (VideoAnalyzersClient) LocationsCheckNameAvailability

LocationsCheckNameAvailability ...

func (VideoAnalyzersClient) VideoAnalyzersCreateOrUpdate

func (c VideoAnalyzersClient) VideoAnalyzersCreateOrUpdate(ctx context.Context, id VideoAnalyzerId, input VideoAnalyzer) (result VideoAnalyzersCreateOrUpdateOperationResponse, err error)

VideoAnalyzersCreateOrUpdate ...

func (VideoAnalyzersClient) VideoAnalyzersDelete

VideoAnalyzersDelete ...

func (VideoAnalyzersClient) VideoAnalyzersGet

VideoAnalyzersGet ...

func (VideoAnalyzersClient) VideoAnalyzersList

VideoAnalyzersList ...

func (VideoAnalyzersClient) VideoAnalyzersListBySubscription

VideoAnalyzersListBySubscription ...

func (VideoAnalyzersClient) VideoAnalyzersSyncStorageKeys

VideoAnalyzersSyncStorageKeys ...

func (VideoAnalyzersClient) VideoAnalyzersUpdate

VideoAnalyzersUpdate ...

type VideoAnalyzersCreateOrUpdateOperationResponse

type VideoAnalyzersCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VideoAnalyzer
}

type VideoAnalyzersDeleteOperationResponse

type VideoAnalyzersDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type VideoAnalyzersGetOperationResponse

type VideoAnalyzersGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VideoAnalyzer
}

type VideoAnalyzersListBySubscriptionOperationResponse

type VideoAnalyzersListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VideoAnalyzerCollection
}

type VideoAnalyzersListOperationResponse

type VideoAnalyzersListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VideoAnalyzerCollection
}

type VideoAnalyzersSyncStorageKeysOperationResponse

type VideoAnalyzersSyncStorageKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type VideoAnalyzersUpdateOperationResponse

type VideoAnalyzersUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VideoAnalyzer
}

Jump to

Keyboard shortcuts

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