armvideoanalyzer

package module
v0.4.2 Latest Latest
Warning

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

Go to latest
Published: May 13, 2022 License: MIT Imports: 16 Imported by: 1

README

Azure Video Analyzer Module for Go

PkgGoDev

The armvideoanalyzer module provides operations for working with Azure Video Analyzer.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Video Analyzer module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Video Analyzer. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Video Analyzer modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armvideoanalyzer.NewVideoAnalyzersClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
client, err := armvideoanalyzer.NewVideoAnalyzersClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Video Analyzer label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPoliciesClient

type AccessPoliciesClient struct {
	// contains filtered or unexported fields
}

AccessPoliciesClient contains the methods for the AccessPolicies group. Don't use this type directly, use NewAccessPoliciesClient() instead.

func NewAccessPoliciesClient

func NewAccessPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AccessPoliciesClient, error)

NewAccessPoliciesClient creates a new instance of AccessPoliciesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AccessPoliciesClient) CreateOrUpdate

func (client *AccessPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string, parameters AccessPolicyEntity, options *AccessPoliciesClientCreateOrUpdateOptions) (AccessPoliciesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new access policy resource or updates an existing one with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. accessPolicyName - The Access Policy name. parameters - The request parameters options - AccessPoliciesClientCreateOrUpdateOptions contains the optional parameters for the AccessPoliciesClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/access-policy-create.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewAccessPoliciesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<access-policy-name>",
		armvideoanalyzer.AccessPolicyEntity{
			Properties: &armvideoanalyzer.AccessPolicyProperties{
				Authentication: &armvideoanalyzer.JwtAuthentication{
					Type: to.Ptr("<type>"),
					Audiences: []*string{
						to.Ptr("audience1")},
					Claims: []*armvideoanalyzer.TokenClaim{
						{
							Name:  to.Ptr("<name>"),
							Value: to.Ptr("<value>"),
						},
						{
							Name:  to.Ptr("<name>"),
							Value: to.Ptr("<value>"),
						}},
					Issuers: []*string{
						to.Ptr("issuer1"),
						to.Ptr("issuer2")},
					Keys: []armvideoanalyzer.TokenKeyClassification{
						&armvideoanalyzer.RsaTokenKey{
							Type: to.Ptr("<type>"),
							Kid:  to.Ptr("<kid>"),
							Alg:  to.Ptr(armvideoanalyzer.AccessPolicyRsaAlgoRS256),
							E:    to.Ptr("<e>"),
							N:    to.Ptr("<n>"),
						},
						&armvideoanalyzer.EccTokenKey{
							Type: to.Ptr("<type>"),
							Kid:  to.Ptr("<kid>"),
							Alg:  to.Ptr(armvideoanalyzer.AccessPolicyEccAlgoES256),
							X:    to.Ptr("<x>"),
							Y:    to.Ptr("<y>"),
						}},
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*AccessPoliciesClient) Delete

func (client *AccessPoliciesClient) Delete(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string, options *AccessPoliciesClientDeleteOptions) (AccessPoliciesClientDeleteResponse, error)

Delete - Deletes an existing access policy resource with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. accessPolicyName - The Access Policy name. options - AccessPoliciesClientDeleteOptions contains the optional parameters for the AccessPoliciesClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/access-policy-delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewAccessPoliciesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<access-policy-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*AccessPoliciesClient) Get

func (client *AccessPoliciesClient) Get(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string, options *AccessPoliciesClientGetOptions) (AccessPoliciesClientGetResponse, error)

Get - Retrieves an existing access policy resource with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. accessPolicyName - The Access Policy name. options - AccessPoliciesClientGetOptions contains the optional parameters for the AccessPoliciesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/access-policy-get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewAccessPoliciesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<access-policy-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*AccessPoliciesClient) NewListPager added in v0.4.0

func (client *AccessPoliciesClient) NewListPager(resourceGroupName string, accountName string, options *AccessPoliciesClientListOptions) *runtime.Pager[AccessPoliciesClientListResponse]

NewListPager - Retrieves all existing access policy resources, along with their JSON representations. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. options - AccessPoliciesClientListOptions contains the optional parameters for the AccessPoliciesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/access-policy-list.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewAccessPoliciesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("<resource-group-name>",
		"<account-name>",
		&armvideoanalyzer.AccessPoliciesClientListOptions{Top: to.Ptr[int32](2)})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*AccessPoliciesClient) Update

func (client *AccessPoliciesClient) Update(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string, parameters AccessPolicyEntity, options *AccessPoliciesClientUpdateOptions) (AccessPoliciesClientUpdateResponse, error)

