@azure/arm-videoanalyzer package

Interface representing a AccessPolicies.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

A collection of AccessPolicyEntity items.

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

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

Base class for access policies authentication methods.

Base class for certificate sources.

The check availability request body.

The check availability result.

Base class for credential objects.

A collection of EdgeModuleEntity items.

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.

Interface representing a EdgeModules.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

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

The endpoint details.

Base class for endpoints.

The resource management error additional info.

The error detail.

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

Group level network access control.

The IoT Hub details.

The details for accessing the encryption keys in Key Vault.

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

A collection of LivePipeline items.

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

Interface representing a LivePipelineOperationStatuses.

Optional parameters.

Interface representing a LivePipelines.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Locations.

Optional parameters.

A diagnostic log emitted by service.

A metric dimension.

A metric emitted by service.

Network access control for video analyzer account.

Base class for nodes.

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

An operation.

A collection of Operation items.

Operation details.

Interface representing a OperationResults.

Optional parameters.

Interface representing a OperationStatuses.

Optional parameters.

Interface representing a Operations.

Optional parameters.

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.

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

A collection of PipelineJob items.

Details about the error for a failed pipeline job.

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

Interface representing a PipelineJobOperationStatuses.

Optional parameters.

Interface representing a PipelineJobs.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a PipelineTopologies.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

A collection of PipelineTopology items.

The Private Endpoint resource.

List of private endpoint connection associated with the specified storage account

Interface representing a PrivateEndpointConnections.

Defines headers for PrivateEndpointConnections_createOrUpdate operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

A list of private link resources

Interface representing a PrivateLinkResources.

Optional parameters.

Optional parameters.

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

Metric properties.

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

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

The service metric specifications.

The SKU details.

The details about the associated storage account.

Metadata pertaining to creation and last modification of the resource.

A sequence of datetime ranges as a string.

Options for controlling the validation of TLS endpoints.

Properties for expected token claims.

Key properties for JWT token validation.

Base class for tunnel objects.

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

A collection of VideoAnalyzer items.

The managed identity for the Video Analyzer resource.

Optional parameters.

Interface representing a VideoAnalyzerOperationResults.

Optional parameters.

Status of video analyzer operation.

Interface representing a VideoAnalyzerOperationStatuses.

Optional parameters.

Status of private endpoint connection operation.

The update operation for a Video Analyzer account.

Interface representing a VideoAnalyzers.

Defines headers for VideoAnalyzers_createOrUpdate operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for VideoAnalyzers_update operation.

Optional parameters.

Video archival properties.

"Video content token grants access to the video content URLs."

Set of URLs to the video content.

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.

Base type for all video encoding presets, which define the recipe or instructions on how the input video should be processed.

A collection of VideoEntity items.

Video flags contain information about the available video actions and its dynamic properties based on the current video state.

Contains information about the video and audio content.

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.

Optional flags used to change how video is published. These are only allowed for topologies where "kind" is set to "live".

The video scaling information.

Interface representing a Videos.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Defines values for AccessPolicyEccAlgo.
KnownAccessPolicyEccAlgo can be used interchangeably with AccessPolicyEccAlgo, this enum contains the known values that the service supports.

Known values supported by the service

ES256: ES265
ES384: ES384
ES512: ES512

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

Defines values for AccessPolicyRole.
KnownAccessPolicyRole can be used interchangeably with AccessPolicyRole, this enum contains the known values that the service supports.

Known values supported by the service

Reader: Reader role allows for read-only operations to be performed through the client APIs.

Defines values for AccessPolicyRsaAlgo.
KnownAccessPolicyRsaAlgo can be used interchangeably with AccessPolicyRsaAlgo, this enum contains the known values that the service supports.

Known values supported by the service

RS256: RS256
RS384: RS384
RS512: RS512

Defines values for AccountEncryptionKeyType.
KnownAccountEncryptionKeyType can be used interchangeably with AccountEncryptionKeyType, this enum contains the known values that the service supports.

Known values supported by the service

SystemKey: The Account Key is encrypted with a System Key.
CustomerKey: The Account Key is encrypted with a Customer Key.

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: An internal action.

