Microsoft.Azure.Management.VideoAnalyzer.Models Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
AccessPolicyEccAlgoConverter |
Defines values for AccessPolicyEccAlgo. |
AccessPolicyEntity |
Access policies help define the authentication rules, and control access to specific video resources. |
AccessPolicyRoleConverter |
Defines values for AccessPolicyRole. |
AccessPolicyRsaAlgoConverter |
Defines values for AccessPolicyRsaAlgo. |
AccountEncryption |
Defines how the Video Analyzer account is (optionally) encrypted. |
AccountEncryptionKeyTypeConverter |
Defines values for AccountEncryptionKeyType. |
ActionTypeConverter |
Defines values for ActionType. |
AudioEncoderAac |
A custom preset for encoding audio with the AAC codec. |
AudioEncoderBase |
Base type for all audio encoder presets, which define the recipe or instructions on how audio should be processed. |
AuthenticationBase |
Base class for access policies authentication methods. |
AzureEntityResource |
Entity Resource |
CertificateSource |
Base class for certificate sources. |
CheckNameAvailabilityReasonConverter |
Defines values for CheckNameAvailabilityReason. |
CheckNameAvailabilityRequest |
The check availability request body. |
CheckNameAvailabilityResponse |
The check availability result. |
CreatedByTypeConverter |
Defines values for CreatedByType. |
CredentialsBase |
Base class for credential objects. |
EccTokenKey |
Required validation properties for tokens generated with Elliptical Curve algorithm. |
EdgeModuleEntity |
The representation of an edge module. |
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. |
EncoderCustomPreset |
Describes a custom preset for encoding the input content using the encoder processor. |
EncoderPresetBase |
Base type for all encoder presets, which define the recipe or instructions on how the input content should be processed. |
EncoderProcessor |
Encoder processor allows for encoding of the input content. For example, it can used to change the resolution from 4K to 1280x720. |
EncoderSystemPreset |
Describes a built-in preset for encoding the input content using the encoder processor. |
EncoderSystemPresetTypeConverter |
Defines values for EncoderSystemPresetType. |
Endpoint |
The endpoint details. |
EndpointBase |
Base class for endpoints. |
ErrorAdditionalInfo |
The resource management error additional info. |
ErrorDetail |
The error detail. |
ErrorResponse |
Error response |
ErrorResponseException |
Exception thrown for an invalid response with ErrorResponse information. |
GroupLevelAccessControl |
Group level network access control. |
IotHub |
The IoT Hub details. |
JwtAuthentication |
Properties for access validation based on JSON Web Tokens (JWT). |
KeyVaultProperties |
The details for accessing the encryption keys in Key Vault. |
KindConverter |
Defines values for Kind. |
ListProvisioningTokenInput |
The input parameters to generate registration token for the Azure Video Analyzer IoT edge module. |
LivePipeline |
Live pipeline represents a unique instance of a live topology, used for real-time ingestion, archiving and publishing of content for a unique RTSP camera. |
LivePipelineOperationStatus |
Used for tracking the status of an operation on the live pipeline. |
LivePipelineStateConverter |
Defines values for LivePipelineState. |
LivePipelineUpdate |
Live pipeline represents a unique instance of a live topology, used for real-time ingestion, archiving and publishing of content for a unique RTSP camera. |
LogSpecification |
A diagnostic log emitted by service. |
MetricAggregationTypeConverter |
Defines values for MetricAggregationType. |
MetricDimension |
A metric dimension. |
MetricSpecification |
A metric emitted by service. |
MetricUnitConverter |
Defines values for MetricUnit. |
NetworkAccessControl |
Network access control for video analyzer account. |
NodeBase |
Base class for nodes. |
NodeInput |
Describes an input signal to be used on a pipeline node. |
Operation |
An operation. |
OperationCollection |
A collection of Operation items. |
OperationDisplay |
Operation details. |
Page<T> |
Defines a page in Azure responses. |
ParameterDeclaration |
Single topology parameter declaration. Declared parameters can and must be referenced throughout the topology and can optionally have default values to be used when they are not defined in the pipelines. |
ParameterDefinition |
Defines the parameter value of an specific pipeline topology parameter. See pipeline topology parameters for more information. |
ParameterTypeConverter |
Defines values for ParameterType. |
PemCertificateList |
A list of PEM formatted certificates. |
PipelineJob |
Pipeline job represents a unique instance of a batch topology, used for offline processing of selected portions of archived content. |
PipelineJobError |
Details about the error for a failed pipeline job. |
PipelineJobOperationStatus |
Used for tracking the status of an operation on the pipeline job. |
PipelineJobStateConverter |
Defines values for PipelineJobState. |
PipelineJobUpdate |
Pipeline job represents a unique instance of a batch topology, used for offline processing of selected portions of archived content. |
PipelineTopology |
Pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which captures content from a RTSP camera and archives the content can be reused across many different cameras, as long as the same processing is to be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized. This allows individual pipelines refer to different values, such as individual cameras' RTSP endpoints and credentials. Overall a topology is composed of the following:
|
PipelineTopologyUpdate |
Pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which captures content from a RTSP camera and archives the content can be reused across many different cameras, as long as the same processing is to be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized. This allows individual pipelines refer to different values, such as individual cameras' RTSP endpoints and credentials. Overall a topology is composed of the following:
|
PrivateEndpoint |
The Private Endpoint resource. |
PrivateEndpointConnection |
The Private Endpoint Connection resource. |
PrivateEndpointConnectionListResult |
List of private endpoint connection associated with the specified storage account |
PrivateEndpointConnectionProvisioningStateConverter |
Defines values for PrivateEndpointConnectionProvisioningState. |
PrivateEndpointConnectionsCreateOrUpdateHeaders |
Defines headers for CreateOrUpdate operation. |
PrivateEndpointServiceConnectionStatusConverter |
Defines values for PrivateEndpointServiceConnectionStatus. |
PrivateLinkResource |
A private link resource |
PrivateLinkResourceListResult |
A list of private link resources |
PrivateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
ProcessorNodeBase |
Base class for topology processor nodes. |
Properties |
Metric properties. |
ProvisioningStateConverter |
Defines values for ProvisioningState. |
ProxyResource |
Proxy Resource |
PublicNetworkAccessConverter |
Defines values for PublicNetworkAccess. |
Resource |
Resource |
ResourceIdentity |
The user assigned managed identity to use when accessing a resource. |
RsaTokenKey |
Required validation properties for tokens generated with RSA algorithm. |
RtspSource |
RTSP source allows for media from an RTSP camera or generic RTSP server to be ingested into a pipeline. |
RtspTransportConverter |
Defines values for RtspTransport. |
SecureIotDeviceRemoteTunnel |
A remote tunnel securely established using IoT Hub device information. |
ServiceSpecification |
The service metric specifications. |
SinkNodeBase |
Base class for topology sink nodes. |
Sku |
The SKU details. |
SkuNameConverter |
Defines values for SkuName. |
SkuTierConverter |
Defines values for SkuTier. |
SourceNodeBase |
Base class for topology source nodes. |
StorageAccount |
The details about the associated storage account. |
SystemData |
Metadata pertaining to creation and last modification of the resource. |
TimeSequenceBase |
A sequence of datetime ranges as a string. |
TlsEndpoint |
TLS endpoint describes an endpoint that the pipeline can connect to over TLS transport (data is encrypted in transit). |
TlsValidationOptions |
Options for controlling the validation of TLS endpoints. |
TokenClaim |
Properties for expected token claims. |
TokenKey |
Key properties for JWT token validation. |
TrackedResource |
Tracked Resource |
TunnelBase |
Base class for tunnel objects. |
UnsecuredEndpoint |
Unsecured endpoint describes an endpoint that the pipeline can connect to over clear transport (no encryption in transit). |
UserAssignedManagedIdentity |
The details of the user assigned managed identity used by the Video Analyzer resource. |
UsernamePasswordCredentials |
Username and password credentials. |
VideoAnalyzerAccount |
The Video Analyzer account. |
VideoAnalyzerCollection |
A collection of VideoAnalyzer items. |
VideoAnalyzerIdentity |
The managed identity for the Video Analyzer resource. |
VideoAnalyzerOperationStatus |
Status of video analyzer operation. |
VideoAnalyzerPrivateEndpointConnectionOperationStatus |
Status of private endpoint connection operation. |
VideoAnalyzersCreateOrUpdateHeaders |
Defines headers for CreateOrUpdate operation. |
VideoAnalyzersUpdateHeaders |
Defines headers for Update operation. |
VideoAnalyzerUpdate |
The update operation for a Video Analyzer account. |
VideoArchival |
Video archival properties. |
VideoContentToken |
"Video content token grants access to the video content URLs." |
VideoContentUrls |
Set of URLs to the video content. |
VideoCreationProperties |
Optional properties to be used in case a new video resource needs to be created on the service. These will not take effect if the video already exists. |
VideoEncoderBase |
Base type for all video encoding presets, which define the recipe or instructions on how the input video should be processed. |
VideoEncoderH264 |
A custom preset for encoding video with the H.264 (AVC) codec. |
VideoEntity |
Represents a video resource within Azure Video Analyzer. Videos can be ingested from RTSP cameras through live pipelines or can be created by exporting sequences from existing captured video through a pipeline job. Videos ingested through live pipelines can be streamed through Azure Video Analyzer Player Widget or compatible players. Exported videos can be downloaded as MP4 files. |
VideoFlags |
Video flags contain information about the available video actions and its dynamic properties based on the current video state. |
VideoMediaInfo |
Contains information about the video and audio content. |
VideoPreviewImageUrls |
Video preview image URLs. These URLs can be used in conjunction with the video content authorization token to download the most recent still image from the video archive in different resolutions. They are available when the video type is 'archive' and preview images are enabled. |
VideoPublishingOptions |
Optional flags used to change how video is published. These are only allowed for topologies where "kind" is set to "live". |
VideoScale |
The video scaling information. |
VideoScaleModeConverter |
Defines values for VideoScaleMode. |
VideoSequenceAbsoluteTimeMarkers |
A sequence of absolute datetime ranges as a string. The datetime values should follow IS08601, and the sum of the ranges should add up to 24 hours or less. Currently, there can be only one range specified in the sequence. |
VideoSink |
Video sink in a live topology allows for video and audio to be captured, optionally archived, and published via a video resource. If archiving is enabled, this results in a video of type 'archive'. If used in a batch topology, this allows for video and audio to be stored as a file, and published via a video resource of type 'file' |
VideoSource |
Video source allows for content from a Video Analyzer video resource to be ingested into a pipeline. Currently supported only with batch pipelines. |
VideoTypeConverter |
Defines values for VideoType. |
Structs
AccessPolicyEccAlgo |
Defines values for AccessPolicyEccAlgo. |
AccessPolicyRole |
Defines values for AccessPolicyRole. |
AccessPolicyRsaAlgo |
Defines values for AccessPolicyRsaAlgo. |
AccountEncryptionKeyType |
Defines values for AccountEncryptionKeyType. |
ActionType |
Defines values for ActionType. |
CheckNameAvailabilityReason |
Defines values for CheckNameAvailabilityReason. |
CreatedByType |
Defines values for CreatedByType. |
EncoderSystemPresetType |
Defines values for EncoderSystemPresetType. |
Kind |
Defines values for Kind. |
LivePipelineState |
Defines values for LivePipelineState. |
MetricAggregationType |
Defines values for MetricAggregationType. |
MetricUnit |
Defines values for MetricUnit. |
ParameterType |
Defines values for ParameterType. |
PipelineJobState |
Defines values for PipelineJobState. |
PrivateEndpointConnectionProvisioningState |
Defines values for PrivateEndpointConnectionProvisioningState. |
PrivateEndpointServiceConnectionStatus |
Defines values for PrivateEndpointServiceConnectionStatus. |
ProvisioningState |
Defines values for ProvisioningState. |
PublicNetworkAccess |
Defines values for PublicNetworkAccess. |
RtspTransport |
Defines values for RtspTransport. |
SkuName |
Defines values for SkuName. |
SkuTier |
Defines values for SkuTier. |
VideoScaleMode |
Defines values for VideoScaleMode. |
VideoType |
Defines values for VideoType. |