Update - Updates individual properties of an existing access policy resource with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. accessPolicyName - The Access Policy name. parameters - The request parameters options - AccessPoliciesClientUpdateOptions contains the optional parameters for the AccessPoliciesClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/access-policy-patch.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewAccessPoliciesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<access-policy-name>",
		armvideoanalyzer.AccessPolicyEntity{
			Properties: &armvideoanalyzer.AccessPolicyProperties{
				Authentication: &armvideoanalyzer.JwtAuthentication{
					Type: to.Ptr("<type>"),
					Audiences: []*string{
						to.Ptr("audience1")},
					Claims: []*armvideoanalyzer.TokenClaim{
						{
							Name:  to.Ptr("<name>"),
							Value: to.Ptr("<value>"),
						},
						{
							Name:  to.Ptr("<name>"),
							Value: to.Ptr("<value>"),
						}},
					Issuers: []*string{
						to.Ptr("issuer1"),
						to.Ptr("issuer2")},
					Keys: []armvideoanalyzer.TokenKeyClassification{
						&armvideoanalyzer.RsaTokenKey{
							Type: to.Ptr("<type>"),
							Kid:  to.Ptr("<kid>"),
							Alg:  to.Ptr(armvideoanalyzer.AccessPolicyRsaAlgoRS256),
							E:    to.Ptr("<e>"),
							N:    to.Ptr("<n>"),
						},
						&armvideoanalyzer.EccTokenKey{
							Type: to.Ptr("<type>"),
							Kid:  to.Ptr("<kid>"),
							Alg:  to.Ptr(armvideoanalyzer.AccessPolicyEccAlgoES256),
							X:    to.Ptr("<x>"),
							Y:    to.Ptr("<y>"),
						}},
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type AccessPoliciesClientCreateOrUpdateOptions added in v0.2.0

type AccessPoliciesClientCreateOrUpdateOptions struct {
}

AccessPoliciesClientCreateOrUpdateOptions contains the optional parameters for the AccessPoliciesClient.CreateOrUpdate method.

type AccessPoliciesClientCreateOrUpdateResponse added in v0.2.0

type AccessPoliciesClientCreateOrUpdateResponse struct {
	AccessPolicyEntity
}

AccessPoliciesClientCreateOrUpdateResponse contains the response from method AccessPoliciesClient.CreateOrUpdate.

type AccessPoliciesClientDeleteOptions added in v0.2.0

type AccessPoliciesClientDeleteOptions struct {
}

AccessPoliciesClientDeleteOptions contains the optional parameters for the AccessPoliciesClient.Delete method.

type AccessPoliciesClientDeleteResponse added in v0.2.0

type AccessPoliciesClientDeleteResponse struct {
}

AccessPoliciesClientDeleteResponse contains the response from method AccessPoliciesClient.Delete.

type AccessPoliciesClientGetOptions added in v0.2.0

type AccessPoliciesClientGetOptions struct {
}

AccessPoliciesClientGetOptions contains the optional parameters for the AccessPoliciesClient.Get method.

type AccessPoliciesClientGetResponse added in v0.2.0

type AccessPoliciesClientGetResponse struct {
	AccessPolicyEntity
}

AccessPoliciesClientGetResponse contains the response from method AccessPoliciesClient.Get.

type AccessPoliciesClientListOptions added in v0.2.0

type AccessPoliciesClientListOptions struct {
	// Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the
	// number of available items up to but not greater than the specified value n.
	Top *int32
}

AccessPoliciesClientListOptions contains the optional parameters for the AccessPoliciesClient.List method.

type AccessPoliciesClientListResponse added in v0.2.0

type AccessPoliciesClientListResponse struct {
	AccessPolicyEntityCollection
}

AccessPoliciesClientListResponse contains the response from method AccessPoliciesClient.List.

type AccessPoliciesClientUpdateOptions added in v0.2.0

type AccessPoliciesClientUpdateOptions struct {
}

AccessPoliciesClientUpdateOptions contains the optional parameters for the AccessPoliciesClient.Update method.

type AccessPoliciesClientUpdateResponse added in v0.2.0

type AccessPoliciesClientUpdateResponse struct {
	AccessPolicyEntity
}

AccessPoliciesClientUpdateResponse contains the response from method AccessPoliciesClient.Update.

type AccessPolicyEccAlgo

type AccessPolicyEccAlgo string

AccessPolicyEccAlgo - Elliptical curve algorithm to be used: ES256, ES384 or ES512.

const (
	// AccessPolicyEccAlgoES256 - ES265
	AccessPolicyEccAlgoES256 AccessPolicyEccAlgo = "ES256"
	// AccessPolicyEccAlgoES384 - ES384
	AccessPolicyEccAlgoES384 AccessPolicyEccAlgo = "ES384"
	// AccessPolicyEccAlgoES512 - ES512
	AccessPolicyEccAlgoES512 AccessPolicyEccAlgo = "ES512"
)

func PossibleAccessPolicyEccAlgoValues

func PossibleAccessPolicyEccAlgoValues() []AccessPolicyEccAlgo

PossibleAccessPolicyEccAlgoValues returns the possible values for the AccessPolicyEccAlgo const type.

type AccessPolicyEntity

type AccessPolicyEntity struct {
	// The resource properties.
	Properties *AccessPolicyProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

AccessPolicyEntity - Access policies help define the authentication rules, and control access to specific video resources.

func (AccessPolicyEntity) MarshalJSON

func (a AccessPolicyEntity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessPolicyEntity.

type AccessPolicyEntityCollection

type AccessPolicyEntityCollection struct {
	// A link to the next page of the collection (when the collection contains too many results to return in one response).
	NextLink *string `json:"@nextLink,omitempty"`

	// A collection of AccessPolicyEntity items.
	Value []*AccessPolicyEntity `json:"value,omitempty"`
}

AccessPolicyEntityCollection - A collection of AccessPolicyEntity items.

func (AccessPolicyEntityCollection) MarshalJSON

func (a AccessPolicyEntityCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessPolicyEntityCollection.

type AccessPolicyProperties

type AccessPolicyProperties struct {
	// Authentication method to be used when validating client API access.
	Authentication AuthenticationBaseClassification `json:"authentication,omitempty"`

	// Defines the access level granted by this policy.
	Role *AccessPolicyRole `json:"role,omitempty"`
}

AccessPolicyProperties - Application level properties for the access policy resource.

func (AccessPolicyProperties) MarshalJSON

func (a AccessPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessPolicyProperties.

func (*AccessPolicyProperties) UnmarshalJSON

func (a *AccessPolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccessPolicyProperties.

type AccessPolicyRole

type AccessPolicyRole string

AccessPolicyRole - Defines the access level granted by this policy.

const (
	// AccessPolicyRoleReader - Reader role allows for read-only operations to be performed through the client APIs.
	AccessPolicyRoleReader AccessPolicyRole = "Reader"
)

func PossibleAccessPolicyRoleValues

func PossibleAccessPolicyRoleValues() []AccessPolicyRole

PossibleAccessPolicyRoleValues returns the possible values for the AccessPolicyRole const type.

type AccessPolicyRsaAlgo

type AccessPolicyRsaAlgo string

AccessPolicyRsaAlgo - RSA algorithm to be used: RS256, RS384 or RS512.

const (
	// AccessPolicyRsaAlgoRS256 - RS256
	AccessPolicyRsaAlgoRS256 AccessPolicyRsaAlgo = "RS256"
	// AccessPolicyRsaAlgoRS384 - RS384
	AccessPolicyRsaAlgoRS384 AccessPolicyRsaAlgo = "RS384"
	// AccessPolicyRsaAlgoRS512 - RS512
	AccessPolicyRsaAlgoRS512 AccessPolicyRsaAlgo = "RS512"
)

func PossibleAccessPolicyRsaAlgoValues

func PossibleAccessPolicyRsaAlgoValues() []AccessPolicyRsaAlgo

PossibleAccessPolicyRsaAlgoValues returns the possible values for the AccessPolicyRsaAlgo const type.

type AccountEncryption

type AccountEncryption struct {
	// REQUIRED; The type of key used to encrypt the Account Key.
	Type *AccountEncryptionKeyType `json:"type,omitempty"`

	// The Key Vault identity.
	Identity *ResourceIdentity `json:"identity,omitempty"`

	// The properties of the key used to encrypt the account.
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`

	// READ-ONLY; The current status of the Key Vault mapping.
	Status *string `json:"status,omitempty" azure:"ro"`
}

AccountEncryption - Defines how the Video Analyzer account is (optionally) encrypted.

type AccountEncryptionKeyType

type AccountEncryptionKeyType string

AccountEncryptionKeyType - The type of key used to encrypt the Account Key.

const (
	// AccountEncryptionKeyTypeCustomerKey - The Account Key is encrypted with a Customer Key.
	AccountEncryptionKeyTypeCustomerKey AccountEncryptionKeyType = "CustomerKey"
	// AccountEncryptionKeyTypeSystemKey - The Account Key is encrypted with a System Key.
	AccountEncryptionKeyTypeSystemKey AccountEncryptionKeyType = "SystemKey"
)

func PossibleAccountEncryptionKeyTypeValues

func PossibleAccountEncryptionKeyTypeValues() []AccountEncryptionKeyType

PossibleAccountEncryptionKeyTypeValues returns the possible values for the AccountEncryptionKeyType const type.

type ActionType

type ActionType string

ActionType - Indicates the action type.

const (
	// ActionTypeInternal - An internal action.
	ActionTypeInternal ActionType = "Internal"
)

func PossibleActionTypeValues

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns the possible values for the ActionType const type.

type AudioEncoderAac

type AudioEncoderAac struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// Bitrate, in kilobits per second or Kbps, at which audio should be encoded (2-channel stereo audio at a sampling rate of
	// 48 kHz). Allowed values are 96, 112, 128, 160, 192, 224, and 256. If omitted,
	// the bitrate of the input audio is used.
	BitrateKbps *string `json:"bitrateKbps,omitempty"`
}

AudioEncoderAac - A custom preset for encoding audio with the AAC codec.

func (*AudioEncoderAac) GetAudioEncoderBase added in v0.2.0

func (a *AudioEncoderAac) GetAudioEncoderBase() *AudioEncoderBase

GetAudioEncoderBase implements the AudioEncoderBaseClassification interface for type AudioEncoderAac.

func (AudioEncoderAac) MarshalJSON

func (a AudioEncoderAac) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AudioEncoderAac.

func (*AudioEncoderAac) UnmarshalJSON added in v0.2.0

func (a *AudioEncoderAac) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AudioEncoderAac.

type AudioEncoderBase

type AudioEncoderBase struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// Bitrate, in kilobits per second or Kbps, at which audio should be encoded (2-channel stereo audio at a sampling rate of
	// 48 kHz). Allowed values are 96, 112, 128, 160, 192, 224, and 256. If omitted,
	// the bitrate of the input audio is used.
	BitrateKbps *string `json:"bitrateKbps,omitempty"`
}

AudioEncoderBase - Base type for all audio encoder presets, which define the recipe or instructions on how audio should be processed.

func (*AudioEncoderBase) GetAudioEncoderBase

func (a *AudioEncoderBase) GetAudioEncoderBase() *AudioEncoderBase

GetAudioEncoderBase implements the AudioEncoderBaseClassification interface for type AudioEncoderBase.

type AudioEncoderBaseClassification

type AudioEncoderBaseClassification interface {
	// GetAudioEncoderBase returns the AudioEncoderBase content of the underlying type.
	GetAudioEncoderBase() *AudioEncoderBase
}

AudioEncoderBaseClassification provides polymorphic access to related types. Call the interface's GetAudioEncoderBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AudioEncoderAac, *AudioEncoderBase

type AuthenticationBase

type AuthenticationBase struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

AuthenticationBase - Base class for access policies authentication methods.

func (*AuthenticationBase) GetAuthenticationBase

func (a *AuthenticationBase) GetAuthenticationBase() *AuthenticationBase

GetAuthenticationBase implements the AuthenticationBaseClassification interface for type AuthenticationBase.

type AuthenticationBaseClassification

type AuthenticationBaseClassification interface {
	// GetAuthenticationBase returns the AuthenticationBase content of the underlying type.
	GetAuthenticationBase() *AuthenticationBase
}

AuthenticationBaseClassification provides polymorphic access to related types. Call the interface's GetAuthenticationBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AuthenticationBase, *JwtAuthentication

type CertificateSource

type CertificateSource struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

CertificateSource - Base class for certificate sources.

func (*CertificateSource) GetCertificateSource

func (c *CertificateSource) GetCertificateSource() *CertificateSource

GetCertificateSource implements the CertificateSourceClassification interface for type CertificateSource.

type CertificateSourceClassification

type CertificateSourceClassification interface {
	// GetCertificateSource returns the CertificateSource content of the underlying type.
	GetCertificateSource() *CertificateSource
}

CertificateSourceClassification provides polymorphic access to related types. Call the interface's GetCertificateSource() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CertificateSource, *PemCertificateList

type CheckNameAvailabilityReason

type CheckNameAvailabilityReason string

CheckNameAvailabilityReason - The reason why the given name is not available.

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

func PossibleCheckNameAvailabilityReasonValues

func PossibleCheckNameAvailabilityReasonValues() []CheckNameAvailabilityReason

PossibleCheckNameAvailabilityReasonValues returns the possible values for the CheckNameAvailabilityReason const type.

type CheckNameAvailabilityRequest

type CheckNameAvailabilityRequest struct {
	// The name of the resource for which availability needs to be checked.
	Name *string `json:"name,omitempty"`

	// The resource type.
	Type *string `json:"type,omitempty"`
}

CheckNameAvailabilityRequest - The check availability request body.

type CheckNameAvailabilityResponse

type CheckNameAvailabilityResponse struct {
	// Detailed reason why the given name is available.
	Message *string `json:"message,omitempty"`

	// Indicates if the resource name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`

	// The reason why the given name is not available.
	Reason *CheckNameAvailabilityReason `json:"reason,omitempty"`
}

CheckNameAvailabilityResponse - The check availability result.

type Collection added in v0.2.0

type Collection struct {
	// A collection of VideoAnalyzer items.
	Value []*VideoAnalyzer `json:"value,omitempty"`
}

Collection - A collection of VideoAnalyzer items.

func (Collection) MarshalJSON added in v0.2.0

func (c Collection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Collection.

type CreatedByType

type CreatedByType string

CreatedByType - The type of identity that created the resource.

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type CredentialsBase

type CredentialsBase struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

CredentialsBase - Base class for credential objects.

func (*CredentialsBase) GetCredentialsBase

func (c *CredentialsBase) GetCredentialsBase() *CredentialsBase

GetCredentialsBase implements the CredentialsBaseClassification interface for type CredentialsBase.

type CredentialsBaseClassification

type CredentialsBaseClassification interface {
	// GetCredentialsBase returns the CredentialsBase content of the underlying type.
	GetCredentialsBase() *CredentialsBase
}

CredentialsBaseClassification provides polymorphic access to related types. Call the interface's GetCredentialsBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CredentialsBase, *UsernamePasswordCredentials

type EccTokenKey

type EccTokenKey struct {
	// REQUIRED; Elliptical curve algorithm to be used: ES256, ES384 or ES512.
	Alg *AccessPolicyEccAlgo `json:"alg,omitempty"`

	// REQUIRED; JWT token key id. Validation keys are looked up based on the key id present on the JWT token header.
	Kid *string `json:"kid,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// REQUIRED; X coordinate.
	X *string `json:"x,omitempty"`

	// REQUIRED; Y coordinate.
	Y *string `json:"y,omitempty"`
}

EccTokenKey - Required validation properties for tokens generated with Elliptical Curve algorithm.

func (*EccTokenKey) GetTokenKey added in v0.2.0

func (e *EccTokenKey) GetTokenKey() *TokenKey

GetTokenKey implements the TokenKeyClassification interface for type EccTokenKey.

func (EccTokenKey) MarshalJSON

func (e EccTokenKey) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EccTokenKey.

func (*EccTokenKey) UnmarshalJSON

func (e *EccTokenKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EccTokenKey.

type EdgeModuleEntity

type EdgeModuleEntity struct {
	// The resource properties.
	Properties *EdgeModuleProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

EdgeModuleEntity - The representation of an edge module.

type EdgeModuleEntityCollection

type EdgeModuleEntityCollection struct {
	// A link to the next page of the collection (when the collection contains too many results to return in one response).
	NextLink *string `json:"@nextLink,omitempty"`

	// A collection of EdgeModuleEntity items.
	Value []*EdgeModuleEntity `json:"value,omitempty"`
}

EdgeModuleEntityCollection - A collection of EdgeModuleEntity items.

func (EdgeModuleEntityCollection) MarshalJSON

func (e EdgeModuleEntityCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EdgeModuleEntityCollection.

type EdgeModuleProperties

type EdgeModuleProperties struct {
	// READ-ONLY; Internal ID generated for the instance of the Video Analyzer edge module.
	EdgeModuleID *string `json:"edgeModuleId,omitempty" azure:"ro"`
}

EdgeModuleProperties - Application level properties for the edge module resource.

type EdgeModuleProvisioningToken

type EdgeModuleProvisioningToken struct {
	// READ-ONLY; The expiration date of the registration token. The Azure Video Analyzer IoT edge module must be initialized
	// and connected to the Internet prior to the token expiration date.
	ExpirationDate *time.Time `json:"expirationDate,omitempty" azure:"ro"`

	// READ-ONLY; The token blob to be provided to the Azure Video Analyzer IoT edge module through the Azure IoT Edge module
	// twin properties.
	Token *string `json:"token,omitempty" azure:"ro"`
}

EdgeModuleProvisioningToken - Provisioning token properties. A provisioning token allows for a single instance of Azure Video analyzer IoT edge module to be initialized and authorized to the cloud account. The provisioning token itself is short lived and it is only used for the initial handshake between IoT edge module and the cloud. After the initial handshake, the IoT edge module will agree on a set of authentication keys which will be auto-rotated as long as the module is able to periodically connect to the cloud. A new provisioning token can be generated for the same IoT edge module in case the module state lost or reset.

func (EdgeModuleProvisioningToken) MarshalJSON

func (e EdgeModuleProvisioningToken) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EdgeModuleProvisioningToken.

func (*EdgeModuleProvisioningToken) UnmarshalJSON

func (e *EdgeModuleProvisioningToken) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EdgeModuleProvisioningToken.

type EdgeModulesClient

type EdgeModulesClient struct {
	// contains filtered or unexported fields
}

EdgeModulesClient contains the methods for the EdgeModules group. Don't use this type directly, use NewEdgeModulesClient() instead.

func NewEdgeModulesClient

func NewEdgeModulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*EdgeModulesClient, error)

NewEdgeModulesClient creates a new instance of EdgeModulesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*EdgeModulesClient) CreateOrUpdate

func (client *EdgeModulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string, parameters EdgeModuleEntity, options *EdgeModulesClientCreateOrUpdateOptions) (EdgeModulesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new edge module or updates an existing one. An edge module resource enables a single instance of an Azure Video Analyzer IoT edge module to interact with the Video Analyzer Account. This is used for authorization and also to make sure that the particular edge module instance only has access to the data it requires from the Azure Video Analyzer service. A new edge module resource should be created for every new instance of an Azure Video Analyzer edge module deployed to you Azure IoT edge environment. Edge module resources can be deleted if the specific module is not in use anymore. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. edgeModuleName - The Edge Module name. parameters - The request parameters options - EdgeModulesClientCreateOrUpdateOptions contains the optional parameters for the EdgeModulesClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/edge-modules-create.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewEdgeModulesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<edge-module-name>",
		armvideoanalyzer.EdgeModuleEntity{},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*EdgeModulesClient) Delete

func (client *EdgeModulesClient) Delete(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string, options *EdgeModulesClientDeleteOptions) (EdgeModulesClientDeleteResponse, error)

Delete - Deletes an existing edge module resource. Deleting the edge module resource will prevent an Azure Video Analyzer IoT edge module which was previously initiated with the module provisioning token from communicating with the cloud. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. edgeModuleName - The Edge Module name. options - EdgeModulesClientDeleteOptions contains the optional parameters for the EdgeModulesClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/edge-modules-delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewEdgeModulesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<edge-module-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*EdgeModulesClient) Get

func (client *EdgeModulesClient) Get(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string, options *EdgeModulesClientGetOptions) (EdgeModulesClientGetResponse, error)

Get - Retrieves an existing edge module resource with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. edgeModuleName - The Edge Module name. options - EdgeModulesClientGetOptions contains the optional parameters for the EdgeModulesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/edge-modules-get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewEdgeModulesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<edge-module-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*EdgeModulesClient) ListProvisioningToken

func (client *EdgeModulesClient) ListProvisioningToken(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string, parameters ListProvisioningTokenInput, options *EdgeModulesClientListProvisioningTokenOptions) (EdgeModulesClientListProvisioningTokenResponse, error)

ListProvisioningToken - Creates a new provisioning token. A provisioning token allows for a single instance of Azure Video analyzer IoT edge module to be initialized and authorized to the cloud account. The provisioning token itself is short lived and it is only used for the initial handshake between IoT edge module and the cloud. After the initial handshake, the IoT edge module will agree on a set of authentication keys which will be auto-rotated as long as the module is able to periodically connect to the cloud. A new provisioning token can be generated for the same IoT edge module in case the module state lost or reset. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. edgeModuleName - The Edge Module name. parameters - The request parameters options - EdgeModulesClientListProvisioningTokenOptions contains the optional parameters for the EdgeModulesClient.ListProvisioningToken method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/edge-modules-listProvisioningToken.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewEdgeModulesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListProvisioningToken(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<edge-module-name>",
		armvideoanalyzer.ListProvisioningTokenInput{
			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-23T11:04:49.0526841-08:00"); return t }()),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*EdgeModulesClient) NewListPager added in v0.4.0

func (client *EdgeModulesClient) NewListPager(resourceGroupName string, accountName string, options *EdgeModulesClientListOptions) *runtime.Pager[EdgeModulesClientListResponse]

NewListPager - List all existing edge module resources, along with their JSON representations. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. options - EdgeModulesClientListOptions contains the optional parameters for the EdgeModulesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/edge-modules-list.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewEdgeModulesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("<resource-group-name>",
		"<account-name>",
		&armvideoanalyzer.EdgeModulesClientListOptions{Top: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type EdgeModulesClientCreateOrUpdateOptions added in v0.2.0

type EdgeModulesClientCreateOrUpdateOptions struct {
}

EdgeModulesClientCreateOrUpdateOptions contains the optional parameters for the EdgeModulesClient.CreateOrUpdate method.

type EdgeModulesClientCreateOrUpdateResponse added in v0.2.0

type EdgeModulesClientCreateOrUpdateResponse struct {
	EdgeModuleEntity
}

EdgeModulesClientCreateOrUpdateResponse contains the response from method EdgeModulesClient.CreateOrUpdate.

type EdgeModulesClientDeleteOptions added in v0.2.0

type EdgeModulesClientDeleteOptions struct {
}

EdgeModulesClientDeleteOptions contains the optional parameters for the EdgeModulesClient.Delete method.

type EdgeModulesClientDeleteResponse added in v0.2.0

type EdgeModulesClientDeleteResponse struct {
}

EdgeModulesClientDeleteResponse contains the response from method EdgeModulesClient.Delete.

type EdgeModulesClientGetOptions added in v0.2.0

type EdgeModulesClientGetOptions struct {
}

EdgeModulesClientGetOptions contains the optional parameters for the EdgeModulesClient.Get method.

type EdgeModulesClientGetResponse added in v0.2.0

type EdgeModulesClientGetResponse struct {
	EdgeModuleEntity
}

EdgeModulesClientGetResponse contains the response from method EdgeModulesClient.Get.

type EdgeModulesClientListOptions added in v0.2.0

type EdgeModulesClientListOptions struct {
	// Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the
	// number of available items up to but not greater than the specified value n.
	Top *int32
}

EdgeModulesClientListOptions contains the optional parameters for the EdgeModulesClient.List method.

type EdgeModulesClientListProvisioningTokenOptions added in v0.2.0

type EdgeModulesClientListProvisioningTokenOptions struct {
}

EdgeModulesClientListProvisioningTokenOptions contains the optional parameters for the EdgeModulesClient.ListProvisioningToken method.

type EdgeModulesClientListProvisioningTokenResponse added in v0.2.0

type EdgeModulesClientListProvisioningTokenResponse struct {
	EdgeModuleProvisioningToken
}

EdgeModulesClientListProvisioningTokenResponse contains the response from method EdgeModulesClient.ListProvisioningToken.

type EdgeModulesClientListResponse added in v0.2.0

type EdgeModulesClientListResponse struct {
	EdgeModuleEntityCollection
}

EdgeModulesClientListResponse contains the response from method EdgeModulesClient.List.

type EncoderCustomPreset

type EncoderCustomPreset struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// Describes a custom preset for encoding audio.
	AudioEncoder AudioEncoderBaseClassification `json:"audioEncoder,omitempty"`

	// Describes a custom preset for encoding video.
	VideoEncoder VideoEncoderBaseClassification `json:"videoEncoder,omitempty"`
}

EncoderCustomPreset - Describes a custom preset for encoding the input content using the encoder processor.

func (*EncoderCustomPreset) GetEncoderPresetBase added in v0.2.0

func (e *EncoderCustomPreset) GetEncoderPresetBase() *EncoderPresetBase

GetEncoderPresetBase implements the EncoderPresetBaseClassification interface for type EncoderCustomPreset.

func (EncoderCustomPreset) MarshalJSON

func (e EncoderCustomPreset) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EncoderCustomPreset.

func (*EncoderCustomPreset) UnmarshalJSON

func (e *EncoderCustomPreset) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EncoderCustomPreset.

type EncoderPresetBase

type EncoderPresetBase struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

EncoderPresetBase - Base type for all encoder presets, which define the recipe or instructions on how the input content should be processed.

func (*EncoderPresetBase) GetEncoderPresetBase

func (e *EncoderPresetBase) GetEncoderPresetBase() *EncoderPresetBase

GetEncoderPresetBase implements the EncoderPresetBaseClassification interface for type EncoderPresetBase.

type EncoderPresetBaseClassification

type EncoderPresetBaseClassification interface {
	// GetEncoderPresetBase returns the EncoderPresetBase content of the underlying type.
	GetEncoderPresetBase() *EncoderPresetBase
}

EncoderPresetBaseClassification provides polymorphic access to related types. Call the interface's GetEncoderPresetBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EncoderCustomPreset, *EncoderPresetBase, *EncoderSystemPreset

type EncoderProcessor

type EncoderProcessor struct {
	// REQUIRED; An array of upstream node references within the topology to be used as inputs for this node.
	Inputs []*NodeInput `json:"inputs,omitempty"`

	// REQUIRED; Node name. Must be unique within the topology.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The encoder preset, which defines the recipe or instructions on how the input content should be processed.
	Preset EncoderPresetBaseClassification `json:"preset,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

EncoderProcessor - Encoder processor allows for encoding of the input content. For example, it can used to change the resolution from 4K to 1280x720.

func (*EncoderProcessor) GetNodeBase added in v0.2.0

func (e *EncoderProcessor) GetNodeBase() *NodeBase

GetNodeBase implements the NodeBaseClassification interface for type EncoderProcessor.

func (*EncoderProcessor) GetProcessorNodeBase added in v0.2.0

func (e *EncoderProcessor) GetProcessorNodeBase() *ProcessorNodeBase

GetProcessorNodeBase implements the ProcessorNodeBaseClassification interface for type EncoderProcessor.

func (EncoderProcessor) MarshalJSON

func (e EncoderProcessor) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EncoderProcessor.

func (*EncoderProcessor) UnmarshalJSON

func (e *EncoderProcessor) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EncoderProcessor.

type EncoderSystemPreset

type EncoderSystemPreset struct {
	// REQUIRED; Name of the built-in encoding preset.
	Name *EncoderSystemPresetType `json:"name,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

EncoderSystemPreset - Describes a built-in preset for encoding the input content using the encoder processor.

func (*EncoderSystemPreset) GetEncoderPresetBase added in v0.2.0

func (e *EncoderSystemPreset) GetEncoderPresetBase() *EncoderPresetBase

GetEncoderPresetBase implements the EncoderPresetBaseClassification interface for type EncoderSystemPreset.

func (EncoderSystemPreset) MarshalJSON

func (e EncoderSystemPreset) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EncoderSystemPreset.

func (*EncoderSystemPreset) UnmarshalJSON

func (e *EncoderSystemPreset) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EncoderSystemPreset.

type EncoderSystemPresetType

type EncoderSystemPresetType string

EncoderSystemPresetType - Name of the built-in encoding preset.

const (
	// EncoderSystemPresetTypeSingleLayer1080PH264AAC - Produces an MP4 file where the video is encoded with H.264 codec at a
	// picture height of 1080 pixels, and at a maximum bitrate of 6000 Kbps. Encoded video has the same average frame rate as
	// the input. The aspect ratio of the input is preserved. If the input content has audio, then it is encoded with AAC-LC codec
	// at 128 Kbps
	EncoderSystemPresetTypeSingleLayer1080PH264AAC EncoderSystemPresetType = "SingleLayer_1080p_H264_AAC"
	// EncoderSystemPresetTypeSingleLayer2160PH264AAC - Produces an MP4 file where the video is encoded with H.264 codec at a
	// picture height of 2160 pixels, and at a maximum bitrate of 16000 Kbps. Encoded video has the same average frame rate as
	// the input. The aspect ratio of the input is preserved. If the input content has audio, then it is encoded with AAC-LC codec
	// at 128 Kbps
	EncoderSystemPresetTypeSingleLayer2160PH264AAC EncoderSystemPresetType = "SingleLayer_2160p_H264_AAC"
	// EncoderSystemPresetTypeSingleLayer540PH264AAC - Produces an MP4 file where the video is encoded with H.264 codec at a picture
	// height of 540 pixels, and at a maximum bitrate of 2000 Kbps. Encoded video has the same average frame rate as the input.
	// The aspect ratio of the input is preserved. If the input content has audio, then it is encoded with AAC-LC codec at 96
	// Kbps
	EncoderSystemPresetTypeSingleLayer540PH264AAC EncoderSystemPresetType = "SingleLayer_540p_H264_AAC"
	// EncoderSystemPresetTypeSingleLayer720PH264AAC - Produces an MP4 file where the video is encoded with H.264 codec at a picture
	// height of 720 pixels, and at a maximum bitrate of 3500 Kbps. Encoded video has the same average frame rate as the input.
	// The aspect ratio of the input is preserved. If the input content has audio, then it is encoded with AAC-LC codec at 96
	// Kbps
	EncoderSystemPresetTypeSingleLayer720PH264AAC EncoderSystemPresetType = "SingleLayer_720p_H264_AAC"
)

func PossibleEncoderSystemPresetTypeValues

func PossibleEncoderSystemPresetTypeValues() []EncoderSystemPresetType

PossibleEncoderSystemPresetTypeValues returns the possible values for the EncoderSystemPresetType const type.

type Endpoint

type Endpoint struct {
	// REQUIRED; The type of the endpoint.
	Type *VideoAnalyzerEndpointType `json:"type,omitempty"`

	// The URL of the endpoint.
	EndpointURL *string `json:"endpointUrl,omitempty"`
}

Endpoint - The endpoint details.

type EndpointBase

type EndpointBase struct {
	// REQUIRED; Credentials to be presented to the endpoint.
	Credentials CredentialsBaseClassification `json:"credentials,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// REQUIRED; The endpoint URL for Video Analyzer to connect to.
	URL *string `json:"url,omitempty"`

	// Describes the tunnel through which Video Analyzer can connect to the endpoint URL. This is an optional property, typically
	// used when the endpoint is behind a firewall.
	Tunnel TunnelBaseClassification `json:"tunnel,omitempty"`
}

EndpointBase - Base class for endpoints.

func (*EndpointBase) GetEndpointBase

func (e *EndpointBase) GetEndpointBase() *EndpointBase

GetEndpointBase implements the EndpointBaseClassification interface for type EndpointBase.

func (EndpointBase) MarshalJSON added in v0.2.0

func (e EndpointBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointBase.

func (*EndpointBase) UnmarshalJSON

func (e *EndpointBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointBase.

type EndpointBaseClassification

type EndpointBaseClassification interface {
	// GetEndpointBase returns the EndpointBase content of the underlying type.
	GetEndpointBase() *EndpointBase
}

EndpointBaseClassification provides polymorphic access to related types. Call the interface's GetEndpointBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EndpointBase, *TLSEndpoint, *UnsecuredEndpoint

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty" azure:"ro"`

	// READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ErrorAdditionalInfo - The resource management error additional info.

type ErrorDetail

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorDetail `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

type ErrorResponse

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

type GroupLevelAccessControl

type GroupLevelAccessControl struct {
	// Whether or not public network access is allowed for specified resources under the Video Analyzer account.
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
}

GroupLevelAccessControl - Group level network access control.

type Identity added in v0.2.0

type Identity struct {
	// REQUIRED; The identity type.
	Type *string `json:"type,omitempty"`

	// The User Assigned Managed Identities.
	UserAssignedIdentities map[string]*UserAssignedManagedIdentity `json:"userAssignedIdentities,omitempty"`
}

Identity - The managed identity for the Video Analyzer resource.

func (Identity) MarshalJSON added in v0.2.0

func (i Identity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Identity.

type IotHub

type IotHub struct {
	// REQUIRED; The IoT Hub resource identifier.
	ID *string `json:"id,omitempty"`

	// REQUIRED; The IoT Hub identity.
	Identity *ResourceIdentity `json:"identity,omitempty"`

	// READ-ONLY; The current status of the Iot Hub mapping.
	Status *string `json:"status,omitempty" azure:"ro"`
}

IotHub - The IoT Hub details.

type JwtAuthentication

type JwtAuthentication struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// List of expected token audiences. Token audience is valid if it matches at least one of the given values.
	Audiences []*string `json:"audiences,omitempty"`

	// List of additional token claims to be validated. Token must contains all claims and respective values for it to be valid.
	Claims []*TokenClaim `json:"claims,omitempty"`

	// List of expected token issuers. Token issuer is valid if it matches at least one of the given values.
	Issuers []*string `json:"issuers,omitempty"`

	// List of keys which can be used to validate access tokens. Having multiple keys allow for seamless key rotation of the token
	// signing key. Token signature must match exactly one key.
	Keys []TokenKeyClassification `json:"keys,omitempty"`
}

JwtAuthentication - Properties for access validation based on JSON Web Tokens (JWT).

func (*JwtAuthentication) GetAuthenticationBase added in v0.2.0

func (j *JwtAuthentication) GetAuthenticationBase() *AuthenticationBase

GetAuthenticationBase implements the AuthenticationBaseClassification interface for type JwtAuthentication.

func (JwtAuthentication) MarshalJSON

func (j JwtAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JwtAuthentication.

func (*JwtAuthentication) UnmarshalJSON

func (j *JwtAuthentication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JwtAuthentication.

type KeyVaultProperties

type KeyVaultProperties struct {
	// REQUIRED; The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1)
	// or reference a key without a version (for example
	// https://vault/keys/mykey).
	KeyIdentifier *string `json:"keyIdentifier,omitempty"`

	// READ-ONLY; The current key used to encrypt Video Analyzer account, including the key version.
	CurrentKeyIdentifier *string `json:"currentKeyIdentifier,omitempty" azure:"ro"`
}

KeyVaultProperties - The details for accessing the encryption keys in Key Vault.

type Kind

type Kind string

Kind - Topology kind.

const (
	// KindBatch - Batch pipeline topology resource.
	KindBatch Kind = "Batch"
	// KindLive - Live pipeline topology resource.
	KindLive Kind = "Live"
)

func PossibleKindValues

func PossibleKindValues() []Kind

PossibleKindValues returns the possible values for the Kind const type.

type ListProvisioningTokenInput

type ListProvisioningTokenInput struct {
	// REQUIRED; The desired expiration date of the registration token. The Azure Video Analyzer IoT edge module must be initialized
	// and connected to the Internet prior to the token expiration date.
	ExpirationDate *time.Time `json:"expirationDate,omitempty"`
}

ListProvisioningTokenInput - The input parameters to generate registration token for the Azure Video Analyzer IoT edge module.

func (ListProvisioningTokenInput) MarshalJSON

func (l ListProvisioningTokenInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListProvisioningTokenInput.

func (*ListProvisioningTokenInput) UnmarshalJSON

func (l *ListProvisioningTokenInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListProvisioningTokenInput.

type LivePipeline

type LivePipeline struct {
	// The resource properties.
	Properties *LivePipelineProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

LivePipeline - Live pipeline represents a unique instance of a live topology, used for real-time ingestion, archiving and publishing of content for a unique RTSP camera.

type LivePipelineCollection

type LivePipelineCollection struct {
	// A link to the next page of the collection (when the collection contains too many results to return in one response).
	NextLink *string `json:"@nextLink,omitempty"`

	// A collection of LivePipeline items.
	Value []*LivePipeline `json:"value,omitempty"`
}

LivePipelineCollection - A collection of LivePipeline items.

func (LivePipelineCollection) MarshalJSON

func (l LivePipelineCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LivePipelineCollection.

type LivePipelineOperationStatus

type LivePipelineOperationStatus struct {
	// READ-ONLY; The error details for the live pipeline operation.
	Error *ErrorDetail `json:"error,omitempty" azure:"ro"`

	// READ-ONLY; The name of the live pipeline operation.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The status of the live pipeline operation.
	Status *string `json:"status,omitempty" azure:"ro"`
}

LivePipelineOperationStatus - Used for tracking the status of an operation on the live pipeline.

type LivePipelineOperationStatusesClient

type LivePipelineOperationStatusesClient struct {
	// contains filtered or unexported fields
}

LivePipelineOperationStatusesClient contains the methods for the LivePipelineOperationStatuses group. Don't use this type directly, use NewLivePipelineOperationStatusesClient() instead.

func NewLivePipelineOperationStatusesClient

func NewLivePipelineOperationStatusesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*LivePipelineOperationStatusesClient, error)

NewLivePipelineOperationStatusesClient creates a new instance of LivePipelineOperationStatusesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LivePipelineOperationStatusesClient) Get

Get - Get the operation status of a live pipeline. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. livePipelineName - Live pipeline unique identifier. operationID - The operation ID. options - LivePipelineOperationStatusesClientGetOptions contains the optional parameters for the LivePipelineOperationStatusesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/live-pipeline-operation-status-get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewLivePipelineOperationStatusesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<live-pipeline-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type LivePipelineOperationStatusesClientGetOptions added in v0.2.0

type LivePipelineOperationStatusesClientGetOptions struct {
}

LivePipelineOperationStatusesClientGetOptions contains the optional parameters for the LivePipelineOperationStatusesClient.Get method.

type LivePipelineOperationStatusesClientGetResponse added in v0.2.0

type LivePipelineOperationStatusesClientGetResponse struct {
	LivePipelineOperationStatus
}

LivePipelineOperationStatusesClientGetResponse contains the response from method LivePipelineOperationStatusesClient.Get.

type LivePipelineProperties

type LivePipelineProperties struct {
	// REQUIRED; Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in
	// increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will
	// disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to
	// see if the camera bitrate is now below the reserved capacity. Doing so will
	// ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
	BitrateKbps *int32 `json:"bitrateKbps,omitempty"`

	// REQUIRED; The reference to an existing pipeline topology defined for real-time content processing. When activated, this
	// live pipeline will process content according to the pipeline topology definition.
	TopologyName *string `json:"topologyName,omitempty"`

	// An optional description for the pipeline.
	Description *string `json:"description,omitempty"`

	// List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override
	// parameters values for parameters which have been declared in the referenced
	// topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be
	// optionally be overridden.
	Parameters []*ParameterDefinition `json:"parameters,omitempty"`

	// READ-ONLY; Current state of the pipeline (read-only).
	State *LivePipelineState `json:"state,omitempty" azure:"ro"`
}

LivePipelineProperties - Live pipeline properties.

func (LivePipelineProperties) MarshalJSON

func (l LivePipelineProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LivePipelineProperties.

type LivePipelinePropertiesUpdate

type LivePipelinePropertiesUpdate struct {
	// Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments
	// of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will
	// disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to
	// see if the camera bitrate is now below the reserved capacity. Doing so will
	// ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
	BitrateKbps *int32 `json:"bitrateKbps,omitempty"`

	// An optional description for the pipeline.
	Description *string `json:"description,omitempty"`

	// List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override
	// parameters values for parameters which have been declared in the referenced
	// topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be
	// optionally be overridden.
	Parameters []*ParameterDefinition `json:"parameters,omitempty"`

	// The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline
	// will process content according to the pipeline topology definition.
	TopologyName *string `json:"topologyName,omitempty"`

	// READ-ONLY; Current state of the pipeline (read-only).
	State *LivePipelineState `json:"state,omitempty" azure:"ro"`
}

LivePipelinePropertiesUpdate - Live pipeline properties.

func (LivePipelinePropertiesUpdate) MarshalJSON

func (l LivePipelinePropertiesUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LivePipelinePropertiesUpdate.

type LivePipelineState

type LivePipelineState string

LivePipelineState - Current state of the pipeline (read-only).

const (
	// LivePipelineStateActivating - The live pipeline is transitioning into the active state.
	LivePipelineStateActivating LivePipelineState = "Activating"
	// LivePipelineStateActive - The live pipeline is active and able to process media. If your data source is not available,
	// for instance, if your RTSP camera is powered off or unreachable, the pipeline will still be active and periodically retrying
	// the connection. Your Azure subscription will be billed for the duration in which the live pipeline is in the active state.
	LivePipelineStateActive LivePipelineState = "Active"
	// LivePipelineStateDeactivating - The live pipeline is transitioning into the inactive state.
	LivePipelineStateDeactivating LivePipelineState = "Deactivating"
	// LivePipelineStateInactive - The live pipeline is idle and not processing media.
	LivePipelineStateInactive LivePipelineState = "Inactive"
)

func PossibleLivePipelineStateValues

func PossibleLivePipelineStateValues() []LivePipelineState

PossibleLivePipelineStateValues returns the possible values for the LivePipelineState const type.

type LivePipelineUpdate

type LivePipelineUpdate struct {
	// The resource properties.
	Properties *LivePipelinePropertiesUpdate `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

LivePipelineUpdate - Live pipeline represents a unique instance of a live topology, used for real-time ingestion, archiving and publishing of content for a unique RTSP camera.

func (LivePipelineUpdate) MarshalJSON

func (l LivePipelineUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LivePipelineUpdate.

type LivePipelinesClient

type LivePipelinesClient struct {
	// contains filtered or unexported fields
}

LivePipelinesClient contains the methods for the LivePipelines group. Don't use this type directly, use NewLivePipelinesClient() instead.

func NewLivePipelinesClient

func NewLivePipelinesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*LivePipelinesClient, error)

NewLivePipelinesClient creates a new instance of LivePipelinesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LivePipelinesClient) BeginActivate

func (client *LivePipelinesClient) BeginActivate(ctx context.Context, resourceGroupName string, accountName string, livePipelineName string, options *LivePipelinesClientBeginActivateOptions) (*armruntime.Poller[LivePipelinesClientActivateResponse], error)

BeginActivate - Activates a live pipeline with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. livePipelineName - Live pipeline unique identifier. options - LivePipelinesClientBeginActivateOptions contains the optional parameters for the LivePipelinesClient.BeginActivate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/live-pipeline-activate.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewLivePipelinesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginActivate(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<live-pipeline-name>",
		&armvideoanalyzer.LivePipelinesClientBeginActivateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*LivePipelinesClient) BeginDeactivate

func (client *LivePipelinesClient) BeginDeactivate(ctx context.Context, resourceGroupName string, accountName string, livePipelineName string, options *LivePipelinesClientBeginDeactivateOptions) (*armruntime.Poller[LivePipelinesClientDeactivateResponse], error)

BeginDeactivate - Deactivates a live pipeline with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. livePipelineName - Live pipeline unique identifier. options - LivePipelinesClientBeginDeactivateOptions contains the optional parameters for the LivePipelinesClient.BeginDeactivate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/live-pipeline-deactivate.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewLivePipelinesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDeactivate(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<live-pipeline-name>",
		&armvideoanalyzer.LivePipelinesClientBeginDeactivateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*LivePipelinesClient) CreateOrUpdate

func (client *LivePipelinesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, livePipelineName string, parameters LivePipeline, options *LivePipelinesClientCreateOrUpdateOptions) (LivePipelinesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new live pipeline or updates an existing one, with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. livePipelineName - Live pipeline unique identifier. parameters - The request parameters options - LivePipelinesClientCreateOrUpdateOptions contains the optional parameters for the LivePipelinesClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/live-pipeline-create.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewLivePipelinesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<live-pipeline-name>",
		armvideoanalyzer.LivePipeline{
			Properties: &armvideoanalyzer.LivePipelineProperties{
				Description: to.Ptr("<description>"),
				BitrateKbps: to.Ptr[int32](500),
				Parameters: []*armvideoanalyzer.ParameterDefinition{
					{
						Name:  to.Ptr("<name>"),
						Value: to.Ptr("<value>"),
					}},
				TopologyName: to.Ptr("<topology-name>"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*LivePipelinesClient) Delete

func (client *LivePipelinesClient) Delete(ctx context.Context, resourceGroupName string, accountName string, livePipelineName string, options *LivePipelinesClientDeleteOptions) (LivePipelinesClientDeleteResponse, error)

Delete - Deletes a live pipeline with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. livePipelineName - Live pipeline unique identifier. options - LivePipelinesClientDeleteOptions contains the optional parameters for the LivePipelinesClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/live-pipeline-delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewLivePipelinesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<live-pipeline-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*LivePipelinesClient) Get

func (client *LivePipelinesClient) Get(ctx context.Context, resourceGroupName string, accountName string, livePipelineName string, options *LivePipelinesClientGetOptions) (LivePipelinesClientGetResponse, error)

Get - Retrieves a specific live pipeline by name. If a live pipeline with that name has been previously created, the call will return the JSON representation of that instance. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. livePipelineName - Live pipeline unique identifier. options - LivePipelinesClientGetOptions contains the optional parameters for the LivePipelinesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/live-pipeline-get-by-name.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewLivePipelinesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<live-pipeline-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*LivePipelinesClient) NewListPager added in v0.4.0

func (client *LivePipelinesClient) NewListPager(resourceGroupName string, accountName string, options *LivePipelinesClientListOptions) *runtime.Pager[LivePipelinesClientListResponse]

NewListPager - Retrieves a list of live pipelines that have been created, along with their JSON representations. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. options - LivePipelinesClientListOptions contains the optional parameters for the LivePipelinesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/live-pipeline-list.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewLivePipelinesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("<resource-group-name>",
		"<account-name>",
		&armvideoanalyzer.LivePipelinesClientListOptions{Filter: nil,
			Top: to.Ptr[int32](2),
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*LivePipelinesClient) Update

func (client *LivePipelinesClient) Update(ctx context.Context, resourceGroupName string, accountName string, livePipelineName string, parameters LivePipelineUpdate, options *LivePipelinesClientUpdateOptions) (LivePipelinesClientUpdateResponse, error)

Update - Updates an existing live pipeline with the given name. Properties that can be updated include: description, bitrateKbps, and parameter definitions. Only the description can be updated while the live pipeline is active. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. livePipelineName - Live pipeline unique identifier. parameters - The request parameters options - LivePipelinesClientUpdateOptions contains the optional parameters for the LivePipelinesClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/live-pipeline-patch.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewLivePipelinesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<live-pipeline-name>",
		armvideoanalyzer.LivePipelineUpdate{
			Properties: &armvideoanalyzer.LivePipelinePropertiesUpdate{
				Description: to.Ptr("<description>"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type LivePipelinesClientActivateResponse added in v0.2.0

type LivePipelinesClientActivateResponse struct {
}

LivePipelinesClientActivateResponse contains the response from method LivePipelinesClient.Activate.

type LivePipelinesClientBeginActivateOptions added in v0.2.0

type LivePipelinesClientBeginActivateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

LivePipelinesClientBeginActivateOptions contains the optional parameters for the LivePipelinesClient.BeginActivate method.

type LivePipelinesClientBeginDeactivateOptions added in v0.2.0

type LivePipelinesClientBeginDeactivateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

LivePipelinesClientBeginDeactivateOptions contains the optional parameters for the LivePipelinesClient.BeginDeactivate method.

type LivePipelinesClientCreateOrUpdateOptions added in v0.2.0

type LivePipelinesClientCreateOrUpdateOptions struct {
}

LivePipelinesClientCreateOrUpdateOptions contains the optional parameters for the LivePipelinesClient.CreateOrUpdate method.

type LivePipelinesClientCreateOrUpdateResponse added in v0.2.0

type LivePipelinesClientCreateOrUpdateResponse struct {
	LivePipeline
}

LivePipelinesClientCreateOrUpdateResponse contains the response from method LivePipelinesClient.CreateOrUpdate.

type LivePipelinesClientDeactivateResponse added in v0.2.0

type LivePipelinesClientDeactivateResponse struct {
}

LivePipelinesClientDeactivateResponse contains the response from method LivePipelinesClient.Deactivate.

type LivePipelinesClientDeleteOptions added in v0.2.0

type LivePipelinesClientDeleteOptions struct {
}

LivePipelinesClientDeleteOptions contains the optional parameters for the LivePipelinesClient.Delete method.

type LivePipelinesClientDeleteResponse added in v0.2.0

type LivePipelinesClientDeleteResponse struct {
}

LivePipelinesClientDeleteResponse contains the response from method LivePipelinesClient.Delete.

type LivePipelinesClientGetOptions added in v0.2.0

type LivePipelinesClientGetOptions struct {
}

LivePipelinesClientGetOptions contains the optional parameters for the LivePipelinesClient.Get method.

type LivePipelinesClientGetResponse added in v0.2.0

type LivePipelinesClientGetResponse struct {
	LivePipeline
}

LivePipelinesClientGetResponse contains the response from method LivePipelinesClient.Get.

type LivePipelinesClientListOptions added in v0.2.0

type LivePipelinesClientListOptions struct {
	// Restricts the set of items returned.
	Filter *string
	// Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the
	// number of available items up to but not greater than the specified value n.
	Top *int32
}

LivePipelinesClientListOptions contains the optional parameters for the LivePipelinesClient.List method.

type LivePipelinesClientListResponse added in v0.2.0

type LivePipelinesClientListResponse struct {
	LivePipelineCollection
}

LivePipelinesClientListResponse contains the response from method LivePipelinesClient.List.

type LivePipelinesClientUpdateOptions added in v0.2.0

type LivePipelinesClientUpdateOptions struct {
}

LivePipelinesClientUpdateOptions contains the optional parameters for the LivePipelinesClient.Update method.

type LivePipelinesClientUpdateResponse added in v0.2.0

type LivePipelinesClientUpdateResponse struct {
	LivePipeline
}

LivePipelinesClientUpdateResponse contains the response from method LivePipelinesClient.Update.

type LocationsClient

type LocationsClient struct {
	// contains filtered or unexported fields
}

LocationsClient contains the methods for the Locations group. Don't use this type directly, use NewLocationsClient() instead.

func NewLocationsClient

func NewLocationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*LocationsClient, error)

NewLocationsClient creates a new instance of LocationsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LocationsClient) CheckNameAvailability

CheckNameAvailability - Checks whether the Video Analyzer resource name is available. If the operation fails it returns an *azcore.ResponseError type. locationName - Location Name. parameters - The request parameters options - LocationsClientCheckNameAvailabilityOptions contains the optional parameters for the LocationsClient.CheckNameAvailability method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/accounts-check-name-availability.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewLocationsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CheckNameAvailability(ctx,
		"<location-name>",
		armvideoanalyzer.CheckNameAvailabilityRequest{
			Name: to.Ptr("<name>"),
			Type: to.Ptr("<type>"),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type LocationsClientCheckNameAvailabilityOptions added in v0.2.0

type LocationsClientCheckNameAvailabilityOptions struct {
}

LocationsClientCheckNameAvailabilityOptions contains the optional parameters for the LocationsClient.CheckNameAvailability method.

type LocationsClientCheckNameAvailabilityResponse added in v0.2.0

type LocationsClientCheckNameAvailabilityResponse struct {
	CheckNameAvailabilityResponse
}

LocationsClientCheckNameAvailabilityResponse contains the response from method LocationsClient.CheckNameAvailability.

type LogSpecification

type LogSpecification struct {
	// READ-ONLY; The time range for requests in each blob.
	BlobDuration *string `json:"blobDuration,omitempty" azure:"ro"`

	// READ-ONLY; The diagnostic log category display name.
	DisplayName *string `json:"displayName,omitempty" azure:"ro"`

	// READ-ONLY; The diagnostic log category name.
	Name *string `json:"name,omitempty" azure:"ro"`
}

LogSpecification - A diagnostic log emitted by service.

type MetricAggregationType

type MetricAggregationType string

MetricAggregationType - The metric aggregation type

const (
	// MetricAggregationTypeAverage - The average.
	MetricAggregationTypeAverage MetricAggregationType = "Average"
	// MetricAggregationTypeCount - The count of a number of items, usually requests.
	MetricAggregationTypeCount MetricAggregationType = "Count"
	// MetricAggregationTypeTotal - The sum.
	MetricAggregationTypeTotal MetricAggregationType = "Total"
)

func PossibleMetricAggregationTypeValues

func PossibleMetricAggregationTypeValues() []MetricAggregationType

PossibleMetricAggregationTypeValues returns the possible values for the MetricAggregationType const type.

type MetricDimension

type MetricDimension struct {
	// READ-ONLY; The display name for the dimension.
	DisplayName *string `json:"displayName,omitempty" azure:"ro"`

	// READ-ONLY; The metric dimension name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Whether to export metric to shoebox.
	ToBeExportedForShoebox *bool `json:"toBeExportedForShoebox,omitempty" azure:"ro"`
}

MetricDimension - A metric dimension.

type MetricProperties added in v0.2.0

type MetricProperties struct {
	// READ-ONLY; The service specifications.
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty" azure:"ro"`
}

MetricProperties - Metric properties.

type MetricSpecification

type MetricSpecification struct {
	// Supported aggregation types.
	SupportedAggregationTypes []*string `json:"supportedAggregationTypes,omitempty"`

	// READ-ONLY; The metric aggregation type
	AggregationType *MetricAggregationType `json:"aggregationType,omitempty" azure:"ro"`

	// READ-ONLY; The metric dimensions.
	Dimensions []*MetricDimension `json:"dimensions,omitempty" azure:"ro"`

	// READ-ONLY; The metric display description.
	DisplayDescription *string `json:"displayDescription,omitempty" azure:"ro"`

	// READ-ONLY; The metric display name.
	DisplayName *string `json:"displayName,omitempty" azure:"ro"`

	// READ-ONLY; Indicates whether regional MDM account is enabled.
	EnableRegionalMdmAccount *bool `json:"enableRegionalMdmAccount,omitempty" azure:"ro"`

	// READ-ONLY; The metric lock aggregation type
	LockAggregationType *MetricAggregationType `json:"lockAggregationType,omitempty" azure:"ro"`

	// READ-ONLY; The metric name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The source MDM account.
	SourceMdmAccount *string `json:"sourceMdmAccount,omitempty" azure:"ro"`

	// READ-ONLY; The source MDM namespace.
	SourceMdmNamespace *string `json:"sourceMdmNamespace,omitempty" azure:"ro"`

	// READ-ONLY; The supported time grain types.
	SupportedTimeGrainTypes []*string `json:"supportedTimeGrainTypes,omitempty" azure:"ro"`

	// READ-ONLY; The metric unit
	Unit *MetricUnit `json:"unit,omitempty" azure:"ro"`
}

MetricSpecification - A metric emitted by service.

func (MetricSpecification) MarshalJSON

func (m MetricSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricSpecification.

type MetricUnit

type MetricUnit string

MetricUnit - The metric unit

const (
	// MetricUnitBytes - The number of bytes.
	MetricUnitBytes MetricUnit = "Bytes"
	// MetricUnitCount - The count.
	MetricUnitCount MetricUnit = "Count"
	// MetricUnitMilliseconds - The number of milliseconds.
	MetricUnitMilliseconds MetricUnit = "Milliseconds"
)

func PossibleMetricUnitValues

func PossibleMetricUnitValues() []MetricUnit

PossibleMetricUnitValues returns the possible values for the MetricUnit const type.

type NetworkAccessControl

type NetworkAccessControl struct {
	// Public network access for consumption group.
	Consumption *GroupLevelAccessControl `json:"consumption,omitempty"`

	// Public network access for ingestion group.
	Ingestion *GroupLevelAccessControl `json:"ingestion,omitempty"`

	// Public network access for integration group.
	Integration *GroupLevelAccessControl `json:"integration,omitempty"`
}

NetworkAccessControl - Network access control for video analyzer account.

type NodeBase

type NodeBase struct {
	// REQUIRED; Node name. Must be unique within the topology.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

NodeBase - Base class for nodes.

func (*NodeBase) GetNodeBase

func (n *NodeBase) GetNodeBase() *NodeBase

GetNodeBase implements the NodeBaseClassification interface for type NodeBase.

type NodeBaseClassification

type NodeBaseClassification interface {
	// GetNodeBase returns the NodeBase content of the underlying type.
	GetNodeBase() *NodeBase
}

NodeBaseClassification provides polymorphic access to related types. Call the interface's GetNodeBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EncoderProcessor, *NodeBase, *ProcessorNodeBase, *RtspSource, *SinkNodeBase, *SourceNodeBase, *VideoSink, *VideoSource

type NodeInput

type NodeInput struct {
	// REQUIRED; The name of the upstream node in the pipeline which output is used as input of the current node.
	NodeName *string `json:"nodeName,omitempty"`
}

NodeInput - Describes an input signal to be used on a pipeline node.

type Operation

type Operation struct {
	// REQUIRED; The operation name.
	Name *string `json:"name,omitempty"`

	// Indicates the action type.
	ActionType *ActionType `json:"actionType,omitempty"`

	// The operation display name.
	Display *OperationDisplay `json:"display,omitempty"`

	// Whether the operation applies to data-plane.
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// Origin of the operation.
	Origin *string `json:"origin,omitempty"`

	// Operation properties format.
	Properties *MetricProperties `json:"properties,omitempty"`
}

Operation - An operation.

type OperationCollection

type OperationCollection struct {
	// A collection of Operation items.
	Value []*Operation `json:"value,omitempty"`
}

OperationCollection - A collection of Operation items.

func (OperationCollection) MarshalJSON

func (o OperationCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationCollection.

type OperationDisplay

type OperationDisplay struct {
	// The operation description.
	Description *string `json:"description,omitempty"`

	// The operation type.
	Operation *string `json:"operation,omitempty"`

	// The service provider.
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - Operation details.

type OperationResultsClient

type OperationResultsClient struct {
	// contains filtered or unexported fields
}

OperationResultsClient contains the methods for the VideoAnalyzerOperationResults group. Don't use this type directly, use NewOperationResultsClient() instead.

func NewOperationResultsClient

func NewOperationResultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationResultsClient, error)

NewOperationResultsClient creates a new instance of OperationResultsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationResultsClient) Get

Get - Get video analyzer operation result. If the operation fails it returns an *azcore.ResponseError type. locationName - Location name. operationID - Operation Id. options - OperationResultsClientGetOptions contains the optional parameters for the OperationResultsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-operation-result-by-id.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewOperationResultsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<location-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type OperationResultsClientGetOptions added in v0.2.0

type OperationResultsClientGetOptions struct {
}

OperationResultsClientGetOptions contains the optional parameters for the OperationResultsClient.Get method.

type OperationResultsClientGetResponse added in v0.2.0

type OperationResultsClientGetResponse struct {
	VideoAnalyzer
}

OperationResultsClientGetResponse contains the response from method OperationResultsClient.Get.

type OperationStatus added in v0.2.0

type OperationStatus struct {
	// REQUIRED; Operation identifier.
	Name *string `json:"name,omitempty"`

	// Operation end time.
	EndTime *string `json:"endTime,omitempty"`

	// The error detail.
	Error *ErrorDetail `json:"error,omitempty"`

	// Operation resource ID.
	ID *string `json:"id,omitempty"`

	// Operation start time.
	StartTime *string `json:"startTime,omitempty"`

	// Operation status.
	Status *string `json:"status,omitempty"`
}

OperationStatus - Status of video analyzer operation.

type OperationStatusesClient

type OperationStatusesClient struct {
	// contains filtered or unexported fields
}

OperationStatusesClient contains the methods for the VideoAnalyzerOperationStatuses group. Don't use this type directly, use NewOperationStatusesClient() instead.

func NewOperationStatusesClient

func NewOperationStatusesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationStatusesClient, error)

NewOperationStatusesClient creates a new instance of OperationStatusesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationStatusesClient) Get

Get - Get video analyzer operation status. If the operation fails it returns an *azcore.ResponseError type. locationName - Location name. operationID - Operation Id. options - OperationStatusesClientGetOptions contains the optional parameters for the OperationStatusesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-operation-status-by-id-non-terminal-state-failed.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewOperationStatusesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<location-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type OperationStatusesClientGetOptions added in v0.2.0

type OperationStatusesClientGetOptions struct {
}

OperationStatusesClientGetOptions contains the optional parameters for the OperationStatusesClient.Get method.

type OperationStatusesClientGetResponse added in v0.2.0

type OperationStatusesClientGetResponse struct {
	OperationStatus
}

OperationStatusesClientGetResponse contains the response from method OperationStatusesClient.Get.

type OperationsClient

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) List

List - Lists all the Media operations. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/operations-list-all.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewOperationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type OperationsClientListOptions added in v0.2.0

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.2.0

type OperationsClientListResponse struct {
	OperationCollection
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type ParameterDeclaration

type ParameterDeclaration struct {
	// REQUIRED; Name of the parameter.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Type of the parameter.
	Type *ParameterType `json:"type,omitempty"`

	// The default value for the parameter to be used if the pipeline does not specify a value.
	Default *string `json:"default,omitempty"`

	// Description of the parameter.
	Description *string `json:"description,omitempty"`
}

ParameterDeclaration - Single topology parameter declaration. Declared parameters can and must be referenced throughout the topology and can optionally have default values to be used when they are not defined in the pipelines.

type ParameterDefinition

type ParameterDefinition struct {
	// REQUIRED; Name of the parameter declared in the pipeline topology.
	Name *string `json:"name,omitempty"`

	// Parameter value to be applied on this specific pipeline.
	Value *string `json:"value,omitempty"`
}

ParameterDefinition - Defines the parameter value of an specific pipeline topology parameter. See pipeline topology parameters for more information.

type ParameterType

type ParameterType string

ParameterType - Type of the parameter.

const (
	// ParameterTypeBool - The parameter's value is a boolean value that is either true or false.
	ParameterTypeBool ParameterType = "Bool"
	// ParameterTypeDouble - The parameter's value is a 64-bit double-precision floating point.
	ParameterTypeDouble ParameterType = "Double"
	// ParameterTypeInt - The parameter's value is a 32-bit signed integer.
	ParameterTypeInt ParameterType = "Int"
	// ParameterTypeSecretString - The parameter's value is a string that holds sensitive information.
	ParameterTypeSecretString ParameterType = "SecretString"
	// ParameterTypeString - The parameter's value is a string.
	ParameterTypeString ParameterType = "String"
)

func PossibleParameterTypeValues

func PossibleParameterTypeValues() []ParameterType

PossibleParameterTypeValues returns the possible values for the ParameterType const type.

type PemCertificateList

type PemCertificateList struct {
	// REQUIRED; PEM formatted public certificates. One certificate per entry.
	Certificates []*string `json:"certificates,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

PemCertificateList - A list of PEM formatted certificates.

func (*PemCertificateList) GetCertificateSource added in v0.2.0

func (p *PemCertificateList) GetCertificateSource() *CertificateSource

GetCertificateSource implements the CertificateSourceClassification interface for type PemCertificateList.

func (PemCertificateList) MarshalJSON

func (p PemCertificateList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PemCertificateList.

func (*PemCertificateList) UnmarshalJSON

func (p *PemCertificateList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PemCertificateList.

type PipelineJob

type PipelineJob struct {
	// The resource properties.
	Properties *PipelineJobProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PipelineJob - Pipeline job represents a unique instance of a batch topology, used for offline processing of selected portions of archived content.

type PipelineJobCollection

type PipelineJobCollection struct {
	// A link to the next page of the collection (when the collection contains too many results to return in one response).
	NextLink *string `json:"@nextLink,omitempty"`

	// A collection of PipelineJob items.
	Value []*PipelineJob `json:"value,omitempty"`
}

PipelineJobCollection - A collection of PipelineJob items.

func (PipelineJobCollection) MarshalJSON

func (p PipelineJobCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PipelineJobCollection.

type PipelineJobError

type PipelineJobError struct {
	// The error code.
	Code *string `json:"code,omitempty"`

	// The error message.
	Message *string `json:"message,omitempty"`
}

PipelineJobError - Details about the error for a failed pipeline job.

type PipelineJobOperationStatus

type PipelineJobOperationStatus struct {
	// READ-ONLY; The error details for the pipeline job operation.
	Error *ErrorDetail `json:"error,omitempty" azure:"ro"`

	// READ-ONLY; The name of the pipeline job operation.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The status of the pipeline job operation.
	Status *string `json:"status,omitempty" azure:"ro"`
}

PipelineJobOperationStatus - Used for tracking the status of an operation on the pipeline job.

type PipelineJobOperationStatusesClient

type PipelineJobOperationStatusesClient struct {
	// contains filtered or unexported fields
}

PipelineJobOperationStatusesClient contains the methods for the PipelineJobOperationStatuses group. Don't use this type directly, use NewPipelineJobOperationStatusesClient() instead.

func NewPipelineJobOperationStatusesClient

func NewPipelineJobOperationStatusesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PipelineJobOperationStatusesClient, error)

NewPipelineJobOperationStatusesClient creates a new instance of PipelineJobOperationStatusesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PipelineJobOperationStatusesClient) Get

Get - Get the operation status of a pipeline job with the given operationId. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. pipelineJobName - The pipeline job name. operationID - The operation ID. options - PipelineJobOperationStatusesClientGetOptions contains the optional parameters for the PipelineJobOperationStatusesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-job-operation-status-get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineJobOperationStatusesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<pipeline-job-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type PipelineJobOperationStatusesClientGetOptions added in v0.2.0

type PipelineJobOperationStatusesClientGetOptions struct {
}

PipelineJobOperationStatusesClientGetOptions contains the optional parameters for the PipelineJobOperationStatusesClient.Get method.

type PipelineJobOperationStatusesClientGetResponse added in v0.2.0

type PipelineJobOperationStatusesClientGetResponse struct {
	PipelineJobOperationStatus
}

PipelineJobOperationStatusesClientGetResponse contains the response from method PipelineJobOperationStatusesClient.Get.

type PipelineJobProperties

type PipelineJobProperties struct {
	// REQUIRED; Reference to an existing pipeline topology. When activated, this pipeline job will process content according
	// to the pipeline topology definition.
	TopologyName *string `json:"topologyName,omitempty"`

	// An optional description for the pipeline.
	Description *string `json:"description,omitempty"`

	// List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override
	// parameters values for parameters which have been declared in the referenced
	// topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be
	// optionally be overridden.
	Parameters []*ParameterDefinition `json:"parameters,omitempty"`

	// READ-ONLY; Details about the error, in case the pipeline job fails.
	Error *PipelineJobError `json:"error,omitempty" azure:"ro"`

	// READ-ONLY; The date-time by when this pipeline job will be automatically deleted from your account.
	Expiration *time.Time `json:"expiration,omitempty" azure:"ro"`

	// READ-ONLY; Current state of the pipeline (read-only).
	State *PipelineJobState `json:"state,omitempty" azure:"ro"`
}

PipelineJobProperties - Pipeline job properties.

func (PipelineJobProperties) MarshalJSON

func (p PipelineJobProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PipelineJobProperties.

func (*PipelineJobProperties) UnmarshalJSON

func (p *PipelineJobProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PipelineJobProperties.

type PipelineJobPropertiesUpdate

type PipelineJobPropertiesUpdate struct {
	// An optional description for the pipeline.
	Description *string `json:"description,omitempty"`

	// List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override
	// parameters values for parameters which have been declared in the referenced
	// topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be
	// optionally be overridden.
	Parameters []*ParameterDefinition `json:"parameters,omitempty"`

	// Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline
	// topology definition.
	TopologyName *string `json:"topologyName,omitempty"`

	// READ-ONLY; Details about the error, in case the pipeline job fails.
	Error *PipelineJobError `json:"error,omitempty" azure:"ro"`

	// READ-ONLY; The date-time by when this pipeline job will be automatically deleted from your account.
	Expiration *time.Time `json:"expiration,omitempty" azure:"ro"`

	// READ-ONLY; Current state of the pipeline (read-only).
	State *PipelineJobState `json:"state,omitempty" azure:"ro"`
}

PipelineJobPropertiesUpdate - Pipeline job properties.

func (PipelineJobPropertiesUpdate) MarshalJSON

func (p PipelineJobPropertiesUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PipelineJobPropertiesUpdate.

func (*PipelineJobPropertiesUpdate) UnmarshalJSON

func (p *PipelineJobPropertiesUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PipelineJobPropertiesUpdate.

type PipelineJobState

type PipelineJobState string

PipelineJobState - Current state of the pipeline (read-only).

const (
	// PipelineJobStateCanceled - Pipeline job is canceled.
	PipelineJobStateCanceled PipelineJobState = "Canceled"
	// PipelineJobStateCompleted - Pipeline job completed.
	PipelineJobStateCompleted PipelineJobState = "Completed"
	// PipelineJobStateFailed - Pipeline job failed.
	PipelineJobStateFailed PipelineJobState = "Failed"
	// PipelineJobStateProcessing - Pipeline job is processing.
	PipelineJobStateProcessing PipelineJobState = "Processing"
)

func PossiblePipelineJobStateValues

func PossiblePipelineJobStateValues() []PipelineJobState

PossiblePipelineJobStateValues returns the possible values for the PipelineJobState const type.

type PipelineJobUpdate

type PipelineJobUpdate struct {
	// The resource properties.
	Properties *PipelineJobPropertiesUpdate `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PipelineJobUpdate - Pipeline job represents a unique instance of a batch topology, used for offline processing of selected portions of archived content.

func (PipelineJobUpdate) MarshalJSON

func (p PipelineJobUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PipelineJobUpdate.

type PipelineJobsClient

type PipelineJobsClient struct {
	// contains filtered or unexported fields
}

PipelineJobsClient contains the methods for the PipelineJobs group. Don't use this type directly, use NewPipelineJobsClient() instead.

func NewPipelineJobsClient

func NewPipelineJobsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PipelineJobsClient, error)

NewPipelineJobsClient creates a new instance of PipelineJobsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PipelineJobsClient) BeginCancel

func (client *PipelineJobsClient) BeginCancel(ctx context.Context, resourceGroupName string, accountName string, pipelineJobName string, options *PipelineJobsClientBeginCancelOptions) (*armruntime.Poller[PipelineJobsClientCancelResponse], error)

BeginCancel - Cancels a pipeline job with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. pipelineJobName - The pipeline job name. options - PipelineJobsClientBeginCancelOptions contains the optional parameters for the PipelineJobsClient.BeginCancel method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-job-cancel.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineJobsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCancel(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<pipeline-job-name>",
		&armvideoanalyzer.PipelineJobsClientBeginCancelOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*PipelineJobsClient) CreateOrUpdate

func (client *PipelineJobsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, pipelineJobName string, parameters PipelineJob, options *PipelineJobsClientCreateOrUpdateOptions) (PipelineJobsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new pipeline job or updates an existing one, with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. pipelineJobName - The pipeline job name. parameters - The request parameters options - PipelineJobsClientCreateOrUpdateOptions contains the optional parameters for the PipelineJobsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-job-create.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineJobsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<pipeline-job-name>",
		armvideoanalyzer.PipelineJob{
			Properties: &armvideoanalyzer.PipelineJobProperties{
				Description: to.Ptr("<description>"),
				Parameters: []*armvideoanalyzer.ParameterDefinition{
					{
						Name:  to.Ptr("<name>"),
						Value: to.Ptr("<value>"),
					},
					{
						Name:  to.Ptr("<name>"),
						Value: to.Ptr("<value>"),
					}},
				TopologyName: to.Ptr("<topology-name>"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PipelineJobsClient) Delete

func (client *PipelineJobsClient) Delete(ctx context.Context, resourceGroupName string, accountName string, pipelineJobName string, options *PipelineJobsClientDeleteOptions) (PipelineJobsClientDeleteResponse, error)

Delete - Deletes a pipeline job with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. pipelineJobName - The pipeline job name. options - PipelineJobsClientDeleteOptions contains the optional parameters for the PipelineJobsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-job-delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineJobsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<pipeline-job-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*PipelineJobsClient) Get

func (client *PipelineJobsClient) Get(ctx context.Context, resourceGroupName string, accountName string, pipelineJobName string, options *PipelineJobsClientGetOptions) (PipelineJobsClientGetResponse, error)

Get - Retrieves a specific pipeline job by name. If a pipeline job with that name has been previously created, the call will return the JSON representation of that instance. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. pipelineJobName - The pipeline job name. options - PipelineJobsClientGetOptions contains the optional parameters for the PipelineJobsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-job-get-by-name.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineJobsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<pipeline-job-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PipelineJobsClient) NewListPager added in v0.4.0

func (client *PipelineJobsClient) NewListPager(resourceGroupName string, accountName string, options *PipelineJobsClientListOptions) *runtime.Pager[PipelineJobsClientListResponse]

NewListPager - Retrieves a list of all live pipelines that have been created, along with their JSON representations. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. options - PipelineJobsClientListOptions contains the optional parameters for the PipelineJobsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-job-list.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineJobsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("<resource-group-name>",
		"<account-name>",
		&armvideoanalyzer.PipelineJobsClientListOptions{Filter: nil,
			Top: to.Ptr[int32](2),
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*PipelineJobsClient) Update

func (client *PipelineJobsClient) Update(ctx context.Context, resourceGroupName string, accountName string, pipelineJobName string, parameters PipelineJobUpdate, options *PipelineJobsClientUpdateOptions) (PipelineJobsClientUpdateResponse, error)

Update - Updates an existing pipeline job with the given name. Properties that can be updated include: description. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. pipelineJobName - The pipeline job name. parameters - The request parameters options - PipelineJobsClientUpdateOptions contains the optional parameters for the PipelineJobsClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-job-patch.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineJobsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<pipeline-job-name>",
		armvideoanalyzer.PipelineJobUpdate{
			Properties: &armvideoanalyzer.PipelineJobPropertiesUpdate{
				Description: to.Ptr("<description>"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type PipelineJobsClientBeginCancelOptions added in v0.2.0

type PipelineJobsClientBeginCancelOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PipelineJobsClientBeginCancelOptions contains the optional parameters for the PipelineJobsClient.BeginCancel method.

type PipelineJobsClientCancelResponse added in v0.2.0

type PipelineJobsClientCancelResponse struct {
}

PipelineJobsClientCancelResponse contains the response from method PipelineJobsClient.Cancel.

type PipelineJobsClientCreateOrUpdateOptions added in v0.2.0

type PipelineJobsClientCreateOrUpdateOptions struct {
}

PipelineJobsClientCreateOrUpdateOptions contains the optional parameters for the PipelineJobsClient.CreateOrUpdate method.

type PipelineJobsClientCreateOrUpdateResponse added in v0.2.0

type PipelineJobsClientCreateOrUpdateResponse struct {
	PipelineJob
}

PipelineJobsClientCreateOrUpdateResponse contains the response from method PipelineJobsClient.CreateOrUpdate.

type PipelineJobsClientDeleteOptions added in v0.2.0

type PipelineJobsClientDeleteOptions struct {
}

PipelineJobsClientDeleteOptions contains the optional parameters for the PipelineJobsClient.Delete method.

type PipelineJobsClientDeleteResponse added in v0.2.0

type PipelineJobsClientDeleteResponse struct {
}

PipelineJobsClientDeleteResponse contains the response from method PipelineJobsClient.Delete.

type PipelineJobsClientGetOptions added in v0.2.0

type PipelineJobsClientGetOptions struct {
}

PipelineJobsClientGetOptions contains the optional parameters for the PipelineJobsClient.Get method.

type PipelineJobsClientGetResponse added in v0.2.0

type PipelineJobsClientGetResponse struct {
	PipelineJob
}

PipelineJobsClientGetResponse contains the response from method PipelineJobsClient.Get.

type PipelineJobsClientListOptions added in v0.2.0

type PipelineJobsClientListOptions struct {
	// Restricts the set of items returned.
	Filter *string
	// Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the
	// number of available items up to but not greater than the specified value n.
	Top *int32
}

PipelineJobsClientListOptions contains the optional parameters for the PipelineJobsClient.List method.

type PipelineJobsClientListResponse added in v0.2.0

type PipelineJobsClientListResponse struct {
	PipelineJobCollection
}

PipelineJobsClientListResponse contains the response from method PipelineJobsClient.List.

type PipelineJobsClientUpdateOptions added in v0.2.0

type PipelineJobsClientUpdateOptions struct {
}

PipelineJobsClientUpdateOptions contains the optional parameters for the PipelineJobsClient.Update method.

type PipelineJobsClientUpdateResponse added in v0.2.0

type PipelineJobsClientUpdateResponse struct {
	PipelineJob
}

PipelineJobsClientUpdateResponse contains the response from method PipelineJobsClient.Update.

type PipelineTopologiesClient

type PipelineTopologiesClient struct {
	// contains filtered or unexported fields
}

PipelineTopologiesClient contains the methods for the PipelineTopologies group. Don't use this type directly, use NewPipelineTopologiesClient() instead.

func NewPipelineTopologiesClient

func NewPipelineTopologiesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PipelineTopologiesClient, error)

NewPipelineTopologiesClient creates a new instance of PipelineTopologiesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PipelineTopologiesClient) CreateOrUpdate

func (client *PipelineTopologiesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, pipelineTopologyName string, parameters PipelineTopology, options *PipelineTopologiesClientCreateOrUpdateOptions) (PipelineTopologiesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new pipeline topology or updates an existing one, with the given name. A pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. pipelineTopologyName - Pipeline topology unique identifier. parameters - The request parameters options - PipelineTopologiesClientCreateOrUpdateOptions contains the optional parameters for the PipelineTopologiesClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-topology-create.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineTopologiesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<pipeline-topology-name>",
		armvideoanalyzer.PipelineTopology{
			Kind: to.Ptr(armvideoanalyzer.KindLive),
			Properties: &armvideoanalyzer.PipelineTopologyProperties{
				Description: to.Ptr("<description>"),
				Parameters: []*armvideoanalyzer.ParameterDeclaration{
					{
						Name:        to.Ptr("<name>"),
						Type:        to.Ptr(armvideoanalyzer.ParameterTypeString),
						Description: to.Ptr("<description>"),
						Default:     to.Ptr("<default>"),
					},
					{
						Name:        to.Ptr("<name>"),
						Type:        to.Ptr(armvideoanalyzer.ParameterTypeSecretString),
						Description: to.Ptr("<description>"),
						Default:     to.Ptr("<default>"),
					}},
				Sinks: []armvideoanalyzer.SinkNodeBaseClassification{
					&armvideoanalyzer.VideoSink{
						Name: to.Ptr("<name>"),
						Type: to.Ptr("<type>"),
						Inputs: []*armvideoanalyzer.NodeInput{
							{
								NodeName: to.Ptr("<node-name>"),
							}},
						VideoCreationProperties: &armvideoanalyzer.VideoCreationProperties{
							Description:   to.Ptr("<description>"),
							SegmentLength: to.Ptr("<segment-length>"),
							Title:         to.Ptr("<title>"),
						},
						VideoName: to.Ptr("<video-name>"),
						VideoPublishingOptions: &armvideoanalyzer.VideoPublishingOptions{
							DisableArchive:        to.Ptr("<disable-archive>"),
							DisableRtspPublishing: to.Ptr("<disable-rtsp-publishing>"),
						},
					}},
				Sources: []armvideoanalyzer.SourceNodeBaseClassification{
					&armvideoanalyzer.RtspSource{
						Name: to.Ptr("<name>"),
						Type: to.Ptr("<type>"),
						Endpoint: &armvideoanalyzer.UnsecuredEndpoint{
							Type: to.Ptr("<type>"),
							Credentials: &armvideoanalyzer.UsernamePasswordCredentials{
								Type:     to.Ptr("<type>"),
								Password: to.Ptr("<password>"),
								Username: to.Ptr("<username>"),
							},
							URL: to.Ptr("<url>"),
						},
						Transport: to.Ptr(armvideoanalyzer.RtspTransportHTTP),
					}},
			},
			SKU: &armvideoanalyzer.SKU{
				Name: to.Ptr(armvideoanalyzer.SKUNameLiveS1),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PipelineTopologiesClient) Delete

func (client *PipelineTopologiesClient) Delete(ctx context.Context, resourceGroupName string, accountName string, pipelineTopologyName string, options *PipelineTopologiesClientDeleteOptions) (PipelineTopologiesClientDeleteResponse, error)

Delete - Deletes a pipeline topology with the given name. This method should be called after all instances of the topology have been stopped and deleted. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. pipelineTopologyName - Pipeline topology unique identifier. options - PipelineTopologiesClientDeleteOptions contains the optional parameters for the PipelineTopologiesClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-topology-delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineTopologiesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<pipeline-topology-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*PipelineTopologiesClient) Get

func (client *PipelineTopologiesClient) Get(ctx context.Context, resourceGroupName string, accountName string, pipelineTopologyName string, options *PipelineTopologiesClientGetOptions) (PipelineTopologiesClientGetResponse, error)

Get - Retrieves a specific pipeline topology by name. If a topology with that name has been previously created, the call will return the JSON representation of that topology. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. pipelineTopologyName - Pipeline topology unique identifier. options - PipelineTopologiesClientGetOptions contains the optional parameters for the PipelineTopologiesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-topology-get-by-name.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineTopologiesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<pipeline-topology-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PipelineTopologiesClient) NewListPager added in v0.4.0

func (client *PipelineTopologiesClient) NewListPager(resourceGroupName string, accountName string, options *PipelineTopologiesClientListOptions) *runtime.Pager[PipelineTopologiesClientListResponse]

NewListPager - Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. options - PipelineTopologiesClientListOptions contains the optional parameters for the PipelineTopologiesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-topology-list.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineTopologiesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("<resource-group-name>",
		"<account-name>",
		&armvideoanalyzer.PipelineTopologiesClientListOptions{Filter: nil,
			Top: to.Ptr[int32](2),
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*PipelineTopologiesClient) Update

func (client *PipelineTopologiesClient) Update(ctx context.Context, resourceGroupName string, accountName string, pipelineTopologyName string, parameters PipelineTopologyUpdate, options *PipelineTopologiesClientUpdateOptions) (PipelineTopologiesClientUpdateResponse, error)

Update - Updates an existing pipeline topology with the given name. If the associated live pipelines or pipeline jobs are in active or processing state, respectively, then only the description can be updated. Else, the properties that can be updated include: description, parameter declarations, sources, processors, and sinks. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. pipelineTopologyName - Pipeline topology unique identifier. parameters - The request parameters options - PipelineTopologiesClientUpdateOptions contains the optional parameters for the PipelineTopologiesClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/pipeline-topology-patch.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPipelineTopologiesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<pipeline-topology-name>",
		armvideoanalyzer.PipelineTopologyUpdate{
			Properties: &armvideoanalyzer.PipelineTopologyPropertiesUpdate{
				Description: to.Ptr("<description>"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type PipelineTopologiesClientCreateOrUpdateOptions added in v0.2.0

type PipelineTopologiesClientCreateOrUpdateOptions struct {
}

PipelineTopologiesClientCreateOrUpdateOptions contains the optional parameters for the PipelineTopologiesClient.CreateOrUpdate method.

type PipelineTopologiesClientCreateOrUpdateResponse added in v0.2.0

type PipelineTopologiesClientCreateOrUpdateResponse struct {
	PipelineTopology
}

PipelineTopologiesClientCreateOrUpdateResponse contains the response from method PipelineTopologiesClient.CreateOrUpdate.

type PipelineTopologiesClientDeleteOptions added in v0.2.0

type PipelineTopologiesClientDeleteOptions struct {
}

PipelineTopologiesClientDeleteOptions contains the optional parameters for the PipelineTopologiesClient.Delete method.

type PipelineTopologiesClientDeleteResponse added in v0.2.0

type PipelineTopologiesClientDeleteResponse struct {
}

PipelineTopologiesClientDeleteResponse contains the response from method PipelineTopologiesClient.Delete.

type PipelineTopologiesClientGetOptions added in v0.2.0

type PipelineTopologiesClientGetOptions struct {
}

PipelineTopologiesClientGetOptions contains the optional parameters for the PipelineTopologiesClient.Get method.

type PipelineTopologiesClientGetResponse added in v0.2.0

type PipelineTopologiesClientGetResponse struct {
	PipelineTopology
}

PipelineTopologiesClientGetResponse contains the response from method PipelineTopologiesClient.Get.

type PipelineTopologiesClientListOptions added in v0.2.0

type PipelineTopologiesClientListOptions struct {
	// Restricts the set of items returned.
	Filter *string
	// Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the
	// number of available items up to but not greater than the specified value n.
	Top *int32
}

PipelineTopologiesClientListOptions contains the optional parameters for the PipelineTopologiesClient.List method.

type PipelineTopologiesClientListResponse added in v0.2.0

type PipelineTopologiesClientListResponse struct {
	PipelineTopologyCollection
}

PipelineTopologiesClientListResponse contains the response from method PipelineTopologiesClient.List.

type PipelineTopologiesClientUpdateOptions added in v0.2.0

type PipelineTopologiesClientUpdateOptions struct {
}

PipelineTopologiesClientUpdateOptions contains the optional parameters for the PipelineTopologiesClient.Update method.

type PipelineTopologiesClientUpdateResponse added in v0.2.0

type PipelineTopologiesClientUpdateResponse struct {
	PipelineTopology
}

PipelineTopologiesClientUpdateResponse contains the response from method PipelineTopologiesClient.Update.

type PipelineTopology

type PipelineTopology struct {
	// REQUIRED; Topology kind.
	Kind *Kind `json:"kind,omitempty"`

	// REQUIRED; Describes the properties of a SKU.
	SKU *SKU `json:"sku,omitempty"`

	// The resource properties.
	Properties *PipelineTopologyProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PipelineTopology - Pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which captures content from a RTSP camera and archives the content can be reused across many different cameras, as long as the same processing is to be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized. This allows individual pipelines refer to different values, such as individual cameras' RTSP endpoints and credentials. Overall a topology is composed of the following: * Parameters: list of user defined parameters that can be references across the topology nodes. * Sources: list of one or more data sources nodes such as an RTSP source which allows for content to be ingested from cameras. * Processors: list of nodes which perform data analysis or transformations. * Sinks: list of one or more data sinks which allow for data to be stored or exported to other destinations.

type PipelineTopologyCollection

type PipelineTopologyCollection struct {
	// A link to the next page of the collection (when the collection contains too many results to return in one response).
	NextLink *string `json:"@nextLink,omitempty"`

	// A collection of PipelineTopology items.
	Value []*PipelineTopology `json:"value,omitempty"`
}

PipelineTopologyCollection - A collection of PipelineTopology items.

func (PipelineTopologyCollection) MarshalJSON

func (p PipelineTopologyCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PipelineTopologyCollection.

type PipelineTopologyProperties

type PipelineTopologyProperties struct {
	// REQUIRED; List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.
	Sinks []SinkNodeBaseClassification `json:"sinks,omitempty"`

	// REQUIRED; List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.
	Sources []SourceNodeBaseClassification `json:"sources,omitempty"`

	// An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described
	// here.
	Description *string `json:"description,omitempty"`

	// List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through
	// the use of "${PARAMETER_NAME}" string pattern. Parameters can have
	// optional default values and can later be defined in individual instances of the pipeline.
	Parameters []*ParameterDeclaration `json:"parameters,omitempty"`

	// List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.
	Processors []ProcessorNodeBaseClassification `json:"processors,omitempty"`
}

PipelineTopologyProperties - Describes the properties of a pipeline topology.

func (PipelineTopologyProperties) MarshalJSON

func (p PipelineTopologyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PipelineTopologyProperties.

func (*PipelineTopologyProperties) UnmarshalJSON

func (p *PipelineTopologyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PipelineTopologyProperties.

type PipelineTopologyPropertiesUpdate

type PipelineTopologyPropertiesUpdate struct {
	// An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described
	// here.
	Description *string `json:"description,omitempty"`

	// List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through
	// the use of "${PARAMETER_NAME}" string pattern. Parameters can have
	// optional default values and can later be defined in individual instances of the pipeline.
	Parameters []*ParameterDeclaration `json:"parameters,omitempty"`

	// List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.
	Processors []ProcessorNodeBaseClassification `json:"processors,omitempty"`

	// List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.
	Sinks []SinkNodeBaseClassification `json:"sinks,omitempty"`

	// List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.
	Sources []SourceNodeBaseClassification `json:"sources,omitempty"`
}

PipelineTopologyPropertiesUpdate - Describes the properties of a pipeline topology.

func (PipelineTopologyPropertiesUpdate) MarshalJSON

func (p PipelineTopologyPropertiesUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PipelineTopologyPropertiesUpdate.

func (*PipelineTopologyPropertiesUpdate) UnmarshalJSON

func (p *PipelineTopologyPropertiesUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PipelineTopologyPropertiesUpdate.

type PipelineTopologyUpdate

type PipelineTopologyUpdate struct {
	// Topology kind.
	Kind *Kind `json:"kind,omitempty"`

	// The resource properties.
	Properties *PipelineTopologyPropertiesUpdate `json:"properties,omitempty"`

	// Describes the properties of a SKU.
	SKU *SKU `json:"sku,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PipelineTopologyUpdate - Pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which captures content from a RTSP camera and archives the content can be reused across many different cameras, as long as the same processing is to be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized. This allows individual pipelines refer to different values, such as individual cameras' RTSP endpoints and credentials. Overall a topology is composed of the following: * Parameters: list of user defined parameters that can be references across the topology nodes. * Sources: list of one or more data sources nodes such as an RTSP source which allows for content to be ingested from cameras. * Processors: list of nodes which perform data analysis or transformations. * Sinks: list of one or more data sinks which allow for data to be stored or exported to other destinations.

func (PipelineTopologyUpdate) MarshalJSON

func (p PipelineTopologyUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PipelineTopologyUpdate.

type PrivateEndpoint

type PrivateEndpoint struct {
	// READ-ONLY; The ARM identifier for Private Endpoint
	ID *string `json:"id,omitempty" azure:"ro"`
}

PrivateEndpoint - The Private Endpoint resource.

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	// Resource properties.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointConnection - The Private Endpoint Connection resource.

type PrivateEndpointConnectionListResult

type PrivateEndpointConnectionListResult struct {
	// Array of private endpoint connections
	Value []*PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult - List of private endpoint connection associated with the specified storage account

func (PrivateEndpointConnectionListResult) MarshalJSON

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionOperationStatus added in v0.2.0

type PrivateEndpointConnectionOperationStatus struct {
	// REQUIRED; Operation identifier.
	Name *string `json:"name,omitempty"`

	// Operation end time.
	EndTime *string `json:"endTime,omitempty"`

	// The error detail.
	Error *ErrorDetail `json:"error,omitempty"`

	// Operation resource ID.
	ID *string `json:"id,omitempty"`

	// Operation start time.
	StartTime *string `json:"startTime,omitempty"`

	// Operation status.
	Status *string `json:"status,omitempty"`
}

PrivateEndpointConnectionOperationStatus - Status of private endpoint connection operation.

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// The resource of private end point.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointConnectionProperties - Properties of the PrivateEndpointConnectProperties.

type PrivateEndpointConnectionProvisioningState

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState - The current provisioning state.

const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns the possible values for the PrivateEndpointConnectionProvisioningState const type.

type PrivateEndpointConnectionsClient

type PrivateEndpointConnectionsClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) CreateOrUpdate

CreateOrUpdate - Update private endpoint connection state under video analyzer account. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. name - Private endpoint connection name. parameters - The request parameters options - PrivateEndpointConnectionsClientCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-private-endpoint-connection-put.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<name>",
		armvideoanalyzer.PrivateEndpointConnection{
			Properties: &armvideoanalyzer.PrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armvideoanalyzer.PrivateLinkServiceConnectionState{
					Description: to.Ptr("<description>"),
					Status:      to.Ptr(armvideoanalyzer.PrivateEndpointServiceConnectionStatusApproved),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*PrivateEndpointConnectionsClient) Delete

Delete - Delete private endpoint connection under video analyzer account. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. name - Private endpoint connection name. options - PrivateEndpointConnectionsClientDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-private-endpoint-connection-delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*PrivateEndpointConnectionsClient) Get

Get - Get private endpoint connection under video analyzer account. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. name - Private endpoint connection name. options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-private-endpoint-connection-get-by-name.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PrivateEndpointConnectionsClient) List

List - Get all private endpoint connections under video analyzer account. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. options - PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-private-endpoint-connection-list.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<account-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type PrivateEndpointConnectionsClientCreateOrUpdateOptions added in v0.2.0

type PrivateEndpointConnectionsClientCreateOrUpdateOptions struct {
}

PrivateEndpointConnectionsClientCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.CreateOrUpdate method.

type PrivateEndpointConnectionsClientCreateOrUpdateResponse added in v0.2.0

type PrivateEndpointConnectionsClientCreateOrUpdateResponse struct {
	PrivateEndpointConnection
	// AzureAsyncOperation contains the information returned from the Azure-AsyncOperation header response.
	AzureAsyncOperation *string

	// Location contains the information returned from the Location header response.
	Location *string

	// RetryAfter contains the information returned from the Retry-After header response.
	RetryAfter *int32
}

PrivateEndpointConnectionsClientCreateOrUpdateResponse contains the response from method PrivateEndpointConnectionsClient.CreateOrUpdate.

type PrivateEndpointConnectionsClientDeleteOptions added in v0.2.0

type PrivateEndpointConnectionsClientDeleteOptions struct {
}

PrivateEndpointConnectionsClientDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Delete method.

type PrivateEndpointConnectionsClientDeleteResponse added in v0.2.0

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientGetOptions added in v0.2.0

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.2.0

type PrivateEndpointConnectionsClientGetResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListOptions added in v0.2.0

type PrivateEndpointConnectionsClientListOptions struct {
}

PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.List method.

type PrivateEndpointConnectionsClientListResponse added in v0.2.0

type PrivateEndpointConnectionsClientListResponse struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListResponse contains the response from method PrivateEndpointConnectionsClient.List.

type PrivateEndpointConnectionsOperationResultsClient added in v0.2.0

type PrivateEndpointConnectionsOperationResultsClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionsOperationResultsClient contains the methods for the PrivateEndpointConnectionsOperationResults group. Don't use this type directly, use NewPrivateEndpointConnectionsOperationResultsClient() instead.

func NewPrivateEndpointConnectionsOperationResultsClient added in v0.2.0

func NewPrivateEndpointConnectionsOperationResultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsOperationResultsClient, error)

NewPrivateEndpointConnectionsOperationResultsClient creates a new instance of PrivateEndpointConnectionsOperationResultsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsOperationResultsClient) Get added in v0.2.0

Get - Get private endpoint connection operation result. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. name - Private endpoint connection name. operationID - Operation Id. options - PrivateEndpointConnectionsOperationResultsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsOperationResultsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-private-endpoint-connection-operation-result-by-id.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPrivateEndpointConnectionsOperationResultsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type PrivateEndpointConnectionsOperationResultsClientGetOptions added in v0.2.0

type PrivateEndpointConnectionsOperationResultsClientGetOptions struct {
}

PrivateEndpointConnectionsOperationResultsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsOperationResultsClient.Get method.

type PrivateEndpointConnectionsOperationResultsClientGetResponse added in v0.2.0

type PrivateEndpointConnectionsOperationResultsClientGetResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsOperationResultsClientGetResponse contains the response from method PrivateEndpointConnectionsOperationResultsClient.Get.

type PrivateEndpointConnectionsOperationStatusesClient added in v0.2.0

type PrivateEndpointConnectionsOperationStatusesClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionsOperationStatusesClient contains the methods for the PrivateEndpointConnectionsOperationStatuses group. Don't use this type directly, use NewPrivateEndpointConnectionsOperationStatusesClient() instead.

func NewPrivateEndpointConnectionsOperationStatusesClient added in v0.2.0

func NewPrivateEndpointConnectionsOperationStatusesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsOperationStatusesClient, error)

NewPrivateEndpointConnectionsOperationStatusesClient creates a new instance of PrivateEndpointConnectionsOperationStatusesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsOperationStatusesClient) Get added in v0.2.0

Get - Get private endpoint connection operation status. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. name - Private endpoint connection name. operationID - Operation Id. options - PrivateEndpointConnectionsOperationStatusesClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsOperationStatusesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-private-endpoint-connection-operation-status-by-id-terminal-state.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPrivateEndpointConnectionsOperationStatusesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type PrivateEndpointConnectionsOperationStatusesClientGetOptions added in v0.2.0

type PrivateEndpointConnectionsOperationStatusesClientGetOptions struct {
}

PrivateEndpointConnectionsOperationStatusesClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsOperationStatusesClient.Get method.

type PrivateEndpointConnectionsOperationStatusesClientGetResponse added in v0.2.0

type PrivateEndpointConnectionsOperationStatusesClientGetResponse struct {
	PrivateEndpointConnectionOperationStatus
}

PrivateEndpointConnectionsOperationStatusesClientGetResponse contains the response from method PrivateEndpointConnectionsOperationStatusesClient.Get.

type PrivateEndpointServiceConnectionStatus

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus - The private endpoint connection status.

const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func PossiblePrivateEndpointServiceConnectionStatusValues

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns the possible values for the PrivateEndpointServiceConnectionStatus const type.

type PrivateLinkResource

type PrivateLinkResource struct {
	// Resource properties.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkResource - A private link resource

type PrivateLinkResourceListResult

type PrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult - A list of private link resources

func (PrivateLinkResourceListResult) MarshalJSON

func (p PrivateLinkResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceListResult.

type PrivateLinkResourceProperties

type PrivateLinkResourceProperties struct {
	// The private link resource Private link DNS zone name.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`

	// READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	// contains filtered or unexported fields
}

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkResourcesClient, error)

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) Get

Get - Get group ID for video analyzer account. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. name - Name of the private link resource (Group ID). options - PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-private-link-resources-get-by-name.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PrivateLinkResourcesClient) List

List - Get list of group IDs for video analyzer account. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. options - PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-private-link-resources-list.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<account-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type PrivateLinkResourcesClientGetOptions added in v0.2.0

type PrivateLinkResourcesClientGetOptions struct {
}

PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

type PrivateLinkResourcesClientGetResponse added in v0.2.0

type PrivateLinkResourcesClientGetResponse struct {
	PrivateLinkResource
}

PrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientListOptions added in v0.2.0

type PrivateLinkResourcesClientListOptions struct {
}

PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.List method.

type PrivateLinkResourcesClientListResponse added in v0.2.0

type PrivateLinkResourcesClientListResponse struct {
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientListResponse contains the response from method PrivateLinkResourcesClient.List.

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *string `json:"actionsRequired,omitempty"`

	// The reason for approval/rejection of the connection.
	Description *string `json:"description,omitempty"`

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.

type ProcessorNodeBase

type ProcessorNodeBase struct {
	// REQUIRED; An array of upstream node references within the topology to be used as inputs for this node.
	Inputs []*NodeInput `json:"inputs,omitempty"`

	// REQUIRED; Node name. Must be unique within the topology.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

ProcessorNodeBase - Base class for topology processor nodes.

func (*ProcessorNodeBase) GetNodeBase added in v0.2.0

func (p *ProcessorNodeBase) GetNodeBase() *NodeBase

GetNodeBase implements the NodeBaseClassification interface for type ProcessorNodeBase.

func (*ProcessorNodeBase) GetProcessorNodeBase

func (p *ProcessorNodeBase) GetProcessorNodeBase() *ProcessorNodeBase

GetProcessorNodeBase implements the ProcessorNodeBaseClassification interface for type ProcessorNodeBase.

func (ProcessorNodeBase) MarshalJSON

func (p ProcessorNodeBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProcessorNodeBase.

func (*ProcessorNodeBase) UnmarshalJSON

func (p *ProcessorNodeBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProcessorNodeBase.

type ProcessorNodeBaseClassification

type ProcessorNodeBaseClassification interface {
	NodeBaseClassification
	// GetProcessorNodeBase returns the ProcessorNodeBase content of the underlying type.
	GetProcessorNodeBase() *ProcessorNodeBase
}

ProcessorNodeBaseClassification provides polymorphic access to related types. Call the interface's GetProcessorNodeBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EncoderProcessor, *ProcessorNodeBase

type Properties

type Properties struct {
	// REQUIRED; The storage accounts for this resource.
	StorageAccounts []*StorageAccount `json:"storageAccounts,omitempty"`

	// The account encryption properties.
	Encryption *AccountEncryption `json:"encryption,omitempty"`

	// The IoT Hubs for this resource.
	IotHubs []*IotHub `json:"iotHubs,omitempty"`

	// Network access control for Video Analyzer.
	NetworkAccessControl *NetworkAccessControl `json:"networkAccessControl,omitempty"`

	// Whether or not public network access is allowed for resources under the Video Analyzer account.
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// READ-ONLY; The endpoints associated with this resource.
	Endpoints []*Endpoint `json:"endpoints,omitempty" azure:"ro"`

	// READ-ONLY; Private Endpoint Connections created under Video Analyzer account.
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the Video Analyzer account.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

Properties - The properties of the Video Analyzer account.

func (Properties) MarshalJSON added in v0.2.0

func (p Properties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Properties.

type PropertiesUpdate added in v0.2.0

type PropertiesUpdate struct {
	// The account encryption properties.
	Encryption *AccountEncryption `json:"encryption,omitempty"`

	// The IoT Hubs for this resource.
	IotHubs []*IotHub `json:"iotHubs,omitempty"`

	// Network access control for Video Analyzer.
	NetworkAccessControl *NetworkAccessControl `json:"networkAccessControl,omitempty"`

	// Whether or not public network access is allowed for resources under the Video Analyzer account.
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// The storage accounts for this resource.
	StorageAccounts []*StorageAccount `json:"storageAccounts,omitempty"`

	// READ-ONLY; The endpoints associated with this resource.
	Endpoints []*Endpoint `json:"endpoints,omitempty" azure:"ro"`

	// READ-ONLY; Private Endpoint Connections created under Video Analyzer account.
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state of the Video Analyzer account.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PropertiesUpdate - The properties of the Video Analyzer account.

func (PropertiesUpdate) MarshalJSON added in v0.2.0

func (p PropertiesUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PropertiesUpdate.

type ProvisioningState

type ProvisioningState string

ProvisioningState - Provisioning state of the Video Analyzer account.

const (
	// ProvisioningStateFailed - Provisioning state failed.
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateInProgress - Provisioning state in progress.
	ProvisioningStateInProgress ProvisioningState = "InProgress"
	// ProvisioningStateSucceeded - Provisioning state succeeded.
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyResource

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

type PublicNetworkAccess

type PublicNetworkAccess string

PublicNetworkAccess - Whether or not public network access is allowed for resources under the Video Analyzer account.

const (
	// PublicNetworkAccessDisabled - Public network access is disabled.
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	// PublicNetworkAccessEnabled - Public network access is enabled.
	PublicNetworkAccessEnabled PublicNetworkAccess = "Enabled"
)

func PossiblePublicNetworkAccessValues

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

type Resource

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

type ResourceIdentity

type ResourceIdentity struct {
	// REQUIRED; The user assigned managed identity's resource identifier to use when accessing a resource.
	UserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`
}

ResourceIdentity - The user assigned managed identity to use when accessing a resource.

type RsaTokenKey

type RsaTokenKey struct {
	// REQUIRED; RSA algorithm to be used: RS256, RS384 or RS512.
	Alg *AccessPolicyRsaAlgo `json:"alg,omitempty"`

	// REQUIRED; RSA public key exponent.
	E *string `json:"e,omitempty"`

	// REQUIRED; JWT token key id. Validation keys are looked up based on the key id present on the JWT token header.
	Kid *string `json:"kid,omitempty"`

	// REQUIRED; RSA public key modulus.
	N *string `json:"n,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

RsaTokenKey - Required validation properties for tokens generated with RSA algorithm.

func (*RsaTokenKey) GetTokenKey added in v0.2.0

func (r *RsaTokenKey) GetTokenKey() *TokenKey

GetTokenKey implements the TokenKeyClassification interface for type RsaTokenKey.

func (RsaTokenKey) MarshalJSON

func (r RsaTokenKey) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RsaTokenKey.

func (*RsaTokenKey) UnmarshalJSON

func (r *RsaTokenKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RsaTokenKey.

type RtspSource

type RtspSource struct {
	// REQUIRED; RTSP endpoint information for Video Analyzer to connect to. This contains the required information for Video
	// Analyzer to connect to RTSP cameras and/or generic RTSP servers.
	Endpoint EndpointBaseClassification `json:"endpoint,omitempty"`

	// REQUIRED; Node name. Must be unique within the topology.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// Network transport utilized by the RTSP and RTP exchange: TCP or HTTP. When using TCP, the RTP packets are interleaved on
	// the TCP RTSP connection. When using HTTP, the RTSP messages are exchanged
	// through long lived HTTP connections, and the RTP packages are interleaved in the HTTP connections alongside the RTSP messages.
	Transport *RtspTransport `json:"transport,omitempty"`
}

RtspSource - RTSP source allows for media from an RTSP camera or generic RTSP server to be ingested into a pipeline.

func (*RtspSource) GetNodeBase added in v0.2.0

func (r *RtspSource) GetNodeBase() *NodeBase

GetNodeBase implements the NodeBaseClassification interface for type RtspSource.

func (*RtspSource) GetSourceNodeBase added in v0.2.0

func (r *RtspSource) GetSourceNodeBase() *SourceNodeBase

GetSourceNodeBase implements the SourceNodeBaseClassification interface for type RtspSource.

func (RtspSource) MarshalJSON

func (r RtspSource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RtspSource.

func (*RtspSource) UnmarshalJSON

func (r *RtspSource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RtspSource.

type RtspTransport

type RtspTransport string

RtspTransport - Network transport utilized by the RTSP and RTP exchange: TCP or HTTP. When using TCP, the RTP packets are interleaved on the TCP RTSP connection. When using HTTP, the RTSP messages are exchanged through long lived HTTP connections, and the RTP packages are interleaved in the HTTP connections alongside the RTSP messages.

const (
	// RtspTransportHTTP - HTTP transport. RTSP messages are exchanged over long running HTTP requests and RTP packets are interleaved
	// within the HTTP channel.
	RtspTransportHTTP RtspTransport = "Http"
	// RtspTransportTCP - TCP transport. RTSP is used directly over TCP and RTP packets are interleaved within the TCP channel.
	RtspTransportTCP RtspTransport = "Tcp"
)

func PossibleRtspTransportValues

func PossibleRtspTransportValues() []RtspTransport

PossibleRtspTransportValues returns the possible values for the RtspTransport const type.

type SKU

type SKU struct {
	// REQUIRED; The SKU name.
	Name *SKUName `json:"name,omitempty"`

	// READ-ONLY; The SKU tier.
	Tier *SKUTier `json:"tier,omitempty" azure:"ro"`
}

SKU - The SKU details.

type SKUName

type SKUName string

SKUName - The SKU name.

const (
	// SKUNameBatchS1 - Represents the Batch S1 SKU name. Using this SKU you can create pipeline jobs to process recorded content.
	SKUNameBatchS1 SKUName = "Batch_S1"
	// SKUNameLiveS1 - Represents the Live S1 SKU name. Using this SKU you can create live pipelines to capture, record, and stream
	// live video from RTSP-capable cameras at bitrate settings from 0.5 Kbps to 3000 Kbps.
	SKUNameLiveS1 SKUName = "Live_S1"
)

func PossibleSKUNameValues

func PossibleSKUNameValues() []SKUName

PossibleSKUNameValues returns the possible values for the SKUName const type.

type SKUTier

type SKUTier string

SKUTier - The SKU tier.

const (
	// SKUTierStandard - Standard tier.
	SKUTierStandard SKUTier = "Standard"
)

func PossibleSKUTierValues

func PossibleSKUTierValues() []SKUTier

PossibleSKUTierValues returns the possible values for the SKUTier const type.

type SecureIotDeviceRemoteTunnel

type SecureIotDeviceRemoteTunnel struct {
	// REQUIRED; The IoT device id to use when establishing the remote tunnel. This string is case-sensitive.
	DeviceID *string `json:"deviceId,omitempty"`

	// REQUIRED; Name of the IoT Hub.
	IotHubName *string `json:"iotHubName,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

SecureIotDeviceRemoteTunnel - A remote tunnel securely established using IoT Hub device information.

func (*SecureIotDeviceRemoteTunnel) GetTunnelBase added in v0.2.0

func (s *SecureIotDeviceRemoteTunnel) GetTunnelBase() *TunnelBase

GetTunnelBase implements the TunnelBaseClassification interface for type SecureIotDeviceRemoteTunnel.

func (SecureIotDeviceRemoteTunnel) MarshalJSON

func (s SecureIotDeviceRemoteTunnel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecureIotDeviceRemoteTunnel.

func (*SecureIotDeviceRemoteTunnel) UnmarshalJSON

func (s *SecureIotDeviceRemoteTunnel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecureIotDeviceRemoteTunnel.

type ServiceSpecification

type ServiceSpecification struct {
	// READ-ONLY; List of log specifications.
	LogSpecifications []*LogSpecification `json:"logSpecifications,omitempty" azure:"ro"`

	// READ-ONLY; List of metric specifications.
	MetricSpecifications []*MetricSpecification `json:"metricSpecifications,omitempty" azure:"ro"`
}

ServiceSpecification - The service metric specifications.

func (ServiceSpecification) MarshalJSON

func (s ServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceSpecification.

type SinkNodeBase

type SinkNodeBase struct {
	// REQUIRED; An array of upstream node references within the topology to be used as inputs for this node.
	Inputs []*NodeInput `json:"inputs,omitempty"`

	// REQUIRED; Node name. Must be unique within the topology.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

SinkNodeBase - Base class for topology sink nodes.

func (*SinkNodeBase) GetNodeBase added in v0.2.0

func (s *SinkNodeBase) GetNodeBase() *NodeBase

GetNodeBase implements the NodeBaseClassification interface for type SinkNodeBase.

func (*SinkNodeBase) GetSinkNodeBase

func (s *SinkNodeBase) GetSinkNodeBase() *SinkNodeBase

GetSinkNodeBase implements the SinkNodeBaseClassification interface for type SinkNodeBase.

func (SinkNodeBase) MarshalJSON

func (s SinkNodeBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SinkNodeBase.

func (*SinkNodeBase) UnmarshalJSON

func (s *SinkNodeBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SinkNodeBase.

type SinkNodeBaseClassification

type SinkNodeBaseClassification interface {
	NodeBaseClassification
	// GetSinkNodeBase returns the SinkNodeBase content of the underlying type.
	GetSinkNodeBase() *SinkNodeBase
}

SinkNodeBaseClassification provides polymorphic access to related types. Call the interface's GetSinkNodeBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *SinkNodeBase, *VideoSink

type SourceNodeBase

type SourceNodeBase struct {
	// REQUIRED; Node name. Must be unique within the topology.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

SourceNodeBase - Base class for topology source nodes.

func (*SourceNodeBase) GetNodeBase added in v0.2.0

func (s *SourceNodeBase) GetNodeBase() *NodeBase

GetNodeBase implements the NodeBaseClassification interface for type SourceNodeBase.

func (*SourceNodeBase) GetSourceNodeBase

func (s *SourceNodeBase) GetSourceNodeBase() *SourceNodeBase

GetSourceNodeBase implements the SourceNodeBaseClassification interface for type SourceNodeBase.

func (SourceNodeBase) MarshalJSON

func (s SourceNodeBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceNodeBase.

func (*SourceNodeBase) UnmarshalJSON added in v0.2.0

func (s *SourceNodeBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SourceNodeBase.

type SourceNodeBaseClassification

type SourceNodeBaseClassification interface {
	NodeBaseClassification
	// GetSourceNodeBase returns the SourceNodeBase content of the underlying type.
	GetSourceNodeBase() *SourceNodeBase
}

SourceNodeBaseClassification provides polymorphic access to related types. Call the interface's GetSourceNodeBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *RtspSource, *SourceNodeBase, *VideoSource

type StorageAccount

type StorageAccount struct {
	// REQUIRED; The ID of the storage account resource. Video Analyzer relies on tables, queues, and blobs. The primary storage
	// account must be a Standard Storage account (either Microsoft.ClassicStorage or
	// Microsoft.Storage).
	ID *string `json:"id,omitempty"`

	// A managed identity that Video Analyzer will use to access the storage account.
	Identity *ResourceIdentity `json:"identity,omitempty"`

	// READ-ONLY; The current status of the storage account mapping.
	Status *string `json:"status,omitempty" azure:"ro"`
}

StorageAccount - The details about the associated storage account.

type SystemData

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TLSEndpoint

type TLSEndpoint struct {
	// REQUIRED; Credentials to be presented to the endpoint.
	Credentials CredentialsBaseClassification `json:"credentials,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// REQUIRED; The endpoint URL for Video Analyzer to connect to.
	URL *string `json:"url,omitempty"`

	// List of trusted certificate authorities when authenticating a TLS connection. A null list designates that Azure Video Analyzer's
	// list of trusted authorities should be used.
	TrustedCertificates CertificateSourceClassification `json:"trustedCertificates,omitempty"`

	// Describes the tunnel through which Video Analyzer can connect to the endpoint URL. This is an optional property, typically
	// used when the endpoint is behind a firewall.
	Tunnel TunnelBaseClassification `json:"tunnel,omitempty"`

	// Validation options to use when authenticating a TLS connection. By default, strict validation is used.
	ValidationOptions *TLSValidationOptions `json:"validationOptions,omitempty"`
}

TLSEndpoint - TLS endpoint describes an endpoint that the pipeline can connect to over TLS transport (data is encrypted in transit).

func (*TLSEndpoint) GetEndpointBase added in v0.2.0

func (t *TLSEndpoint) GetEndpointBase() *EndpointBase

GetEndpointBase implements the EndpointBaseClassification interface for type TLSEndpoint.

func (TLSEndpoint) MarshalJSON

func (t TLSEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TLSEndpoint.

func (*TLSEndpoint) UnmarshalJSON

func (t *TLSEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TLSEndpoint.

type TLSValidationOptions

type TLSValidationOptions struct {
	// When set to 'true' causes the certificate subject name validation to be skipped. Default is 'false'.
	IgnoreHostname *string `json:"ignoreHostname,omitempty"`

	// When set to 'true' causes the certificate chain trust validation to be skipped. Default is 'false'.
	IgnoreSignature *string `json:"ignoreSignature,omitempty"`
}

TLSValidationOptions - Options for controlling the validation of TLS endpoints.

type TimeSequenceBase

type TimeSequenceBase struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

TimeSequenceBase - A sequence of datetime ranges as a string.

func (*TimeSequenceBase) GetTimeSequenceBase

func (t *TimeSequenceBase) GetTimeSequenceBase() *TimeSequenceBase

GetTimeSequenceBase implements the TimeSequenceBaseClassification interface for type TimeSequenceBase.

type TimeSequenceBaseClassification

type TimeSequenceBaseClassification interface {
	// GetTimeSequenceBase returns the TimeSequenceBase content of the underlying type.
	GetTimeSequenceBase() *TimeSequenceBase
}

TimeSequenceBaseClassification provides polymorphic access to related types. Call the interface's GetTimeSequenceBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *TimeSequenceBase, *VideoSequenceAbsoluteTimeMarkers

type TokenClaim

type TokenClaim struct {
	// REQUIRED; Name of the claim which must be present on the token.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Expected value of the claim to be present on the token.
	Value *string `json:"value,omitempty"`
}

TokenClaim - Properties for expected token claims.

type TokenKey

type TokenKey struct {
	// REQUIRED; JWT token key id. Validation keys are looked up based on the key id present on the JWT token header.
	Kid *string `json:"kid,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

TokenKey - Key properties for JWT token validation.

func (*TokenKey) GetTokenKey

func (t *TokenKey) GetTokenKey() *TokenKey

GetTokenKey implements the TokenKeyClassification interface for type TokenKey.

type TokenKeyClassification

type TokenKeyClassification interface {
	// GetTokenKey returns the TokenKey content of the underlying type.
	GetTokenKey() *TokenKey
}

TokenKeyClassification provides polymorphic access to related types. Call the interface's GetTokenKey() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EccTokenKey, *RsaTokenKey, *TokenKey

type TrackedResource

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

type TunnelBase

type TunnelBase struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

TunnelBase - Base class for tunnel objects.

func (*TunnelBase) GetTunnelBase

func (t *TunnelBase) GetTunnelBase() *TunnelBase

GetTunnelBase implements the TunnelBaseClassification interface for type TunnelBase.

type TunnelBaseClassification

type TunnelBaseClassification interface {
	// GetTunnelBase returns the TunnelBase content of the underlying type.
	GetTunnelBase() *TunnelBase
}

TunnelBaseClassification provides polymorphic access to related types. Call the interface's GetTunnelBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *SecureIotDeviceRemoteTunnel, *TunnelBase

type UnsecuredEndpoint

type UnsecuredEndpoint struct {
	// REQUIRED; Credentials to be presented to the endpoint.
	Credentials CredentialsBaseClassification `json:"credentials,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// REQUIRED; The endpoint URL for Video Analyzer to connect to.
	URL *string `json:"url,omitempty"`

	// Describes the tunnel through which Video Analyzer can connect to the endpoint URL. This is an optional property, typically
	// used when the endpoint is behind a firewall.
	Tunnel TunnelBaseClassification `json:"tunnel,omitempty"`
}

UnsecuredEndpoint - Unsecured endpoint describes an endpoint that the pipeline can connect to over clear transport (no encryption in transit).

func (*UnsecuredEndpoint) GetEndpointBase added in v0.2.0

func (u *UnsecuredEndpoint) GetEndpointBase() *EndpointBase

GetEndpointBase implements the EndpointBaseClassification interface for type UnsecuredEndpoint.

func (UnsecuredEndpoint) MarshalJSON

func (u UnsecuredEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UnsecuredEndpoint.

func (*UnsecuredEndpoint) UnmarshalJSON added in v0.2.0

func (u *UnsecuredEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UnsecuredEndpoint.

type Update added in v0.2.0

type Update struct {
	// The identities associated to the Video Analyzer resource.
	Identity *Identity `json:"identity,omitempty"`

	// The resource properties.
	Properties *PropertiesUpdate `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

Update - The update operation for a Video Analyzer account.

func (Update) MarshalJSON added in v0.2.0

func (u Update) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Update.

type UserAssignedManagedIdentity

type UserAssignedManagedIdentity struct {
	// READ-ONLY; The client ID.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; The principal ID.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

UserAssignedManagedIdentity - The details of the user assigned managed identity used by the Video Analyzer resource.

type UsernamePasswordCredentials

type UsernamePasswordCredentials struct {
	// REQUIRED; Password to be presented as part of the credentials. It is recommended that this value is parameterized as a
	// secret string in order to prevent this value to be returned as part of the resource on API
	// requests.
	Password *string `json:"password,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// REQUIRED; Username to be presented as part of the credentials.
	Username *string `json:"username,omitempty"`
}

UsernamePasswordCredentials - Username and password credentials.

func (*UsernamePasswordCredentials) GetCredentialsBase added in v0.2.0

func (u *UsernamePasswordCredentials) GetCredentialsBase() *CredentialsBase

GetCredentialsBase implements the CredentialsBaseClassification interface for type UsernamePasswordCredentials.

func (UsernamePasswordCredentials) MarshalJSON

func (u UsernamePasswordCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UsernamePasswordCredentials.

func (*UsernamePasswordCredentials) UnmarshalJSON

func (u *UsernamePasswordCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UsernamePasswordCredentials.

type VideoAnalyzer

type VideoAnalyzer struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// The identities associated to the Video Analyzer resource.
	Identity *Identity `json:"identity,omitempty"`

	// The resource properties.
	Properties *Properties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

VideoAnalyzer - The Video Analyzer account.

func (VideoAnalyzer) MarshalJSON

func (v VideoAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VideoAnalyzer.

type VideoAnalyzerEndpointType

type VideoAnalyzerEndpointType string

VideoAnalyzerEndpointType - The type of the endpoint.

const (
	// VideoAnalyzerEndpointTypeClientAPI - The client API endpoint.
	VideoAnalyzerEndpointTypeClientAPI VideoAnalyzerEndpointType = "ClientApi"
)

func PossibleVideoAnalyzerEndpointTypeValues

func PossibleVideoAnalyzerEndpointTypeValues() []VideoAnalyzerEndpointType

PossibleVideoAnalyzerEndpointTypeValues returns the possible values for the VideoAnalyzerEndpointType const type.

type VideoAnalyzersClient

type VideoAnalyzersClient struct {
	// contains filtered or unexported fields
}

VideoAnalyzersClient contains the methods for the VideoAnalyzers group. Don't use this type directly, use NewVideoAnalyzersClient() instead.

func NewVideoAnalyzersClient

func NewVideoAnalyzersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VideoAnalyzersClient, error)

NewVideoAnalyzersClient creates a new instance of VideoAnalyzersClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VideoAnalyzersClient) BeginCreateOrUpdate

BeginCreateOrUpdate - Create or update an instance of a Video Analyzer account If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. parameters - The request parameters options - VideoAnalyzersClientBeginCreateOrUpdateOptions contains the optional parameters for the VideoAnalyzersClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-accounts-create-or-update.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideoAnalyzersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<account-name>",
		armvideoanalyzer.VideoAnalyzer{
			Location: to.Ptr("<location>"),
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
			Identity: &armvideoanalyzer.Identity{
				Type: to.Ptr("<type>"),
				UserAssignedIdentities: map[string]*armvideoanalyzer.UserAssignedManagedIdentity{
					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {},
					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id3": {},
				},
			},
			Properties: &armvideoanalyzer.Properties{
				Encryption: &armvideoanalyzer.AccountEncryption{
					Type: to.Ptr(armvideoanalyzer.AccountEncryptionKeyTypeSystemKey),
				},
				IotHubs: []*armvideoanalyzer.IotHub{
					{
						ID: to.Ptr("<id>"),
						Identity: &armvideoanalyzer.ResourceIdentity{
							UserAssignedIdentity: to.Ptr("<user-assigned-identity>"),
						},
					},
					{
						ID: to.Ptr("<id>"),
						Identity: &armvideoanalyzer.ResourceIdentity{
							UserAssignedIdentity: to.Ptr("<user-assigned-identity>"),
						},
					}},
				StorageAccounts: []*armvideoanalyzer.StorageAccount{
					{
						ID: to.Ptr("<id>"),
						Identity: &armvideoanalyzer.ResourceIdentity{
							UserAssignedIdentity: to.Ptr("<user-assigned-identity>"),
						},
					}},
			},
		},
		&armvideoanalyzer.VideoAnalyzersClientBeginCreateOrUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*VideoAnalyzersClient) BeginUpdate

func (client *VideoAnalyzersClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, parameters Update, options *VideoAnalyzersClientBeginUpdateOptions) (*armruntime.Poller[VideoAnalyzersClientUpdateResponse], error)

BeginUpdate - Updates an existing instance of Video Analyzer account If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. parameters - The request parameters options - VideoAnalyzersClientBeginUpdateOptions contains the optional parameters for the VideoAnalyzersClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-accounts-update.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideoAnalyzersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<account-name>",
		armvideoanalyzer.Update{
			Tags: map[string]*string{
				"key1": to.Ptr("value3"),
			},
		},
		&armvideoanalyzer.VideoAnalyzersClientBeginUpdateOptions{ResumeToken: ""})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*VideoAnalyzersClient) Delete

func (client *VideoAnalyzersClient) Delete(ctx context.Context, resourceGroupName string, accountName string, options *VideoAnalyzersClientDeleteOptions) (VideoAnalyzersClientDeleteResponse, error)

Delete - Delete the specified Video Analyzer account If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. options - VideoAnalyzersClientDeleteOptions contains the optional parameters for the VideoAnalyzersClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-accounts-delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideoAnalyzersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<account-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*VideoAnalyzersClient) Get

func (client *VideoAnalyzersClient) Get(ctx context.Context, resourceGroupName string, accountName string, options *VideoAnalyzersClientGetOptions) (VideoAnalyzersClientGetResponse, error)

Get - Get the details of the specified Video Analyzer account If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Video Analyzer account name. options - VideoAnalyzersClientGetOptions contains the optional parameters for the VideoAnalyzersClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-accounts-get-by-name.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideoAnalyzersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*VideoAnalyzersClient) List

List - Lists the Video Analyzer accounts in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. options - VideoAnalyzersClientListOptions contains the optional parameters for the VideoAnalyzersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-accounts-list-all-accounts.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideoAnalyzersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		"<resource-group-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*VideoAnalyzersClient) ListBySubscription

ListBySubscription - List all Video Analyzer accounts in the specified subscription. If the operation fails it returns an *azcore.ResponseError type. options - VideoAnalyzersClientListBySubscriptionOptions contains the optional parameters for the VideoAnalyzersClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-analyzer-accounts-subscription-list-all-accounts.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideoAnalyzersClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListBySubscription(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type VideoAnalyzersClientBeginCreateOrUpdateOptions added in v0.2.0

type VideoAnalyzersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VideoAnalyzersClientBeginCreateOrUpdateOptions contains the optional parameters for the VideoAnalyzersClient.BeginCreateOrUpdate method.

type VideoAnalyzersClientBeginUpdateOptions added in v0.2.0

type VideoAnalyzersClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VideoAnalyzersClientBeginUpdateOptions contains the optional parameters for the VideoAnalyzersClient.BeginUpdate method.

type VideoAnalyzersClientCreateOrUpdateResponse added in v0.2.0

type VideoAnalyzersClientCreateOrUpdateResponse struct {
	VideoAnalyzer
}

VideoAnalyzersClientCreateOrUpdateResponse contains the response from method VideoAnalyzersClient.CreateOrUpdate.

type VideoAnalyzersClientDeleteOptions added in v0.2.0

type VideoAnalyzersClientDeleteOptions struct {
}

VideoAnalyzersClientDeleteOptions contains the optional parameters for the VideoAnalyzersClient.Delete method.

type VideoAnalyzersClientDeleteResponse added in v0.2.0

type VideoAnalyzersClientDeleteResponse struct {
}

VideoAnalyzersClientDeleteResponse contains the response from method VideoAnalyzersClient.Delete.

type VideoAnalyzersClientGetOptions added in v0.2.0

type VideoAnalyzersClientGetOptions struct {
}

VideoAnalyzersClientGetOptions contains the optional parameters for the VideoAnalyzersClient.Get method.

type VideoAnalyzersClientGetResponse added in v0.2.0

type VideoAnalyzersClientGetResponse struct {
	VideoAnalyzer
}

VideoAnalyzersClientGetResponse contains the response from method VideoAnalyzersClient.Get.

type VideoAnalyzersClientListBySubscriptionOptions added in v0.2.0

type VideoAnalyzersClientListBySubscriptionOptions struct {
}

VideoAnalyzersClientListBySubscriptionOptions contains the optional parameters for the VideoAnalyzersClient.ListBySubscription method.

type VideoAnalyzersClientListBySubscriptionResponse added in v0.2.0

type VideoAnalyzersClientListBySubscriptionResponse struct {
	Collection
}

VideoAnalyzersClientListBySubscriptionResponse contains the response from method VideoAnalyzersClient.ListBySubscription.

type VideoAnalyzersClientListOptions added in v0.2.0

type VideoAnalyzersClientListOptions struct {
}

VideoAnalyzersClientListOptions contains the optional parameters for the VideoAnalyzersClient.List method.

type VideoAnalyzersClientListResponse added in v0.2.0

type VideoAnalyzersClientListResponse struct {
	Collection
}

VideoAnalyzersClientListResponse contains the response from method VideoAnalyzersClient.List.

type VideoAnalyzersClientUpdateResponse added in v0.2.0

type VideoAnalyzersClientUpdateResponse struct {
	VideoAnalyzer
}

VideoAnalyzersClientUpdateResponse contains the response from method VideoAnalyzersClient.Update.

type VideoArchival

type VideoArchival struct {
	// Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage.
	// It must be provided in the ISO8601 duration format in the granularity of days,
	// up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically
	// deleted. This value can be updated at any time and the new desired retention
	// period will be effective within 24 hours.
	RetentionPeriod *string `json:"retentionPeriod,omitempty"`
}

VideoArchival - Video archival properties.

type VideoContentToken

type VideoContentToken struct {
	// READ-ONLY; The content token expiration date in ISO8601 format (eg. 2021-01-01T00:00:00Z).
	ExpirationDate *time.Time `json:"expirationDate,omitempty" azure:"ro"`

	// READ-ONLY; The content token value to be added to the video content URL as the value for the "token" query string parameter.
	// The token is specific to a single video.
	Token *string `json:"token,omitempty" azure:"ro"`
}

VideoContentToken - "Video content token grants access to the video content URLs."

func (VideoContentToken) MarshalJSON

func (v VideoContentToken) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VideoContentToken.

func (*VideoContentToken) UnmarshalJSON

func (v *VideoContentToken) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VideoContentToken.

type VideoContentUrls

type VideoContentUrls struct {
	// Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget.
	// Alternatively, this URL can be used in conjunction with the video content
	// authorization token on any compatible DASH or HLS players by appending the following to the base URL:
	// - HLSv4: /manifest(format=m3u8-aapl).m3u8
	// - HLS CMAF: /manifest(format=m3u8-cmaf)
	// - DASH CMAF: /manifest(format=mpd-time-cmaf)
	// Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the
	// chosen video segment length. It is available when the video type is 'archive' and video archiving is enabled.
	ArchiveBaseURL *string `json:"archiveBaseUrl,omitempty"`

	// Video file download URL. This URL can be used in conjunction with the video content authorization token to download the
	// video MP4 file. The resulting MP4 file can be played on any standard media
	// player. It is available when the video type is 'file' and video file is available for consumption.
	DownloadURL *string `json:"downloadUrl,omitempty"`

	// Video preview image URLs. These URLs can be used in conjunction with the video content authorization token to download
	// the most recent still image from the video archive in different resolutions. They
	// are available when the video type is 'archive' and preview images are enabled.
	PreviewImageUrls *VideoPreviewImageUrls `json:"previewImageUrls,omitempty"`

	// Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget.
	// Alternatively, this URL can be used in conjunction with the video content
	// authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is 'archive' and a
	// live, low-latency feed is available from the source.
	RtspTunnelURL *string `json:"rtspTunnelUrl,omitempty"`
}

VideoContentUrls - Set of URLs to the video content.

type VideoCreationProperties

type VideoCreationProperties struct {
	// Optional description provided by the user. Value can be up to 2048 characters long.
	Description *string `json:"description,omitempty"`

	// Video retention period indicates how long the video is kept in storage. Value must be specified in ISO8601 duration format
	// (i.e. "P1D" equals 1 day) and can vary between 1 day to 10 years, in 1 day
	// increments. When absent (null), all video content is retained indefinitely. This property is only allowed for topologies
	// where "kind" is set to "live".
	RetentionPeriod *string `json:"retentionPeriod,omitempty"`

	// Segment length indicates the length of individual content files (segments) which are persisted to storage. Smaller segments
	// provide lower archive playback latency but generate larger volume of storage
	// transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency.
	// Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30
	// seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments. Changing this value after the initial
	// call to create the video resource can lead to errors when uploading content to
	// the archive. Default value is 30 seconds. This property is only allowed for topologies where "kind" is set to "live".
	SegmentLength *string `json:"segmentLength,omitempty"`

	// Optional title provided by the user. Value can be up to 256 characters long.
	Title *string `json:"title,omitempty"`
}

VideoCreationProperties - Optional properties to be used in case a new video resource needs to be created on the service. These will not take effect if the video already exists.

type VideoEncoderBase

type VideoEncoderBase struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// The maximum bitrate, in kilobits per second or Kbps, at which video should be encoded. If omitted, encoder sets it automatically
	// to try and match the quality of the input video.
	BitrateKbps *string `json:"bitrateKbps,omitempty"`

	// The frame rate (in frames per second) of the encoded video. The value must be greater than zero, and less than or equal
	// to 300. If omitted, the encoder uses the average frame rate of the input video.
	FrameRate *string `json:"frameRate,omitempty"`

	// Describes the resolution of the encoded video. If omitted, the encoder uses the resolution of the input video.
	Scale *VideoScale `json:"scale,omitempty"`
}

VideoEncoderBase - Base type for all video encoding presets, which define the recipe or instructions on how the input video should be processed.

func (*VideoEncoderBase) GetVideoEncoderBase

func (v *VideoEncoderBase) GetVideoEncoderBase() *VideoEncoderBase

GetVideoEncoderBase implements the VideoEncoderBaseClassification interface for type VideoEncoderBase.

type VideoEncoderBaseClassification

type VideoEncoderBaseClassification interface {
	// GetVideoEncoderBase returns the VideoEncoderBase content of the underlying type.
	GetVideoEncoderBase() *VideoEncoderBase
}

VideoEncoderBaseClassification provides polymorphic access to related types. Call the interface's GetVideoEncoderBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *VideoEncoderBase, *VideoEncoderH264

type VideoEncoderH264

type VideoEncoderH264 struct {
	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// The maximum bitrate, in kilobits per second or Kbps, at which video should be encoded. If omitted, encoder sets it automatically
	// to try and match the quality of the input video.
	BitrateKbps *string `json:"bitrateKbps,omitempty"`

	// The frame rate (in frames per second) of the encoded video. The value must be greater than zero, and less than or equal
	// to 300. If omitted, the encoder uses the average frame rate of the input video.
	FrameRate *string `json:"frameRate,omitempty"`

	// Describes the resolution of the encoded video. If omitted, the encoder uses the resolution of the input video.
	Scale *VideoScale `json:"scale,omitempty"`
}

VideoEncoderH264 - A custom preset for encoding video with the H.264 (AVC) codec.

func (*VideoEncoderH264) GetVideoEncoderBase added in v0.2.0

func (v *VideoEncoderH264) GetVideoEncoderBase() *VideoEncoderBase

GetVideoEncoderBase implements the VideoEncoderBaseClassification interface for type VideoEncoderH264.

func (VideoEncoderH264) MarshalJSON

func (v VideoEncoderH264) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VideoEncoderH264.

func (*VideoEncoderH264) UnmarshalJSON added in v0.2.0

func (v *VideoEncoderH264) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VideoEncoderH264.

type VideoEntity

type VideoEntity struct {
	// The resource properties.
	Properties *VideoProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

VideoEntity - Represents a video resource within Azure Video Analyzer. Videos can be ingested from RTSP cameras through live pipelines or can be created by exporting sequences from existing captured video through a pipeline job. Videos ingested through live pipelines can be streamed through Azure Video Analyzer Player Widget or compatible players. Exported videos can be downloaded as MP4 files.

func (VideoEntity) MarshalJSON

func (v VideoEntity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VideoEntity.

type VideoEntityCollection

type VideoEntityCollection struct {
	// A link to the next page of the collection (when the collection contains too many results to return in one response).
	NextLink *string `json:"@nextLink,omitempty"`

	// A collection of VideoEntity items.
	Value []*VideoEntity `json:"value,omitempty"`
}

VideoEntityCollection - A collection of VideoEntity items.

func (VideoEntityCollection) MarshalJSON

func (v VideoEntityCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VideoEntityCollection.

type VideoFlags

type VideoFlags struct {
	// REQUIRED; Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.
	CanStream *bool `json:"canStream,omitempty"`

	// REQUIRED; Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos
	// have this value set to false.
	HasData *bool `json:"hasData,omitempty"`

	// REQUIRED; Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that
	// is being referenced, doesn't necessarily indicate that data is being received. For example,
	// video recording may be gated on events or camera may not be accessible at the time.
	IsInUse *bool `json:"isInUse,omitempty"`
}

VideoFlags - Video flags contain information about the available video actions and its dynamic properties based on the current video state.

type VideoMediaInfo

type VideoMediaInfo struct {
	// Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller
	// segments provide lower archive playback latency but generate larger volume of
	// storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency.
	// Value must be specified in ISO8601 duration format (i.e. "PT30S" equals
	// 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments.
	SegmentLength *string `json:"segmentLength,omitempty"`
}

VideoMediaInfo - Contains information about the video and audio content.

type VideoPreviewImageUrls

type VideoPreviewImageUrls struct {
	// High resolution preview image URL.
	Large *string `json:"large,omitempty"`

	// Medium resolution preview image URL.
	Medium *string `json:"medium,omitempty"`

	// Low resolution preview image URL.
	Small *string `json:"small,omitempty"`
}

VideoPreviewImageUrls - Video preview image URLs. These URLs can be used in conjunction with the video content authorization token to download the most recent still image from the video archive in different resolutions. They are available when the video type is 'archive' and preview images are enabled.

type VideoProperties

type VideoProperties struct {
	// Video archival properties.
	Archival *VideoArchival `json:"archival,omitempty"`

	// Optional video description provided by the user. Value can be up to 2048 characters long.
	Description *string `json:"description,omitempty"`

	// Contains information about the video and audio content.
	MediaInfo *VideoMediaInfo `json:"mediaInfo,omitempty"`

	// Optional video title provided by the user. Value can be up to 256 characters long.
	Title *string `json:"title,omitempty"`

	// READ-ONLY; Set of URLs to the video content.
	ContentUrls *VideoContentUrls `json:"contentUrls,omitempty" azure:"ro"`

	// READ-ONLY; Video flags contain information about the available video actions and its dynamic properties based on the current
	// video state.
	Flags *VideoFlags `json:"flags,omitempty" azure:"ro"`

	// READ-ONLY; Video content type. Different content types are suitable for different applications and scenarios.
	Type *VideoType `json:"type,omitempty" azure:"ro"`
}

VideoProperties - Application level properties for the video resource.

type VideoPublishingOptions

type VideoPublishingOptions struct {
	// When set to 'true' content will not be archived or recorded. This is used, for example, when the topology is used only
	// for low latency video streaming. Default is 'false'. If set to 'true', then
	// "disableRtspPublishing" must be set to 'false'.
	DisableArchive *string `json:"disableArchive,omitempty"`

	// When set to 'true' the RTSP playback URL will not be published, disabling low latency streaming. This is used, for example,
	// when the topology is used only for archiving content. Default is 'false'. If
	// set to 'true', then "disableArchive" must be set to 'false'.
	DisableRtspPublishing *string `json:"disableRtspPublishing,omitempty"`
}

VideoPublishingOptions - Optional flags used to change how video is published. These are only allowed for topologies where "kind" is set to "live".

type VideoScale

type VideoScale struct {
	// The desired output video height.
	Height *string `json:"height,omitempty"`

	// Describes the video scaling mode to be applied. Default mode is 'Pad'. If the mode is 'Pad' or 'Stretch' then both width
	// and height must be specified. Else if the mode is 'PreserveAspectRatio' then
	// only one of width or height need be provided.
	Mode *VideoScaleMode `json:"mode,omitempty"`

	// The desired output video width.
	Width *string `json:"width,omitempty"`
}

VideoScale - The video scaling information.

type VideoScaleMode

type VideoScaleMode string

VideoScaleMode - Describes the video scaling mode to be applied. Default mode is 'Pad'. If the mode is 'Pad' or 'Stretch' then both width and height must be specified. Else if the mode is 'PreserveAspectRatio' then only one of width or height need be provided.

const (
	// VideoScaleModePad - Pads the video with black horizontal stripes (letterbox) or black vertical stripes (pillar-box) so
	// the video is resized to the specified dimensions while not altering the content aspect ratio.
	VideoScaleModePad VideoScaleMode = "Pad"
	// VideoScaleModePreserveAspectRatio - Preserves the same aspect ratio as the input video. If only one video dimension is
	// provided, the second dimension is calculated based on the input video aspect ratio. When 2 dimensions are provided, the
	// video is resized to fit the most constraining dimension, considering the input video size and aspect ratio.
	VideoScaleModePreserveAspectRatio VideoScaleMode = "PreserveAspectRatio"
	// VideoScaleModeStretch - Stretches the original video so it resized to the specified dimensions.
	VideoScaleModeStretch VideoScaleMode = "Stretch"
)

func PossibleVideoScaleModeValues

func PossibleVideoScaleModeValues() []VideoScaleMode

PossibleVideoScaleModeValues returns the possible values for the VideoScaleMode const type.

type VideoSequenceAbsoluteTimeMarkers

type VideoSequenceAbsoluteTimeMarkers struct {
	// REQUIRED; The sequence of datetime ranges. Example: '[["2021-10-05T03:30:00Z", "2021-10-05T03:40:00Z"]]'.
	Ranges *string `json:"ranges,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`
}

VideoSequenceAbsoluteTimeMarkers - A sequence of absolute datetime ranges as a string. The datetime values should follow IS08601, and the sum of the ranges should add up to 24 hours or less. Currently, there can be only one range specified in the sequence.

func (*VideoSequenceAbsoluteTimeMarkers) GetTimeSequenceBase added in v0.2.0

func (v *VideoSequenceAbsoluteTimeMarkers) GetTimeSequenceBase() *TimeSequenceBase

GetTimeSequenceBase implements the TimeSequenceBaseClassification interface for type VideoSequenceAbsoluteTimeMarkers.

func (VideoSequenceAbsoluteTimeMarkers) MarshalJSON

func (v VideoSequenceAbsoluteTimeMarkers) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VideoSequenceAbsoluteTimeMarkers.

func (*VideoSequenceAbsoluteTimeMarkers) UnmarshalJSON

func (v *VideoSequenceAbsoluteTimeMarkers) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VideoSequenceAbsoluteTimeMarkers.

type VideoSink

type VideoSink struct {
	// REQUIRED; An array of upstream node references within the topology to be used as inputs for this node.
	Inputs []*NodeInput `json:"inputs,omitempty"`

	// REQUIRED; Node name. Must be unique within the topology.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// REQUIRED; Name of a new or existing video resource used to capture and publish content. Note: if downstream of RTSP source,
	// and if disableArchive is set to true, then no content is archived.
	VideoName *string `json:"videoName,omitempty"`

	// Optional video properties to be used in case a new video resource needs to be created on the service.
	VideoCreationProperties *VideoCreationProperties `json:"videoCreationProperties,omitempty"`

	// Options to change how the video sink publishes content via the video resource. This property is only allowed for topologies
	// where "kind" is set to "live".
	VideoPublishingOptions *VideoPublishingOptions `json:"videoPublishingOptions,omitempty"`
}

VideoSink - Video sink in a live topology allows for video and audio to be captured, optionally archived, and published via a video resource. If archiving is enabled, this results in a video of type 'archive'. If used in a batch topology, this allows for video and audio to be stored as a file, and published via a video resource of type 'file'

func (*VideoSink) GetNodeBase added in v0.2.0

func (v *VideoSink) GetNodeBase() *NodeBase

GetNodeBase implements the NodeBaseClassification interface for type VideoSink.

func (*VideoSink) GetSinkNodeBase added in v0.2.0

func (v *VideoSink) GetSinkNodeBase() *SinkNodeBase

GetSinkNodeBase implements the SinkNodeBaseClassification interface for type VideoSink.

func (VideoSink) MarshalJSON

func (v VideoSink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VideoSink.

func (*VideoSink) UnmarshalJSON

func (v *VideoSink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VideoSink.

type VideoSource

type VideoSource struct {
	// REQUIRED; Node name. Must be unique within the topology.
	Name *string `json:"name,omitempty"`

	// REQUIRED; Describes a sequence of datetime ranges. The video source only picks up recorded media within these ranges.
	TimeSequences TimeSequenceBaseClassification `json:"timeSequences,omitempty"`

	// REQUIRED; The discriminator for derived types.
	Type *string `json:"@type,omitempty"`

	// REQUIRED; Name of the Video Analyzer video resource to be used as the source.
	VideoName *string `json:"videoName,omitempty"`
}

VideoSource - Video source allows for content from a Video Analyzer video resource to be ingested into a pipeline. Currently supported only with batch pipelines.

func (*VideoSource) GetNodeBase added in v0.2.0

func (v *VideoSource) GetNodeBase() *NodeBase

GetNodeBase implements the NodeBaseClassification interface for type VideoSource.

func (*VideoSource) GetSourceNodeBase added in v0.2.0

func (v *VideoSource) GetSourceNodeBase() *SourceNodeBase

GetSourceNodeBase implements the SourceNodeBaseClassification interface for type VideoSource.

func (VideoSource) MarshalJSON

func (v VideoSource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VideoSource.

func (*VideoSource) UnmarshalJSON

func (v *VideoSource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VideoSource.

type VideoType

type VideoType string

VideoType - Video content type. Different content types are suitable for different applications and scenarios.

const (
	// VideoTypeArchive - Archive is flexible format that represents a video stream associated with wall-clock time. The video
	// archive can either be continuous or discontinuous. An archive is discontinuous when there are gaps in the recording due
	// to various reasons, such as the live pipeline being stopped, camera being disconnected or due to the use of event based
	// recordings through the use of a signal gate. There is no limit to the archive duration and new video data can be appended
	// to the existing archive at any time, as long as the same video codec and codec parameters are being used. Videos of this
	// type are suitable for appending and long term archival.
	VideoTypeArchive VideoType = "Archive"
	// VideoTypeFile - File represents a video which is stored as a single media file, such as MP4. Videos of this type are suitable
	// to be downloaded for external consumption.
	VideoTypeFile VideoType = "File"
)

func PossibleVideoTypeValues

func PossibleVideoTypeValues() []VideoType

PossibleVideoTypeValues returns the possible values for the VideoType const type.

type VideosClient

type VideosClient struct {
	// contains filtered or unexported fields
}

VideosClient contains the methods for the Videos group. Don't use this type directly, use NewVideosClient() instead.

func NewVideosClient

func NewVideosClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VideosClient, error)

NewVideosClient creates a new instance of VideosClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VideosClient) CreateOrUpdate

func (client *VideosClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, videoName string, parameters VideoEntity, options *VideosClientCreateOrUpdateOptions) (VideosClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates a new video resource or updates an existing video resource with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. videoName - The Video name. parameters - The request parameters options - VideosClientCreateOrUpdateOptions contains the optional parameters for the VideosClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-create.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideosClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<video-name>",
		armvideoanalyzer.VideoEntity{
			Properties: &armvideoanalyzer.VideoProperties{
				Description: to.Ptr("<description>"),
				Title:       to.Ptr("<title>"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*VideosClient) Delete

func (client *VideosClient) Delete(ctx context.Context, resourceGroupName string, accountName string, videoName string, options *VideosClientDeleteOptions) (VideosClientDeleteResponse, error)

Delete - Deletes an existing video resource and its underlying data. This operation is irreversible. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. videoName - The Video name. options - VideosClientDeleteOptions contains the optional parameters for the VideosClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-delete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideosClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<video-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*VideosClient) Get

func (client *VideosClient) Get(ctx context.Context, resourceGroupName string, accountName string, videoName string, options *VideosClientGetOptions) (VideosClientGetResponse, error)

Get - Retrieves an existing video resource with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. videoName - The Video name. options - VideosClientGetOptions contains the optional parameters for the VideosClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-get.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideosClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<video-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*VideosClient) ListContentToken

func (client *VideosClient) ListContentToken(ctx context.Context, resourceGroupName string, accountName string, videoName string, options *VideosClientListContentTokenOptions) (VideosClientListContentTokenResponse, error)

ListContentToken - Generates a streaming token which can be used for accessing content from video content URLs, for a video resource with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. videoName - The Video name. options - VideosClientListContentTokenOptions contains the optional parameters for the VideosClient.ListContentToken method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-listContentToken.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideosClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListContentToken(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<video-name>",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*VideosClient) NewListPager added in v0.4.0

func (client *VideosClient) NewListPager(resourceGroupName string, accountName string, options *VideosClientListOptions) *runtime.Pager[VideosClientListResponse]

NewListPager - Retrieves a list of video resources that have been created, along with their JSON representations. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. options - VideosClientListOptions contains the optional parameters for the VideosClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-list.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideosClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("<resource-group-name>",
		"<account-name>",
		&armvideoanalyzer.VideosClientListOptions{Top: to.Ptr[int32](2)})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*VideosClient) Update

func (client *VideosClient) Update(ctx context.Context, resourceGroupName string, accountName string, videoName string, parameters VideoEntity, options *VideosClientUpdateOptions) (VideosClientUpdateResponse, error)

Update - Updates individual properties of an existing video resource with the given name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. accountName - The Azure Video Analyzer account name. videoName - The Video name. parameters - The request parameters options - VideosClientUpdateOptions contains the optional parameters for the VideosClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-11-01-preview/examples/video-patch.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/videoanalyzer/armvideoanalyzer"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armvideoanalyzer.NewVideosClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"<resource-group-name>",
		"<account-name>",
		"<video-name>",
		armvideoanalyzer.VideoEntity{
			Properties: &armvideoanalyzer.VideoProperties{
				Description: to.Ptr("<description>"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type VideosClientCreateOrUpdateOptions added in v0.2.0

type VideosClientCreateOrUpdateOptions struct {
}

VideosClientCreateOrUpdateOptions contains the optional parameters for the VideosClient.CreateOrUpdate method.

type VideosClientCreateOrUpdateResponse added in v0.2.0

type VideosClientCreateOrUpdateResponse struct {
	VideoEntity
}

VideosClientCreateOrUpdateResponse contains the response from method VideosClient.CreateOrUpdate.

type VideosClientDeleteOptions added in v0.2.0

type VideosClientDeleteOptions struct {
}

VideosClientDeleteOptions contains the optional parameters for the VideosClient.Delete method.

type VideosClientDeleteResponse added in v0.2.0

type VideosClientDeleteResponse struct {
}

VideosClientDeleteResponse contains the response from method VideosClient.Delete.

type VideosClientGetOptions added in v0.2.0

type VideosClientGetOptions struct {
}

VideosClientGetOptions contains the optional parameters for the VideosClient.Get method.

type VideosClientGetResponse added in v0.2.0

type VideosClientGetResponse struct {
	VideoEntity
}

VideosClientGetResponse contains the response from method VideosClient.Get.

type VideosClientListContentTokenOptions added in v0.2.0

type VideosClientListContentTokenOptions struct {
}

VideosClientListContentTokenOptions contains the optional parameters for the VideosClient.ListContentToken method.

type VideosClientListContentTokenResponse added in v0.2.0

type VideosClientListContentTokenResponse struct {
	VideoContentToken
}

VideosClientListContentTokenResponse contains the response from method VideosClient.ListContentToken.

type VideosClientListOptions added in v0.2.0

type VideosClientListOptions struct {
	// Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the
	// number of available items up to but not greater than the specified value n.
	Top *int32
}

VideosClientListOptions contains the optional parameters for the VideosClient.List method.

type VideosClientListResponse added in v0.2.0

type VideosClientListResponse struct {
	VideoEntityCollection
}

VideosClientListResponse contains the response from method VideosClient.List.

type VideosClientUpdateOptions added in v0.2.0

type VideosClientUpdateOptions struct {
}

VideosClientUpdateOptions contains the optional parameters for the VideosClient.Update method.

type VideosClientUpdateResponse added in v0.2.0

type VideosClientUpdateResponse struct {
	VideoEntity
}

VideosClientUpdateResponse contains the response from method VideosClient.Update.

Jump to

Keyboard shortcuts

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