A custom preset for encoding audio with the AAC codec.

Defines values for CheckNameAvailabilityReason.
KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
AlreadyExists

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Required validation properties for tokens generated with Elliptical Curve algorithm.

The representation of an edge module.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the listProvisioningToken operation.

Contains response data for the list operation.

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

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

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

Defines values for EncoderSystemPresetType.
KnownEncoderSystemPresetType can be used interchangeably with EncoderSystemPresetType, this enum contains the known values that the service supports.

Known values supported by the service

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

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

Defines values for Kind.
KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports.

Known values supported by the service

Live: Live pipeline topology resource.
Batch: Batch pipeline topology resource.

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.

Contains response data for the get operation.

Defines values for LivePipelineState.
KnownLivePipelineState can be used interchangeably with LivePipelineState, this enum contains the known values that the service supports.

Known values supported by the service

Inactive: The live pipeline is idle and not processing media.
Activating: The live pipeline is transitioning into the active state.
Active: The live pipeline is active and able to process media. If your data source is not available, for instance, if your RTSP camera is powered off or unreachable, the pipeline will still be active and periodically retrying the connection. Your Azure subscription will be billed for the duration in which the live pipeline is in the active state.
Deactivating: The live pipeline is transitioning into the inactive state.

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.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Contains response data for the checkNameAvailability operation.

Defines values for MetricAggregationType.
KnownMetricAggregationType can be used interchangeably with MetricAggregationType, this enum contains the known values that the service supports.

Known values supported by the service

Average: The average.
Count: The count of a number of items, usually requests.
Total: The sum.

Defines values for MetricUnit.
KnownMetricUnit can be used interchangeably with MetricUnit, this enum contains the known values that the service supports.

Known values supported by the service

Bytes: The number of bytes.
Count: The count.
Milliseconds: The number of milliseconds.

Contains response data for the get operation.

Contains response data for the get operation.

Contains response data for the list operation.

Defines values for ParameterType.
KnownParameterType can be used interchangeably with ParameterType, this enum contains the known values that the service supports.

Known values supported by the service

String: The parameter's value is a string.
SecretString: The parameter's value is a string that holds sensitive information.
Int: The parameter's value is a 32-bit signed integer.
Double: The parameter's value is a 64-bit double-precision floating point.
Bool: The parameter's value is a boolean value that is either true or false.

A list of PEM formatted certificates.

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

Contains response data for the get operation.

Defines values for PipelineJobState.
KnownPipelineJobState can be used interchangeably with PipelineJobState, this enum contains the known values that the service supports.

Known values supported by the service

Processing: Pipeline job is processing.
Canceled: Pipeline job is canceled.
Completed: Pipeline job completed.
Failed: Pipeline job failed.

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

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which captures content from a RTSP camera and archives the content can be reused across many different cameras, as long as the same processing is to be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized. This allows individual pipelines refer to different values, such as individual cameras' RTSP endpoints and credentials. Overall a topology is composed of the following:

• Parameters: list of user defined parameters that can be references across the topology nodes.
• Sources: list of one or more data sources nodes such as an RTSP source which allows for content to be ingested from cameras.
• Processors: list of nodes which perform data analysis or transformations.
• Sinks: list of one or more data sinks which allow for data to be stored or exported to other destinations.

Pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which captures content from a RTSP camera and archives the content can be reused across many different cameras, as long as the same processing is to be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized. This allows individual pipelines refer to different values, such as individual cameras' RTSP endpoints and credentials. Overall a topology is composed of the following:

• Parameters: list of user defined parameters that can be references across the topology nodes.
• Sources: list of one or more data sources nodes such as an RTSP source which allows for content to be ingested from cameras.
• Processors: list of nodes which perform data analysis or transformations.
• Sinks: list of one or more data sinks which allow for data to be stored or exported to other destinations.

The Private Endpoint Connection resource.

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the list operation.

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

A private link resource

Contains response data for the get operation.

Contains response data for the list operation.

Base class for topology processor nodes.

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Failed: Provisioning state failed.
InProgress: Provisioning state in progress.
Succeeded: Provisioning state succeeded.

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

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Public network access is enabled.
Disabled: Public network access is disabled.

