videoanalyzer

package
v54.2.0+incompatible Latest Latest
Warning

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

Go to latest
Published: May 13, 2021 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package videoanalyzer implements the Azure ARM Videoanalyzer service API version 2021-05-01-preview.

Azure Video Analyzer ARM Client

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Videoanalyzer
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AccessPoliciesClient

type AccessPoliciesClient struct {
	BaseClient
}

AccessPoliciesClient is the azure Video Analyzer ARM Client

func NewAccessPoliciesClient

func NewAccessPoliciesClient(subscriptionID string) AccessPoliciesClient

NewAccessPoliciesClient creates an instance of the AccessPoliciesClient client.

func NewAccessPoliciesClientWithBaseURI

func NewAccessPoliciesClientWithBaseURI(baseURI string, subscriptionID string) AccessPoliciesClient

NewAccessPoliciesClientWithBaseURI creates an instance of the AccessPoliciesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (AccessPoliciesClient) CreateOrUpdate

func (client AccessPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string, parameters AccessPolicyEntity) (result AccessPolicyEntity, err error)

CreateOrUpdate creates a new access policy resource or updates an existing one. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. accessPolicyName - the name of the access policy to create or update. parameters - the request parameters

func (AccessPoliciesClient) CreateOrUpdatePreparer

func (client AccessPoliciesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string, parameters AccessPolicyEntity) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AccessPoliciesClient) CreateOrUpdateResponder

