pulumi-azure-native-kotlin/com.pulumi.azurenative.videoanalyzer.kotlin.outputs

Package-level declarations

Types

data class AccountEncryptionResponse(val identity: ResourceIdentityResponse? = null, val keyVaultProperties: KeyVaultPropertiesResponse? = null, val status: String, val type: String)

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

AudioEncoderAacResponse

data class AudioEncoderAacResponse(val bitrateKbps: String? = null, val type: String)

A custom preset for encoding audio with the AAC codec.

EccTokenKeyResponse

data class EccTokenKeyResponse(val alg: String, val kid: String, val type: String, val x: String, val y: String)

Required validation properties for tokens generated with Elliptical Curve algorithm.

EncoderCustomPresetResponse

data class EncoderCustomPresetResponse(val audioEncoder: AudioEncoderAacResponse? = null, val type: String, val videoEncoder: VideoEncoderH264Response? = null)

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

EncoderProcessorResponse

data class EncoderProcessorResponse(val inputs: List<NodeInputResponse>, val name: String, val preset: Either<EncoderCustomPresetResponse, EncoderSystemPresetResponse>, val type: String)

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

EncoderSystemPresetResponse

data class EncoderSystemPresetResponse(val name: String, val type: String)

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

EndpointResponse

data class EndpointResponse(val endpointUrl: String? = null, val type: String)

The endpoint details.

GetAccessPolicyResult

data class GetAccessPolicyResult(val authentication: JwtAuthenticationResponse? = null, val azureApiVersion: String, val id: String, val name: String, val role: String? = null, val systemData: SystemDataResponse, val type: String)

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

GetEdgeModuleResult

data class GetEdgeModuleResult(val azureApiVersion: String, val edgeModuleId: String, val id: String, val name: String, val systemData: SystemDataResponse, val type: String)

The representation of an edge module.

GetLivePipelineResult

data class GetLivePipelineResult(val azureApiVersion: String, val bitrateKbps: Int, val description: String? = null, val id: String, val name: String, val parameters: List<ParameterDefinitionResponse>? = null, val state: String, val systemData: SystemDataResponse, val topologyName: String, val type: String)

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.

GetPipelineJobResult

data class GetPipelineJobResult(val azureApiVersion: String, val description: String? = null, val error: PipelineJobErrorResponse, val expiration: String, val id: String, val name: String, val parameters: List<ParameterDefinitionResponse>? = null, val state: String, val systemData: SystemDataResponse, val topologyName: String, val type: String)

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

GetPipelineTopologyResult

data class GetPipelineTopologyResult(val azureApiVersion: String, val description: String? = null, val id: String, val kind: String, val name: String, val parameters: List<ParameterDeclarationResponse>? = null, val processors: List<EncoderProcessorResponse>? = null, val sinks: List<VideoSinkResponse>, val sku: SkuResponse, val sources: List<Either<RtspSourceResponse, VideoSourceResponse>>, val systemData: SystemDataResponse, val type: String)

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:

GetPrivateEndpointConnectionResult