Required validation properties for tokens generated with RSA algorithm.

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

Defines values for RtspTransport.
KnownRtspTransport can be used interchangeably with RtspTransport, this enum contains the known values that the service supports.

Known values supported by the service

Http: HTTP transport. RTSP messages are exchanged over long running HTTP requests and RTP packets are interleaved within the HTTP channel.
Tcp: TCP transport. RTSP is used directly over TCP and RTP packets are interleaved within the TCP channel.

A remote tunnel securely established using IoT Hub device information.

Base class for topology sink nodes.

Defines values for SkuName.
KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports.

Known values supported by the service

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

Defines values for SkuTier.
KnownSkuTier can be used interchangeably with SkuTier, this enum contains the known values that the service supports.

Known values supported by the service

Standard: Standard tier.

Base class for topology source nodes.

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

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

Unsecured endpoint describes an endpoint that the pipeline can connect to over clear transport (no encryption in transit).

Username and password credentials.

The Video Analyzer account.

Defines values for VideoAnalyzerEndpointType.
KnownVideoAnalyzerEndpointType can be used interchangeably with VideoAnalyzerEndpointType, this enum contains the known values that the service supports.

Known values supported by the service

ClientApi: The client API endpoint.

Contains response data for the get operation.

Contains response data for the get operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listBySubscription operation.

Contains response data for the list operation.

Contains response data for the update operation.

A custom preset for encoding video with the H.264 (AVC) codec.

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.

Defines values for VideoScaleMode.
KnownVideoScaleMode can be used interchangeably with VideoScaleMode, this enum contains the known values that the service supports.

Known values supported by the service

Pad: Pads the video with black horizontal stripes (letterbox) or black vertical stripes (pillar-box) so the video is resized to the specified dimensions while not altering the content aspect ratio.
PreserveAspectRatio: Preserves the same aspect ratio as the input video. If only one video dimension is provided, the second dimension is calculated based on the input video aspect ratio. When 2 dimensions are provided, the video is resized to fit the most constraining dimension, considering the input video size and aspect ratio.
Stretch: Stretches the original video so it resized to the specified dimensions.

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.

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'

Video source allows for content from a Video Analyzer video resource to be ingested into a pipeline. Currently supported only with batch pipelines.

Defines values for VideoType.
KnownVideoType can be used interchangeably with VideoType, this enum contains the known values that the service supports.

Known values supported by the service

Archive: Archive is flexible format that represents a video stream associated with wall-clock time. The video archive can either be continuous or discontinuous. An archive is discontinuous when there are gaps in the recording due to various reasons, such as the live pipeline being stopped, camera being disconnected or due to the use of event based recordings through the use of a signal gate. There is no limit to the archive duration and new video data can be appended to the existing archive at any time, as long as the same video codec and codec parameters are being used. Videos of this type are suitable for appending and long term archival.
File: File represents a video which is stored as a single media file, such as MP4. Videos of this type are suitable to be downloaded for external consumption.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listContentToken operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Known values of AccessPolicyEccAlgo that the service accepts.

Known values of AccessPolicyRole that the service accepts.

Known values of AccessPolicyRsaAlgo that the service accepts.

Known values of AccountEncryptionKeyType that the service accepts.

Known values of ActionType that the service accepts.

Known values of CheckNameAvailabilityReason that the service accepts.

Known values of CreatedByType that the service accepts.

Known values of EncoderSystemPresetType that the service accepts.

Known values of Kind that the service accepts.

Known values of LivePipelineState that the service accepts.

Known values of MetricAggregationType that the service accepts.

Known values of MetricUnit that the service accepts.

Known values of ParameterType that the service accepts.

Known values of PipelineJobState that the service accepts.

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

Known values of ProvisioningState that the service accepts.

Known values of PublicNetworkAccess that the service accepts.

Known values of RtspTransport that the service accepts.

Known values of SkuName that the service accepts.

Known values of SkuTier that the service accepts.

Known values of VideoAnalyzerEndpointType that the service accepts.

Known values of VideoScaleMode that the service accepts.

Known values of VideoType that the service accepts.