func (client AccessPoliciesClient) CreateOrUpdateResponder(resp *http.Response) (result AccessPolicyEntity, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (AccessPoliciesClient) CreateOrUpdateSender

func (client AccessPoliciesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (AccessPoliciesClient) Delete

func (client AccessPoliciesClient) Delete(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string) (result autorest.Response, err error)

Delete deletes an existing access policy resource. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. accessPolicyName - the name of the access policy to delete.

func (AccessPoliciesClient) DeletePreparer

func (client AccessPoliciesClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AccessPoliciesClient) DeleteResponder

func (client AccessPoliciesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (AccessPoliciesClient) DeleteSender

func (client AccessPoliciesClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (AccessPoliciesClient) Get

func (client AccessPoliciesClient) Get(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string) (result AccessPolicyEntity, err error)

Get retrieves an existing access policy resource from an account by name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. accessPolicyName - the name of the access policy to retrieve.

func (AccessPoliciesClient) GetPreparer

func (client AccessPoliciesClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AccessPoliciesClient) GetResponder

func (client AccessPoliciesClient) GetResponder(resp *http.Response) (result AccessPolicyEntity, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (AccessPoliciesClient) GetSender

func (client AccessPoliciesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (AccessPoliciesClient) List

func (client AccessPoliciesClient) List(ctx context.Context, resourceGroupName string, accountName string, top *int32) (result AccessPolicyEntityCollectionPage, err error)

List list all existing access policy resources for the specified account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. top - 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.

func (AccessPoliciesClient) ListComplete

func (client AccessPoliciesClient) ListComplete(ctx context.Context, resourceGroupName string, accountName string, top *int32) (result AccessPolicyEntityCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (AccessPoliciesClient) ListPreparer

func (client AccessPoliciesClient) ListPreparer(ctx context.Context, resourceGroupName string, accountName string, top *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (AccessPoliciesClient) ListResponder

func (client AccessPoliciesClient) ListResponder(resp *http.Response) (result AccessPolicyEntityCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (AccessPoliciesClient) ListSender

func (client AccessPoliciesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (AccessPoliciesClient) Update

func (client AccessPoliciesClient) Update(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string, parameters AccessPolicyEntity) (result AccessPolicyEntity, err error)

Update updates individual properties of an existing access policy resource. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. accessPolicyName - the name of the access policy to update. parameters - the request parameters

func (AccessPoliciesClient) UpdatePreparer

func (client AccessPoliciesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, accessPolicyName string, parameters AccessPolicyEntity) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AccessPoliciesClient) UpdateResponder

func (client AccessPoliciesClient) UpdateResponder(resp *http.Response) (result AccessPolicyEntity, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (AccessPoliciesClient) UpdateSender

func (client AccessPoliciesClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type AccessPolicyEccAlgo

type AccessPolicyEccAlgo string

AccessPolicyEccAlgo enumerates the values for access policy ecc algo.

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

func PossibleAccessPolicyEccAlgoValues

func PossibleAccessPolicyEccAlgoValues() []AccessPolicyEccAlgo

PossibleAccessPolicyEccAlgoValues returns an array of possible values for the AccessPolicyEccAlgo const type.

type AccessPolicyEntity

type AccessPolicyEntity struct {
	autorest.Response `json:"-"`
	// AccessPolicyProperties - The resource properties.
	*AccessPolicyProperties `json:"properties,omitempty"`
	// SystemData - READ-ONLY; The system metadata relating to this resource.
	SystemData *SystemData `json:"systemData,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AccessPolicyEntity policy that determines how a video can be accessed.

func (AccessPolicyEntity) MarshalJSON

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

MarshalJSON is the custom marshaler for AccessPolicyEntity.

func (*AccessPolicyEntity) UnmarshalJSON

func (ape *AccessPolicyEntity) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AccessPolicyEntity struct.

type AccessPolicyEntityCollection

type AccessPolicyEntityCollection struct {
	autorest.Response `json:"-"`
	// Value - A collection of AccessPolicyEntity items.
	Value *[]AccessPolicyEntity `json:"value,omitempty"`
	// NextLink - 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"`
}

AccessPolicyEntityCollection a collection of AccessPolicyEntity items.

func (AccessPolicyEntityCollection) IsEmpty

func (apec AccessPolicyEntityCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AccessPolicyEntityCollectionIterator

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

AccessPolicyEntityCollectionIterator provides access to a complete listing of AccessPolicyEntity values.

func NewAccessPolicyEntityCollectionIterator

func NewAccessPolicyEntityCollectionIterator(page AccessPolicyEntityCollectionPage) AccessPolicyEntityCollectionIterator

Creates a new instance of the AccessPolicyEntityCollectionIterator type.

func (*AccessPolicyEntityCollectionIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AccessPolicyEntityCollectionIterator) NextWithContext

func (iter *AccessPolicyEntityCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AccessPolicyEntityCollectionIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (AccessPolicyEntityCollectionIterator) Response

Response returns the raw server response from the last page request.

func (AccessPolicyEntityCollectionIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AccessPolicyEntityCollectionPage

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

AccessPolicyEntityCollectionPage contains a page of AccessPolicyEntity values.

func NewAccessPolicyEntityCollectionPage

Creates a new instance of the AccessPolicyEntityCollectionPage type.

func (*AccessPolicyEntityCollectionPage) Next

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AccessPolicyEntityCollectionPage) NextWithContext

func (page *AccessPolicyEntityCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AccessPolicyEntityCollectionPage) NotDone

func (page AccessPolicyEntityCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AccessPolicyEntityCollectionPage) Response

Response returns the raw server response from the last page request.

func (AccessPolicyEntityCollectionPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type AccessPolicyProperties

type AccessPolicyProperties struct {
	// Role - Defines the access level granted by this policy. Possible values include: 'AccessPolicyRoleReader'
	Role AccessPolicyRole `json:"role,omitempty"`
	// Authentication - Authentication method to be used when validating client API access.
	Authentication BasicAuthenticationBase `json:"authentication,omitempty"`
}

AccessPolicyProperties application level properties for the access policy resource.

func (*AccessPolicyProperties) UnmarshalJSON

func (app *AccessPolicyProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AccessPolicyProperties struct.

type AccessPolicyRole

type AccessPolicyRole string

AccessPolicyRole enumerates the values for access policy role.

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 an array of possible values for the AccessPolicyRole const type.

type AccessPolicyRsaAlgo

type AccessPolicyRsaAlgo string

AccessPolicyRsaAlgo enumerates the values for access policy rsa algo.

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

func PossibleAccessPolicyRsaAlgoValues

func PossibleAccessPolicyRsaAlgoValues() []AccessPolicyRsaAlgo

PossibleAccessPolicyRsaAlgoValues returns an array of possible values for the AccessPolicyRsaAlgo const type.

type AccountEncryption

type AccountEncryption struct {
	// Type - The type of key used to encrypt the Account Key. Possible values include: 'AccountEncryptionKeyTypeSystemKey', 'AccountEncryptionKeyTypeCustomerKey'
	Type AccountEncryptionKeyType `json:"type,omitempty"`
	// KeyVaultProperties - The properties of the key used to encrypt the account.
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
	// Identity - The Key Vault identity.
	Identity *ResourceIdentity `json:"identity,omitempty"`
	// Status - READ-ONLY; The current status of the Key Vault mapping.
	Status *string `json:"status,omitempty"`
}

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

func (AccountEncryption) MarshalJSON

func (ae AccountEncryption) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountEncryption.

type AccountEncryptionKeyType

type AccountEncryptionKeyType string

AccountEncryptionKeyType enumerates the values for account encryption key type.

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 an array of possible values for the AccountEncryptionKeyType const type.

type ActionType

type ActionType string

ActionType enumerates the values for action type.

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

func PossibleActionTypeValues

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns an array of possible values for the ActionType const type.

type AuthenticationBase

type AuthenticationBase struct {
	// Type - Possible values include: 'TypeTypeAuthenticationBase', 'TypeTypeMicrosoftVideoAnalyzerJwtAuthentication'
	Type Type `json:"@type,omitempty"`
}

AuthenticationBase base class for access policies authentication methods.

func (AuthenticationBase) AsAuthenticationBase

func (ab AuthenticationBase) AsAuthenticationBase() (*AuthenticationBase, bool)

AsAuthenticationBase is the BasicAuthenticationBase implementation for AuthenticationBase.

func (AuthenticationBase) AsBasicAuthenticationBase

func (ab AuthenticationBase) AsBasicAuthenticationBase() (BasicAuthenticationBase, bool)

AsBasicAuthenticationBase is the BasicAuthenticationBase implementation for AuthenticationBase.

func (AuthenticationBase) AsJwtAuthentication

func (ab AuthenticationBase) AsJwtAuthentication() (*JwtAuthentication, bool)

AsJwtAuthentication is the BasicAuthenticationBase implementation for AuthenticationBase.

func (AuthenticationBase) MarshalJSON

func (ab AuthenticationBase) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AuthenticationBase.

type AzureEntityResource

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Videoanalyzer.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type BasicAuthenticationBase

type BasicAuthenticationBase interface {
	AsJwtAuthentication() (*JwtAuthentication, bool)
	AsAuthenticationBase() (*AuthenticationBase, bool)
}

BasicAuthenticationBase base class for access policies authentication methods.

type BasicTokenKey

type BasicTokenKey interface {
	AsRsaTokenKey() (*RsaTokenKey, bool)
	AsEccTokenKey() (*EccTokenKey, bool)
	AsTokenKey() (*TokenKey, bool)
}

BasicTokenKey key properties for JWT token validation.

type CheckNameAvailabilityReason

type CheckNameAvailabilityReason string

CheckNameAvailabilityReason enumerates the values for check name availability reason.

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

func PossibleCheckNameAvailabilityReasonValues

func PossibleCheckNameAvailabilityReasonValues() []CheckNameAvailabilityReason

PossibleCheckNameAvailabilityReasonValues returns an array of possible values for the CheckNameAvailabilityReason const type.

type CheckNameAvailabilityRequest

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

CheckNameAvailabilityRequest the check availability request body.

type CheckNameAvailabilityResponse

type CheckNameAvailabilityResponse struct {
	autorest.Response `json:"-"`
	// NameAvailable - Indicates if the resource name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - The reason why the given name is not available. Possible values include: 'CheckNameAvailabilityReasonInvalid', 'CheckNameAvailabilityReasonAlreadyExists'
	Reason CheckNameAvailabilityReason `json:"reason,omitempty"`
	// Message - Detailed reason why the given name is available.
	Message *string `json:"message,omitempty"`
}

CheckNameAvailabilityResponse the check availability result.

type Collection

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

Collection a collection of VideoAnalyzer items.

type CreatedByType

type CreatedByType string

CreatedByType enumerates the values for created by type.

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

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.

type EccTokenKey

type EccTokenKey struct {
	// Alg - Elliptical curve algorithm to be used: ES256, ES384 or ES512. Possible values include: 'AccessPolicyEccAlgoES256', 'AccessPolicyEccAlgoES384', 'AccessPolicyEccAlgoES512'
	Alg AccessPolicyEccAlgo `json:"alg,omitempty"`
	// X - X coordinate.
	X *string `json:"x,omitempty"`
	// Y - Y coordinate.
	Y *string `json:"y,omitempty"`
	// Kid - 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"`
	// Type - Possible values include: 'TypeBasicTokenKeyTypeTokenKey', 'TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerRsaTokenKey', 'TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerEccTokenKey'
	Type TypeBasicTokenKey `json:"@type,omitempty"`
}

EccTokenKey required validation properties for tokens generated with Elliptical Curve algorithm.

func (EccTokenKey) AsBasicTokenKey

func (etk EccTokenKey) AsBasicTokenKey() (BasicTokenKey, bool)

AsBasicTokenKey is the BasicTokenKey implementation for EccTokenKey.

func (EccTokenKey) AsEccTokenKey

func (etk EccTokenKey) AsEccTokenKey() (*EccTokenKey, bool)

AsEccTokenKey is the BasicTokenKey implementation for EccTokenKey.

func (EccTokenKey) AsRsaTokenKey

func (etk EccTokenKey) AsRsaTokenKey() (*RsaTokenKey, bool)

AsRsaTokenKey is the BasicTokenKey implementation for EccTokenKey.

func (EccTokenKey) AsTokenKey

func (etk EccTokenKey) AsTokenKey() (*TokenKey, bool)

AsTokenKey is the BasicTokenKey implementation for EccTokenKey.

func (EccTokenKey) MarshalJSON

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

MarshalJSON is the custom marshaler for EccTokenKey.

type EdgeModuleEntity

type EdgeModuleEntity struct {
	autorest.Response `json:"-"`
	// EdgeModuleProperties - The resource properties.
	*EdgeModuleProperties `json:"properties,omitempty"`
	// SystemData - READ-ONLY; The system metadata relating to this resource.
	SystemData *SystemData `json:"systemData,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

EdgeModuleEntity the representation of an edge module.

func (EdgeModuleEntity) MarshalJSON

func (eme EdgeModuleEntity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EdgeModuleEntity.

func (*EdgeModuleEntity) UnmarshalJSON

func (eme *EdgeModuleEntity) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EdgeModuleEntity struct.

type EdgeModuleEntityCollection

type EdgeModuleEntityCollection struct {
	autorest.Response `json:"-"`
	// Value - A collection of EdgeModuleEntity items.
	Value *[]EdgeModuleEntity `json:"value,omitempty"`
	// NextLink - 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"`
}

EdgeModuleEntityCollection a collection of EdgeModuleEntity items.

func (EdgeModuleEntityCollection) IsEmpty

func (emec EdgeModuleEntityCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EdgeModuleEntityCollectionIterator

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

EdgeModuleEntityCollectionIterator provides access to a complete listing of EdgeModuleEntity values.

func NewEdgeModuleEntityCollectionIterator

func NewEdgeModuleEntityCollectionIterator(page EdgeModuleEntityCollectionPage) EdgeModuleEntityCollectionIterator

Creates a new instance of the EdgeModuleEntityCollectionIterator type.

func (*EdgeModuleEntityCollectionIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*EdgeModuleEntityCollectionIterator) NextWithContext

func (iter *EdgeModuleEntityCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (EdgeModuleEntityCollectionIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (EdgeModuleEntityCollectionIterator) Response

Response returns the raw server response from the last page request.

func (EdgeModuleEntityCollectionIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type EdgeModuleEntityCollectionPage

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

EdgeModuleEntityCollectionPage contains a page of EdgeModuleEntity values.

func NewEdgeModuleEntityCollectionPage

Creates a new instance of the EdgeModuleEntityCollectionPage type.

func (*EdgeModuleEntityCollectionPage) Next

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*EdgeModuleEntityCollectionPage) NextWithContext

func (page *EdgeModuleEntityCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (EdgeModuleEntityCollectionPage) NotDone

func (page EdgeModuleEntityCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (EdgeModuleEntityCollectionPage) Response

Response returns the raw server response from the last page request.

func (EdgeModuleEntityCollectionPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type EdgeModuleProperties

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

EdgeModuleProperties application level properties for the edge module resource.

type EdgeModuleProvisioningToken

type EdgeModuleProvisioningToken struct {
	autorest.Response `json:"-"`
	// ExpirationDate - 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 *date.Time `json:"expirationDate,omitempty"`
	// Token - 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"`
}

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.

type EdgeModulesClient

type EdgeModulesClient struct {
	BaseClient
}

EdgeModulesClient is the azure Video Analyzer ARM Client

func NewEdgeModulesClient

func NewEdgeModulesClient(subscriptionID string) EdgeModulesClient

NewEdgeModulesClient creates an instance of the EdgeModulesClient client.

func NewEdgeModulesClientWithBaseURI

func NewEdgeModulesClientWithBaseURI(baseURI string, subscriptionID string) EdgeModulesClient

NewEdgeModulesClientWithBaseURI creates an instance of the EdgeModulesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (EdgeModulesClient) CreateOrUpdate

func (client EdgeModulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string, parameters EdgeModuleEntity) (result EdgeModuleEntity, err 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. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. edgeModuleName - the name of the edge module to create or update. parameters - the request parameters

func (EdgeModulesClient) CreateOrUpdatePreparer

func (client EdgeModulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string, parameters EdgeModuleEntity) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (EdgeModulesClient) CreateOrUpdateResponder

func (client EdgeModulesClient) CreateOrUpdateResponder(resp *http.Response) (result EdgeModuleEntity, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (EdgeModulesClient) CreateOrUpdateSender

func (client EdgeModulesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (EdgeModulesClient) Delete

func (client EdgeModulesClient) Delete(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string) (result autorest.Response, err 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. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. edgeModuleName - the name of the edge module to be deleted.

func (EdgeModulesClient) DeletePreparer

func (client EdgeModulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (EdgeModulesClient) DeleteResponder

func (client EdgeModulesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (EdgeModulesClient) DeleteSender

func (client EdgeModulesClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (EdgeModulesClient) Get

func (client EdgeModulesClient) Get(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string) (result EdgeModuleEntity, err error)

Get retrieves a specific existing edge module resource in the given Video Analyzer account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. edgeModuleName - the name of the edge module to retrieve.

func (EdgeModulesClient) GetPreparer

func (client EdgeModulesClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (EdgeModulesClient) GetResponder

func (client EdgeModulesClient) GetResponder(resp *http.Response) (result EdgeModuleEntity, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (EdgeModulesClient) GetSender

func (client EdgeModulesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (EdgeModulesClient) List

func (client EdgeModulesClient) List(ctx context.Context, resourceGroupName string, accountName string, filter string, top *int32, orderby string) (result EdgeModuleEntityCollectionPage, err error)

List list all of the existing edge module resources for a given Video Analyzer account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. filter - restricts the set of items returned. top - 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. orderby - specifies the key by which the result collection should be ordered.

func (EdgeModulesClient) ListComplete

func (client EdgeModulesClient) ListComplete(ctx context.Context, resourceGroupName string, accountName string, filter string, top *int32, orderby string) (result EdgeModuleEntityCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (EdgeModulesClient) ListPreparer

func (client EdgeModulesClient) ListPreparer(ctx context.Context, resourceGroupName string, accountName string, filter string, top *int32, orderby string) (*http.Request, error)

ListPreparer prepares the List request.

func (EdgeModulesClient) ListProvisioningToken

func (client EdgeModulesClient) ListProvisioningToken(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string, parameters ListProvisioningTokenInput) (result EdgeModuleProvisioningToken, err 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. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. edgeModuleName - the name of the edge module used to create a new provisioning token. parameters - the request parameters

func (EdgeModulesClient) ListProvisioningTokenPreparer

func (client EdgeModulesClient) ListProvisioningTokenPreparer(ctx context.Context, resourceGroupName string, accountName string, edgeModuleName string, parameters ListProvisioningTokenInput) (*http.Request, error)

ListProvisioningTokenPreparer prepares the ListProvisioningToken request.

func (EdgeModulesClient) ListProvisioningTokenResponder

func (client EdgeModulesClient) ListProvisioningTokenResponder(resp *http.Response) (result EdgeModuleProvisioningToken, err error)

ListProvisioningTokenResponder handles the response to the ListProvisioningToken request. The method always closes the http.Response Body.

func (EdgeModulesClient) ListProvisioningTokenSender

func (client EdgeModulesClient) ListProvisioningTokenSender(req *http.Request) (*http.Response, error)

ListProvisioningTokenSender sends the ListProvisioningToken request. The method will close the http.Response Body if it receives an error.

func (EdgeModulesClient) ListResponder

func (client EdgeModulesClient) ListResponder(resp *http.Response) (result EdgeModuleEntityCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (EdgeModulesClient) ListSender

func (client EdgeModulesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type Endpoint

type Endpoint struct {
	// EndpointURL - The URL of the endpoint.
	EndpointURL *string `json:"endpointUrl,omitempty"`
	// Type - The type of the endpoint.
	Type *string `json:"type,omitempty"`
}

Endpoint the endpoint details.

type ErrorAdditionalInfo

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

ErrorAdditionalInfo the resource management error additional info.

type ErrorDetail

type ErrorDetail struct {
	// Code - READ-ONLY; The error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The error message.
	Message *string `json:"message,omitempty"`
	// Target - READ-ONLY; The error target.
	Target *string `json:"target,omitempty"`
	// Details - READ-ONLY; The error details.
	Details *[]ErrorDetail `json:"details,omitempty"`
	// AdditionalInfo - READ-ONLY; The error additional info.
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

ErrorDetail the error detail.

type ErrorResponse

type ErrorResponse struct {
	// Error - 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 Identity

type Identity struct {
	// Type - The identity type.
	Type *string `json:"type,omitempty"`
	// UserAssignedIdentities - The User Assigned Managed Identities.
	UserAssignedIdentities map[string]*UserAssignedManagedIdentity `json:"userAssignedIdentities"`
}

Identity the managed identity for the Video Analyzer resource.

func (Identity) MarshalJSON

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

MarshalJSON is the custom marshaler for Identity.

type JwtAuthentication

type JwtAuthentication struct {
	// Issuers - List of expected token issuers. Token issuer is valid if it matches at least one of the given values.
	Issuers *[]string `json:"issuers,omitempty"`
	// Audiences - List of expected token audiences. Token audience is valid if it matches at least one of the given values.
	Audiences *[]string `json:"audiences,omitempty"`
	// Claims - 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"`
	// Keys - 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 *[]BasicTokenKey `json:"keys,omitempty"`
	// Type - Possible values include: 'TypeTypeAuthenticationBase', 'TypeTypeMicrosoftVideoAnalyzerJwtAuthentication'
	Type Type `json:"@type,omitempty"`
}

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

func (JwtAuthentication) AsAuthenticationBase

func (ja JwtAuthentication) AsAuthenticationBase() (*AuthenticationBase, bool)

AsAuthenticationBase is the BasicAuthenticationBase implementation for JwtAuthentication.

func (JwtAuthentication) AsBasicAuthenticationBase

func (ja JwtAuthentication) AsBasicAuthenticationBase() (BasicAuthenticationBase, bool)

AsBasicAuthenticationBase is the BasicAuthenticationBase implementation for JwtAuthentication.

func (JwtAuthentication) AsJwtAuthentication

func (ja JwtAuthentication) AsJwtAuthentication() (*JwtAuthentication, bool)

AsJwtAuthentication is the BasicAuthenticationBase implementation for JwtAuthentication.

func (JwtAuthentication) MarshalJSON

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

MarshalJSON is the custom marshaler for JwtAuthentication.

func (*JwtAuthentication) UnmarshalJSON

func (ja *JwtAuthentication) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for JwtAuthentication struct.

type KeyVaultProperties

type KeyVaultProperties struct {
	// KeyIdentifier - 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"`
	// CurrentKeyIdentifier - READ-ONLY; The current key used to encrypt Video Analyzer account, including the key version.
	CurrentKeyIdentifier *string `json:"currentKeyIdentifier,omitempty"`
}

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

func (KeyVaultProperties) MarshalJSON

func (kvp KeyVaultProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for KeyVaultProperties.

type ListProvisioningTokenInput

type ListProvisioningTokenInput struct {
	// ExpirationDate - 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 *date.Time `json:"expirationDate,omitempty"`
}

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

type LocationsClient

type LocationsClient struct {
	BaseClient
}

LocationsClient is the azure Video Analyzer ARM Client

func NewLocationsClient

func NewLocationsClient(subscriptionID string) LocationsClient

NewLocationsClient creates an instance of the LocationsClient client.

func NewLocationsClientWithBaseURI

func NewLocationsClientWithBaseURI(baseURI string, subscriptionID string) LocationsClient

NewLocationsClientWithBaseURI creates an instance of the LocationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (LocationsClient) CheckNameAvailability

func (client LocationsClient) CheckNameAvailability(ctx context.Context, locationName string, parameters CheckNameAvailabilityRequest) (result CheckNameAvailabilityResponse, err error)

CheckNameAvailability checks whether the Video Analyzer resource name is available. Parameters: locationName - the name of the location. parameters - the request parameters

func (LocationsClient) CheckNameAvailabilityPreparer

func (client LocationsClient) CheckNameAvailabilityPreparer(ctx context.Context, locationName string, parameters CheckNameAvailabilityRequest) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (LocationsClient) CheckNameAvailabilityResponder

func (client LocationsClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityResponse, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (LocationsClient) CheckNameAvailabilitySender

func (client LocationsClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.

type LogSpecification

type LogSpecification struct {
	// Name - READ-ONLY; The diagnostic log category name.
	Name *string `json:"name,omitempty"`
	// DisplayName - READ-ONLY; The diagnostic log category display name.
	DisplayName *string `json:"displayName,omitempty"`
	// BlobDuration - READ-ONLY; The time range for requests in each blob.
	BlobDuration *string `json:"blobDuration,omitempty"`
}

LogSpecification a diagnostic log emitted by service.

type MetricAggregationType

type MetricAggregationType string

MetricAggregationType enumerates the values for 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 an array of possible values for the MetricAggregationType const type.

type MetricDimension

type MetricDimension struct {
	// Name - READ-ONLY; The metric dimension name.
	Name *string `json:"name,omitempty"`
	// DisplayName - READ-ONLY; The display name for the dimension.
	DisplayName *string `json:"displayName,omitempty"`
	// ToBeExportedForShoebox - READ-ONLY; Whether to export metric to shoebox.
	ToBeExportedForShoebox *bool `json:"toBeExportedForShoebox,omitempty"`
}

MetricDimension a metric dimension.

type MetricSpecification

type MetricSpecification struct {
	// Name - READ-ONLY; The metric name.
	Name *string `json:"name,omitempty"`
	// DisplayName - READ-ONLY; The metric display name.
	DisplayName *string `json:"displayName,omitempty"`
	// DisplayDescription - READ-ONLY; The metric display description.
	DisplayDescription *string `json:"displayDescription,omitempty"`
	// Unit - READ-ONLY; The metric unit. Possible values include: 'MetricUnitBytes', 'MetricUnitCount', 'MetricUnitMilliseconds'
	Unit MetricUnit `json:"unit,omitempty"`
	// AggregationType - READ-ONLY; The metric aggregation type. Possible values include: 'MetricAggregationTypeAverage', 'MetricAggregationTypeCount', 'MetricAggregationTypeTotal'
	AggregationType MetricAggregationType `json:"aggregationType,omitempty"`
	// LockAggregationType - READ-ONLY; The metric lock aggregation type. Possible values include: 'MetricAggregationTypeAverage', 'MetricAggregationTypeCount', 'MetricAggregationTypeTotal'
	LockAggregationType MetricAggregationType `json:"lockAggregationType,omitempty"`
	// SupportedAggregationTypes - Supported aggregation types.
	SupportedAggregationTypes *[]string `json:"supportedAggregationTypes,omitempty"`
	// Dimensions - READ-ONLY; The metric dimensions.
	Dimensions *[]MetricDimension `json:"dimensions,omitempty"`
	// EnableRegionalMdmAccount - READ-ONLY; Indicates whether regional MDM account is enabled.
	EnableRegionalMdmAccount *bool `json:"enableRegionalMdmAccount,omitempty"`
	// SourceMdmAccount - READ-ONLY; The source MDM account.
	SourceMdmAccount *string `json:"sourceMdmAccount,omitempty"`
	// SourceMdmNamespace - READ-ONLY; The source MDM namespace.
	SourceMdmNamespace *string `json:"sourceMdmNamespace,omitempty"`
	// SupportedTimeGrainTypes - READ-ONLY; The supported time grain types.
	SupportedTimeGrainTypes *[]string `json:"supportedTimeGrainTypes,omitempty"`
}

MetricSpecification a metric emitted by service.

func (MetricSpecification) MarshalJSON

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

MarshalJSON is the custom marshaler for MetricSpecification.

type MetricUnit

type MetricUnit string

MetricUnit enumerates the values for 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 an array of possible values for the MetricUnit const type.

type Model

type Model struct {
	autorest.Response `json:"-"`
	// PropertiesType - The properties of the Video Analyzer account.
	*PropertiesType `json:"properties,omitempty"`
	// SystemData - READ-ONLY; The system data of the Video Analyzer account.
	SystemData *SystemData `json:"systemData,omitempty"`
	// Identity - The set of managed identities associated with the Video Analyzer resource.
	Identity *Identity `json:"identity,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Model a Video Analyzer account.

func (Model) MarshalJSON

func (mVar Model) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Model.

func (*Model) UnmarshalJSON

func (mVar *Model) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Model struct.

type Operation

type Operation struct {
	// Name - The operation name.
	Name *string `json:"name,omitempty"`
	// Display - The operation display name.
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - Origin of the operation.
	Origin *string `json:"origin,omitempty"`
	// Properties - Operation properties format.
	Properties *Properties `json:"properties,omitempty"`
	// IsDataAction - Whether the operation applies to data-plane.
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// ActionType - Indicates the action type. Possible values include: 'ActionTypeInternal'
	ActionType ActionType `json:"actionType,omitempty"`
}

Operation an operation.

type OperationCollection

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

OperationCollection a collection of Operation items.

type OperationDisplay

type OperationDisplay struct {
	// Provider - The service provider.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
	// Operation - The operation type.
	Operation *string `json:"operation,omitempty"`
	// Description - The operation description.
	Description *string `json:"description,omitempty"`
}

OperationDisplay operation details.

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the azure Video Analyzer ARM Client

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List

func (client OperationsClient) List(ctx context.Context) (result OperationCollection, err error)

List lists all the Media operations.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type Properties

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

Properties metric properties.

type PropertiesType

type PropertiesType struct {
	// StorageAccounts - The storage accounts for this resource.
	StorageAccounts *[]StorageAccount `json:"storageAccounts,omitempty"`
	// Endpoints - READ-ONLY; The list of endpoints associated with this resource.
	Endpoints *[]Endpoint `json:"endpoints,omitempty"`
	// Encryption - The account encryption properties.
	Encryption *AccountEncryption `json:"encryption,omitempty"`
}

PropertiesType ...

func (PropertiesType) MarshalJSON

func (pt PropertiesType) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PropertiesType.

type PropertiesUpdate

type PropertiesUpdate struct {
	// StorageAccounts - The storage accounts for this resource.
	StorageAccounts *[]StorageAccount `json:"storageAccounts,omitempty"`
	// Endpoints - READ-ONLY; The list of endpoints associated with this resource.
	Endpoints *[]Endpoint `json:"endpoints,omitempty"`
	// Encryption - The account encryption properties.
	Encryption *AccountEncryption `json:"encryption,omitempty"`
}

PropertiesUpdate properties of the Video Analyzer account.

func (PropertiesUpdate) MarshalJSON

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

MarshalJSON is the custom marshaler for PropertiesUpdate.

type ProxyResource

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

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

type Resource

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

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

type ResourceIdentity

type ResourceIdentity struct {
	// UserAssignedIdentity - 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 {
	// Alg - RSA algorithm to be used: RS256, RS384 or RS512. Possible values include: 'AccessPolicyRsaAlgoRS256', 'AccessPolicyRsaAlgoRS384', 'AccessPolicyRsaAlgoRS512'
	Alg AccessPolicyRsaAlgo `json:"alg,omitempty"`
	// N - RSA public key modulus.
	N *string `json:"n,omitempty"`
	// E - RSA public key exponent.
	E *string `json:"e,omitempty"`
	// Kid - 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"`
	// Type - Possible values include: 'TypeBasicTokenKeyTypeTokenKey', 'TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerRsaTokenKey', 'TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerEccTokenKey'
	Type TypeBasicTokenKey `json:"@type,omitempty"`
}

RsaTokenKey required validation properties for tokens generated with RSA algorithm.

func (RsaTokenKey) AsBasicTokenKey

func (rtk RsaTokenKey) AsBasicTokenKey() (BasicTokenKey, bool)

AsBasicTokenKey is the BasicTokenKey implementation for RsaTokenKey.

func (RsaTokenKey) AsEccTokenKey

func (rtk RsaTokenKey) AsEccTokenKey() (*EccTokenKey, bool)

AsEccTokenKey is the BasicTokenKey implementation for RsaTokenKey.

func (RsaTokenKey) AsRsaTokenKey

func (rtk RsaTokenKey) AsRsaTokenKey() (*RsaTokenKey, bool)

AsRsaTokenKey is the BasicTokenKey implementation for RsaTokenKey.

func (RsaTokenKey) AsTokenKey

func (rtk RsaTokenKey) AsTokenKey() (*TokenKey, bool)

AsTokenKey is the BasicTokenKey implementation for RsaTokenKey.

func (RsaTokenKey) MarshalJSON

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

MarshalJSON is the custom marshaler for RsaTokenKey.

type ServiceSpecification

type ServiceSpecification struct {
	// LogSpecifications - READ-ONLY; List of log specifications.
	LogSpecifications *[]LogSpecification `json:"logSpecifications,omitempty"`
	// MetricSpecifications - READ-ONLY; List of metric specifications.
	MetricSpecifications *[]MetricSpecification `json:"metricSpecifications,omitempty"`
}

ServiceSpecification the service metric specifications.

type StorageAccount

type StorageAccount struct {
	// ID - 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"`
	// Identity - A managed identity that Video Analyzer will use to access the storage account.
	Identity *ResourceIdentity `json:"identity,omitempty"`
	// Status - READ-ONLY; The current status of the storage account mapping.
	Status *string `json:"status,omitempty"`
}

StorageAccount the details about the associated storage account.

func (StorageAccount) MarshalJSON

func (sa StorageAccount) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageAccount.

type SyncStorageKeysInput

type SyncStorageKeysInput struct {
	// ID - The ID of the storage account resource.
	ID *string `json:"id,omitempty"`
}

SyncStorageKeysInput the input to the sync storage keys request.

type SystemData

type SystemData struct {
	// CreatedBy - The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByType - The type of identity that created the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	CreatedByType CreatedByType `json:"createdByType,omitempty"`
	// CreatedAt - The timestamp of resource creation (UTC).
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// LastModifiedBy - The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
	// LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The timestamp of resource last modification (UTC)
	LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

SystemData metadata pertaining to creation and last modification of the resource.

type TokenClaim

type TokenClaim struct {
	// Name - Name of the claim which must be present on the token.
	Name *string `json:"name,omitempty"`
	// Value - 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 {
	// Kid - 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"`
	// Type - Possible values include: 'TypeBasicTokenKeyTypeTokenKey', 'TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerRsaTokenKey', 'TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerEccTokenKey'
	Type TypeBasicTokenKey `json:"@type,omitempty"`
}

TokenKey key properties for JWT token validation.

func (TokenKey) AsBasicTokenKey

func (tk TokenKey) AsBasicTokenKey() (BasicTokenKey, bool)

AsBasicTokenKey is the BasicTokenKey implementation for TokenKey.

func (TokenKey) AsEccTokenKey

func (tk TokenKey) AsEccTokenKey() (*EccTokenKey, bool)

AsEccTokenKey is the BasicTokenKey implementation for TokenKey.

func (TokenKey) AsRsaTokenKey

func (tk TokenKey) AsRsaTokenKey() (*RsaTokenKey, bool)

AsRsaTokenKey is the BasicTokenKey implementation for TokenKey.

func (TokenKey) AsTokenKey

func (tk TokenKey) AsTokenKey() (*TokenKey, bool)

AsTokenKey is the BasicTokenKey implementation for TokenKey.

func (TokenKey) MarshalJSON

func (tk TokenKey) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TokenKey.

type TrackedResource

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

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

func (TrackedResource) MarshalJSON

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

MarshalJSON is the custom marshaler for TrackedResource.

type Type

type Type string

Type enumerates the values for type.

const (
	// TypeTypeAuthenticationBase ...
	TypeTypeAuthenticationBase Type = "AuthenticationBase"
	// TypeTypeMicrosoftVideoAnalyzerJwtAuthentication ...
	TypeTypeMicrosoftVideoAnalyzerJwtAuthentication Type = "#Microsoft.VideoAnalyzer.JwtAuthentication"
)

func PossibleTypeValues

func PossibleTypeValues() []Type

PossibleTypeValues returns an array of possible values for the Type const type.

type TypeBasicTokenKey

type TypeBasicTokenKey string

TypeBasicTokenKey enumerates the values for type basic token key.

const (
	// TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerEccTokenKey ...
	TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerEccTokenKey TypeBasicTokenKey = "#Microsoft.VideoAnalyzer.EccTokenKey"
	// TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerRsaTokenKey ...
	TypeBasicTokenKeyTypeMicrosoftVideoAnalyzerRsaTokenKey TypeBasicTokenKey = "#Microsoft.VideoAnalyzer.RsaTokenKey"
	// TypeBasicTokenKeyTypeTokenKey ...
	TypeBasicTokenKeyTypeTokenKey TypeBasicTokenKey = "TokenKey"
)

func PossibleTypeBasicTokenKeyValues

func PossibleTypeBasicTokenKeyValues() []TypeBasicTokenKey

PossibleTypeBasicTokenKeyValues returns an array of possible values for the TypeBasicTokenKey const type.

type Update

type Update struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// PropertiesUpdate - The resource properties.
	*PropertiesUpdate `json:"properties,omitempty"`
	// Identity - The identities associated to the Video Analyzer resource.
	Identity *Identity `json:"identity,omitempty"`
}

Update the update operation for a Video Analyzer account.

func (Update) MarshalJSON

func (u Update) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Update.

func (*Update) UnmarshalJSON

func (u *Update) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Update struct.

type UserAssignedManagedIdentity

type UserAssignedManagedIdentity struct {
	// ClientID - READ-ONLY; The client ID.
	ClientID *string `json:"clientId,omitempty"`
	// PrincipalID - READ-ONLY; The principal ID.
	PrincipalID *string `json:"principalId,omitempty"`
}

UserAssignedManagedIdentity the details of the user assigned managed identity used by the Video Analyzer resource.

type VideoAnalyzersClient

type VideoAnalyzersClient struct {
	BaseClient
}

VideoAnalyzersClient is the azure Video Analyzer ARM Client

func NewVideoAnalyzersClient

func NewVideoAnalyzersClient(subscriptionID string) VideoAnalyzersClient

NewVideoAnalyzersClient creates an instance of the VideoAnalyzersClient client.

func NewVideoAnalyzersClientWithBaseURI

func NewVideoAnalyzersClientWithBaseURI(baseURI string, subscriptionID string) VideoAnalyzersClient

NewVideoAnalyzersClientWithBaseURI creates an instance of the VideoAnalyzersClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (VideoAnalyzersClient) CreateOrUpdate

func (client VideoAnalyzersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, parameters Model) (result Model, err error)

CreateOrUpdate create or update an instance of a Video Analyzer account Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Video Analyzer account name. parameters - the request parameters

func (VideoAnalyzersClient) CreateOrUpdatePreparer

func (client VideoAnalyzersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, parameters Model) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (VideoAnalyzersClient) CreateOrUpdateResponder

func (client VideoAnalyzersClient) CreateOrUpdateResponder(resp *http.Response) (result Model, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (VideoAnalyzersClient) CreateOrUpdateSender

func (client VideoAnalyzersClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (VideoAnalyzersClient) Delete

func (client VideoAnalyzersClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)

Delete delete the specified Video Analyzer account Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Video Analyzer account name.

func (VideoAnalyzersClient) DeletePreparer

func (client VideoAnalyzersClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (VideoAnalyzersClient) DeleteResponder

func (client VideoAnalyzersClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (VideoAnalyzersClient) DeleteSender

func (client VideoAnalyzersClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (VideoAnalyzersClient) Get

func (client VideoAnalyzersClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result Model, err error)

Get get the details of the specified Video Analyzer account Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Video Analyzer account name.

func (VideoAnalyzersClient) GetPreparer

func (client VideoAnalyzersClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (VideoAnalyzersClient) GetResponder

func (client VideoAnalyzersClient) GetResponder(resp *http.Response) (result Model, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (VideoAnalyzersClient) GetSender

func (client VideoAnalyzersClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (VideoAnalyzersClient) List

func (client VideoAnalyzersClient) List(ctx context.Context, resourceGroupName string) (result Collection, err error)

List lists the Video Analyzer accounts in the specified resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (VideoAnalyzersClient) ListBySubscription

func (client VideoAnalyzersClient) ListBySubscription(ctx context.Context) (result Collection, err error)

ListBySubscription lists the Video Analyzer accounts in the specific subscription.

func (VideoAnalyzersClient) ListBySubscriptionPreparer

func (client VideoAnalyzersClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (VideoAnalyzersClient) ListBySubscriptionResponder

func (client VideoAnalyzersClient) ListBySubscriptionResponder(resp *http.Response) (result Collection, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (VideoAnalyzersClient) ListBySubscriptionSender

func (client VideoAnalyzersClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (VideoAnalyzersClient) ListPreparer

func (client VideoAnalyzersClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (VideoAnalyzersClient) ListResponder

func (client VideoAnalyzersClient) ListResponder(resp *http.Response) (result Collection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (VideoAnalyzersClient) ListSender

func (client VideoAnalyzersClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (VideoAnalyzersClient) SyncStorageKeys

func (client VideoAnalyzersClient) SyncStorageKeys(ctx context.Context, resourceGroupName string, accountName string, parameters SyncStorageKeysInput) (result autorest.Response, err error)

SyncStorageKeys synchronizes storage account keys for a storage account associated with the Video Analyzer account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Video Analyzer account name. parameters - the request parameters.

func (VideoAnalyzersClient) SyncStorageKeysPreparer

func (client VideoAnalyzersClient) SyncStorageKeysPreparer(ctx context.Context, resourceGroupName string, accountName string, parameters SyncStorageKeysInput) (*http.Request, error)

SyncStorageKeysPreparer prepares the SyncStorageKeys request.

func (VideoAnalyzersClient) SyncStorageKeysResponder

func (client VideoAnalyzersClient) SyncStorageKeysResponder(resp *http.Response) (result autorest.Response, err error)

SyncStorageKeysResponder handles the response to the SyncStorageKeys request. The method always closes the http.Response Body.

func (VideoAnalyzersClient) SyncStorageKeysSender

func (client VideoAnalyzersClient) SyncStorageKeysSender(req *http.Request) (*http.Response, error)

SyncStorageKeysSender sends the SyncStorageKeys request. The method will close the http.Response Body if it receives an error.

func (VideoAnalyzersClient) Update

func (client VideoAnalyzersClient) Update(ctx context.Context, resourceGroupName string, accountName string, parameters Update) (result Model, err error)

Update updates an existing instance of Video Analyzer account Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Video Analyzer account name. parameters - the request parameters

func (VideoAnalyzersClient) UpdatePreparer

func (client VideoAnalyzersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, parameters Update) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (VideoAnalyzersClient) UpdateResponder

func (client VideoAnalyzersClient) UpdateResponder(resp *http.Response) (result Model, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (VideoAnalyzersClient) UpdateSender

func (client VideoAnalyzersClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type VideoEntity

type VideoEntity struct {
	autorest.Response `json:"-"`
	// VideoProperties - The resource properties.
	*VideoProperties `json:"properties,omitempty"`
	// SystemData - READ-ONLY; The system metadata relating to this resource.
	SystemData *SystemData `json:"systemData,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

VideoEntity the representation of a single video in a Video Analyzer account.

func (VideoEntity) MarshalJSON

func (ve VideoEntity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VideoEntity.

func (*VideoEntity) UnmarshalJSON

func (ve *VideoEntity) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for VideoEntity struct.

type VideoEntityCollection

type VideoEntityCollection struct {
	autorest.Response `json:"-"`
	// Value - A collection of VideoEntity items.
	Value *[]VideoEntity `json:"value,omitempty"`
	// NextLink - 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"`
}

VideoEntityCollection a collection of VideoEntity items.

func (VideoEntityCollection) IsEmpty

func (vec VideoEntityCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type VideoEntityCollectionIterator

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

VideoEntityCollectionIterator provides access to a complete listing of VideoEntity values.

func NewVideoEntityCollectionIterator

func NewVideoEntityCollectionIterator(page VideoEntityCollectionPage) VideoEntityCollectionIterator

Creates a new instance of the VideoEntityCollectionIterator type.

func (*VideoEntityCollectionIterator) Next

func (iter *VideoEntityCollectionIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*VideoEntityCollectionIterator) NextWithContext

func (iter *VideoEntityCollectionIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (VideoEntityCollectionIterator) NotDone

func (iter VideoEntityCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (VideoEntityCollectionIterator) Response

Response returns the raw server response from the last page request.

func (VideoEntityCollectionIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type VideoEntityCollectionPage

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

VideoEntityCollectionPage contains a page of VideoEntity values.

func NewVideoEntityCollectionPage

Creates a new instance of the VideoEntityCollectionPage type.

func (*VideoEntityCollectionPage) Next

func (page *VideoEntityCollectionPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*VideoEntityCollectionPage) NextWithContext

func (page *VideoEntityCollectionPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (VideoEntityCollectionPage) NotDone

func (page VideoEntityCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (VideoEntityCollectionPage) Response

Response returns the raw server response from the last page request.

func (VideoEntityCollectionPage) Values

func (page VideoEntityCollectionPage) Values() []VideoEntity

Values returns the slice of values for the current page or nil if there are no values.

type VideoFlags

type VideoFlags struct {
	// CanStream - Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.
	CanStream *bool `json:"canStream,omitempty"`
	// HasData - 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"`
	// IsRecording - Value indicating whether or not the video is currently being referenced be an active live 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.
	IsRecording *bool `json:"isRecording,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 {
	// SegmentLength - READ-ONLY; 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 VideoProperties

type VideoProperties struct {
	// Title - Optional video title provided by the user. Value can be up to 256 characters long.
	Title *string `json:"title,omitempty"`
	// Description - Optional video description provided by the user. Value can be up to 2048 characters long.
	Description *string `json:"description,omitempty"`
	// Type - READ-ONLY; Type of the video archive. Different archive formats provide different capabilities. Possible values include: 'VideoTypeArchive'
	Type VideoType `json:"type,omitempty"`
	// Flags - 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"`
	// Streaming - READ-ONLY; Video streaming holds information about video streaming URLs.
	Streaming *VideoStreaming `json:"streaming,omitempty"`
	// MediaInfo - READ-ONLY; Contains information about the video and audio content.
	MediaInfo *VideoMediaInfo `json:"mediaInfo,omitempty"`
}

VideoProperties application level properties for the video resource.

func (VideoProperties) MarshalJSON

func (vp VideoProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VideoProperties.

type VideoStreaming

type VideoStreaming struct {
	// ArchiveBaseURL - Video streaming base URL for the video archive. When present, archived video can be played through the Azure Video Analyzer player. Alternatively, this URL can be used with 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.
	ArchiveBaseURL *string `json:"archiveBaseUrl,omitempty"`
}

VideoStreaming video streaming holds information about video streaming URLs.

type VideoStreamingToken

type VideoStreamingToken struct {
	autorest.Response `json:"-"`
	// ExpirationDate - READ-ONLY; The streaming token expiration date in ISO8601 format (eg. 2021-01-01T00:00:00Z).
	ExpirationDate *date.Time `json:"expirationDate,omitempty"`
	// Token - READ-ONLY; The streaming token value to be added to the video streaming URL as the value for a "token" query string parameter. The token is specific to a single video.
	Token *string `json:"token,omitempty"`
}

VideoStreamingToken video streaming token grants access to the video streaming URLs which can be used by an compatible HLS or DASH player.

type VideoType

type VideoType string

VideoType enumerates the values for video type.

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.
	// Finally, 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.
	VideoTypeArchive VideoType = "Archive"
)

func PossibleVideoTypeValues

func PossibleVideoTypeValues() []VideoType

PossibleVideoTypeValues returns an array of possible values for the VideoType const type.

type VideosClient

type VideosClient struct {
	BaseClient
}

VideosClient is the azure Video Analyzer ARM Client

func NewVideosClient

func NewVideosClient(subscriptionID string) VideosClient

NewVideosClient creates an instance of the VideosClient client.

func NewVideosClientWithBaseURI

func NewVideosClientWithBaseURI(baseURI string, subscriptionID string) VideosClient

NewVideosClientWithBaseURI creates an instance of the VideosClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (VideosClient) CreateOrUpdate

func (client VideosClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, videoName string, parameters VideoEntity) (result VideoEntity, err error)

CreateOrUpdate creates a new video resource or updates an existing one in an account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. videoName - the name of the video to create or update. parameters - the request parameters

func (VideosClient) CreateOrUpdatePreparer

func (client VideosClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, videoName string, parameters VideoEntity) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (VideosClient) CreateOrUpdateResponder

func (client VideosClient) CreateOrUpdateResponder(resp *http.Response) (result VideoEntity, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (VideosClient) CreateOrUpdateSender

func (client VideosClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (VideosClient) Delete

func (client VideosClient) Delete(ctx context.Context, resourceGroupName string, accountName string, videoName string) (result autorest.Response, err error)

Delete deletes an existing video resource and its underlying data. This operation is irreversible. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. videoName - the name of the video to delete.

func (VideosClient) DeletePreparer

func (client VideosClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, videoName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (VideosClient) DeleteResponder

func (client VideosClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (VideosClient) DeleteSender

func (client VideosClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (VideosClient) Get

func (client VideosClient) Get(ctx context.Context, resourceGroupName string, accountName string, videoName string) (result VideoEntity, err error)

Get retrieves an existing video resource within an account with a given name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. videoName - the name of the video to retrieve.

func (VideosClient) GetPreparer

func (client VideosClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, videoName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (VideosClient) GetResponder

func (client VideosClient) GetResponder(resp *http.Response) (result VideoEntity, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (VideosClient) GetSender

func (client VideosClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (VideosClient) List

func (client VideosClient) List(ctx context.Context, resourceGroupName string, accountName string, top *int32) (result VideoEntityCollectionPage, err error)

List list all existing video resources in the specified account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. top - 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.

func (VideosClient) ListComplete

func (client VideosClient) ListComplete(ctx context.Context, resourceGroupName string, accountName string, top *int32) (result VideoEntityCollectionIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (VideosClient) ListPreparer

func (client VideosClient) ListPreparer(ctx context.Context, resourceGroupName string, accountName string, top *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (VideosClient) ListResponder

func (client VideosClient) ListResponder(resp *http.Response) (result VideoEntityCollection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (VideosClient) ListSender

func (client VideosClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (VideosClient) ListStreamingToken

func (client VideosClient) ListStreamingToken(ctx context.Context, resourceGroupName string, accountName string, videoName string) (result VideoStreamingToken, err error)

ListStreamingToken generates a streaming token used for authenticating video playback. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. videoName - the name of the video to generate a token for playback.

func (VideosClient) ListStreamingTokenPreparer

func (client VideosClient) ListStreamingTokenPreparer(ctx context.Context, resourceGroupName string, accountName string, videoName string) (*http.Request, error)

ListStreamingTokenPreparer prepares the ListStreamingToken request.

func (VideosClient) ListStreamingTokenResponder

func (client VideosClient) ListStreamingTokenResponder(resp *http.Response) (result VideoStreamingToken, err error)

ListStreamingTokenResponder handles the response to the ListStreamingToken request. The method always closes the http.Response Body.

func (VideosClient) ListStreamingTokenSender

func (client VideosClient) ListStreamingTokenSender(req *http.Request) (*http.Response, error)

ListStreamingTokenSender sends the ListStreamingToken request. The method will close the http.Response Body if it receives an error.

func (VideosClient) Update

func (client VideosClient) Update(ctx context.Context, resourceGroupName string, accountName string, videoName string, parameters VideoEntity) (result VideoEntity, err error)

Update updates individual properties of an existing video resource. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - the Azure Video Analyzer account name. videoName - the name of the video to update. parameters - the request parameters

func (VideosClient) UpdatePreparer

func (client VideosClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, videoName string, parameters VideoEntity) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (VideosClient) UpdateResponder

func (client VideosClient) UpdateResponder(resp *http.Response) (result VideoEntity, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (VideosClient) UpdateSender

func (client VideosClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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