data class GetPrivateEndpointConnectionResult(val azureApiVersion: String, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

The Private Endpoint Connection resource.

GetVideoAnalyzerResult

data class GetVideoAnalyzerResult(val azureApiVersion: String, val encryption: AccountEncryptionResponse? = null, val endpoints: List<EndpointResponse>, val id: String, val identity: VideoAnalyzerIdentityResponse? = null, val iotHubs: List<IotHubResponse>? = null, val location: String, val name: String, val networkAccessControl: NetworkAccessControlResponse? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val storageAccounts: List<StorageAccountResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The Video Analyzer account.

GetVideoResult

data class GetVideoResult(val archival: VideoArchivalResponse? = null, val azureApiVersion: String, val contentUrls: VideoContentUrlsResponse, val description: String? = null, val flags: VideoFlagsResponse, val id: String, val mediaInfo: VideoMediaInfoResponse? = null, val name: String, val systemData: SystemDataResponse, val title: String? = null, val type: String)

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.

GroupLevelAccessControlResponse

data class GroupLevelAccessControlResponse(val publicNetworkAccess: String? = null)

Group level network access control.

IotHubResponse

data class IotHubResponse(val id: String, val identity: ResourceIdentityResponse, val status: String)

The IoT Hub details.

JwtAuthenticationResponse

data class JwtAuthenticationResponse(val audiences: List<String>? = null, val claims: List<TokenClaimResponse>? = null, val issuers: List<String>? = null, val keys: List<Either<EccTokenKeyResponse, RsaTokenKeyResponse>>? = null, val type: String)

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

KeyVaultPropertiesResponse

data class KeyVaultPropertiesResponse(val currentKeyIdentifier: String, val keyIdentifier: String)

The details for accessing the encryption keys in Key Vault.

ListEdgeModuleProvisioningTokenResult

data class ListEdgeModuleProvisioningTokenResult(val expirationDate: String, val token: String)

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.

ListVideoContentTokenResult

data class ListVideoContentTokenResult(val expirationDate: String, val token: String)

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

NetworkAccessControlResponse

data class NetworkAccessControlResponse(val consumption: GroupLevelAccessControlResponse? = null, val ingestion: GroupLevelAccessControlResponse? = null, val integration: GroupLevelAccessControlResponse? = null)

Network access control for video analyzer account.

NodeInputResponse

data class NodeInputResponse(val nodeName: String)

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

ParameterDeclarationResponse

data class ParameterDeclarationResponse(val default: String? = null, val description: String? = null, val name: String, val type: String)

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.

ParameterDefinitionResponse

data class ParameterDefinitionResponse(val name: String, val value: String? = null)

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

PemCertificateListResponse

data class PemCertificateListResponse(val certificates: List<String>, val type: String)

A list of PEM formatted certificates.

PipelineJobErrorResponse

data class PipelineJobErrorResponse(val code: String? = null, val message: String? = null)

Details about the error for a failed pipeline job.

PrivateEndpointConnectionResponse

data class PrivateEndpointConnectionResponse(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

The Private Endpoint Connection resource.

PrivateEndpointResponse

data class PrivateEndpointResponse(val id: String)

The Private Endpoint resource.

PrivateLinkServiceConnectionStateResponse

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

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

ResourceIdentityResponse

data class ResourceIdentityResponse(val userAssignedIdentity: String)

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

RsaTokenKeyResponse

data class RsaTokenKeyResponse(val alg: String, val e: String, val kid: String, val n: String, val type: String)

Required validation properties for tokens generated with RSA algorithm.

RtspSourceResponse

data class RtspSourceResponse(val endpoint: Either<TlsEndpointResponse, UnsecuredEndpointResponse>, val name: String, val transport: String? = null, val type: String)

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

SecureIotDeviceRemoteTunnelResponse

data class SecureIotDeviceRemoteTunnelResponse(val deviceId: String, val iotHubName: String, val type: String)

A remote tunnel securely established using IoT Hub device information.

SkuResponse

data class SkuResponse(val name: String, val tier: String)

The SKU details.

StorageAccountResponse

data class StorageAccountResponse(val id: String, val identity: ResourceIdentityResponse? = null, val status: String)

The details about the associated storage account.

SystemDataResponse

data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

TlsEndpointResponse

data class TlsEndpointResponse(val credentials: UsernamePasswordCredentialsResponse, val trustedCertificates: PemCertificateListResponse? = null, val tunnel: SecureIotDeviceRemoteTunnelResponse? = null, val type: String, val url: String, val validationOptions: TlsValidationOptionsResponse? = null)

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

TlsValidationOptionsResponse

data class TlsValidationOptionsResponse(val ignoreHostname: String? = null, val ignoreSignature: String? = null)

Options for controlling the validation of TLS endpoints.

TokenClaimResponse

data class TokenClaimResponse(val name: String, val value: String)

Properties for expected token claims.

UnsecuredEndpointResponse

data class UnsecuredEndpointResponse(val credentials: UsernamePasswordCredentialsResponse, val tunnel: SecureIotDeviceRemoteTunnelResponse? = null, val type: String, val url: String)

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

UserAssignedManagedIdentityResponse

data class UserAssignedManagedIdentityResponse(val clientId: String, val principalId: String)

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

UsernamePasswordCredentialsResponse

data class UsernamePasswordCredentialsResponse(val password: String, val type: String, val username: String)

Username and password credentials.

VideoAnalyzerIdentityResponse

data class VideoAnalyzerIdentityResponse(val type: String, val userAssignedIdentities: Map<String, UserAssignedManagedIdentityResponse>? = null)

The managed identity for the Video Analyzer resource.

VideoArchivalResponse

data class VideoArchivalResponse(val retentionPeriod: String? = null)

Video archival properties.

VideoContentUrlsResponse

data class VideoContentUrlsResponse(val archiveBaseUrl: String? = null, val downloadUrl: String? = null, val previewImageUrls: VideoPreviewImageUrlsResponse? = null, val rtspTunnelUrl: String? = null)

Set of URLs to the video content.

VideoCreationPropertiesResponse

data class VideoCreationPropertiesResponse(val description: String? = null, val retentionPeriod: String? = null, val segmentLength: String? = null, val title: String? = null)

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.

VideoEncoderH264Response

data class VideoEncoderH264Response(val bitrateKbps: String? = null, val frameRate: String? = null, val scale: VideoScaleResponse? = null, val type: String)

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

VideoFlagsResponse

data class VideoFlagsResponse(val canStream: Boolean, val hasData: Boolean, val isInUse: Boolean)

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

VideoMediaInfoResponse

data class VideoMediaInfoResponse(val segmentLength: String? = null)

Contains information about the video and audio content.

VideoPreviewImageUrlsResponse

data class VideoPreviewImageUrlsResponse(val large: String? = null, val medium: String? = null, val small: String? = null)

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.

VideoPublishingOptionsResponse

data class VideoPublishingOptionsResponse(val disableArchive: String? = null, val disableRtspPublishing: String? = null)

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

VideoScaleResponse

data class VideoScaleResponse(val height: String? = null, val mode: String? = null, val width: String? = null)

The video scaling information.

VideoSequenceAbsoluteTimeMarkersResponse

data class VideoSequenceAbsoluteTimeMarkersResponse(val ranges: String, val type: String)

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.

VideoSinkResponse

data class VideoSinkResponse(val inputs: List<NodeInputResponse>, val name: String, val type: String, val videoCreationProperties: VideoCreationPropertiesResponse? = null, val videoName: String, val videoPublishingOptions: VideoPublishingOptionsResponse? = null)

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'

VideoSourceResponse

data class VideoSourceResponse(val name: String, val timeSequences: VideoSequenceAbsoluteTimeMarkersResponse, val type: String, val videoName: String)

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